1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
#!/usr/bin/env python3
#
# Copyright 2015-2022 Joe Block <jpb@unixorn.net>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from shutil import which
import os
import subprocess
import sys
from importlib import metadata
__version__ = metadata.version(__package__)
def is_program(name):
"""
Search for a given program in $PATH, and return True if it exists and
is executable.
:param str name: Name of program to search for
:returns: whether or not the program can be found in $PATH
:rtype: bool
"""
return which(name) is not None
def find_subcommand(args):
"""
Given a list ['foo','bar', 'baz'], attempts to create a command name
in the format 'foo-bar-baz'. If that command exists, we run it. If it
doesn't, we check to see if foo-bar exists, in which case we run
`foo-bar baz`.
We keep peeling chunks off the end of the command name and adding them
to the argument list until we find a valid command name we can run.
This allows us to easily make git-style command drivers where, for
example we have a driver script, foo, and subcommand scripts foo-bar
and foo-baz, and when the user types `foo bar foobar` we find the foo-bar
script and run it as
`foo-bar foobar`
:param list|tuple args: list to try and convert to a command args pair
:returns: command and arguments list
:rtype: tuple
:raises StandardError: if the args can't be matched to an executable subcommand
"""
command = None
# If the only command we find is the first element of args, we've found
# the driver script itself and re-executing it will cause an infinite
# loop, so don't bother examining the first element on its own.
for i in range(len(args) - 1):
command = "-".join(args[: (len(args) - i)])
command_arguments = args[len(args) - i :]
if is_program(os.path.basename(command)):
return (command, command_arguments)
raise RuntimeError("Could not find a executable subcommand for %s" % " ".join(args))
def subcommand_driver():
"""
Process the command line arguments and run the appropriate subcommand.
We want to be able to do git-style handoffs to subcommands where if we
do `foo blah foo bar` and the executable foo-blah-foo exists, we'll call
it with the argument bar.
We deliberately don't do anything with the arguments other than hand
them off to the foo subcommand. Subcommands are responsible for their
own argument parsing.
"""
try:
(command, args) = find_subcommand(sys.argv)
# If we can't construct a subcommand from sys.argv, it'll still be able
# to find this driver script, and re-running ourself isn't useful.
if os.path.basename(command) == sys.argv[0]:
print("Could not find a subcommand for %s" % " ".join(sys.argv))
sys.exit(1)
except Exception as e:
print(str(e))
sys.exit(1)
subprocess.check_call([command] + args)
|
