mopidy.commands
--- Commands API¶
-
class
mopidy.commands.
Command
[source]¶ Command parser and runner for building trees of commands.
This class provides a wraper around
argparse.ArgumentParser
for handling this type of command line application in a better way than argprases own sub-parser handling.-
add_argument
(*args, **kwargs)[source]¶ Add an argument to the parser.
This method takes all the same arguments as the
argparse.ArgumentParser
version of this method.
-
add_child
(name, command)[source]¶ Add a child parser to consider using.
Parameters: name (string) -- name to use for the sub-command that is being added.
-
parse
(args, prog=None)[source]¶ Parse command line arguments.
Will recursively parse commands until a final parser is found or an error occurs. In the case of errors we will print a message and exit. Otherwise, any overrides are applied and the current parser stored in the command attribute of the return value.
Parameters: - args (list of strings) -- list of arguments to parse
- prog (string) -- name to use for program
Return type:
-