paths_cli.OpenPathSamplingCLI¶
-
class
paths_cli.
OpenPathSamplingCLI
(*args, **kwargs)¶ Main class for the command line interface
Most of the logic here is about handling the plugin infrastructure.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(*args, **kwargs)Initialize self.
collect_usage_pieces
(ctx)Returns all the pieces that go into the usage line and returns it as a list of strings.
format_commands
(ctx, formatter)Extra format methods for multi methods that adds all the commands after the options.
format_epilog
(ctx, formatter)Writes the epilog into the formatter if it exists.
format_help
(ctx, formatter)Writes the help into the formatter if it exists.
format_help_text
(ctx, formatter)Writes the help text to the formatter if it exists.
format_options
(ctx, formatter)Writes all the options into the formatter if they exist.
format_usage
(ctx, formatter)Writes the usage line into the formatter.
get_command
(ctx, name)Given a context and a command name, this returns a
Command
object if it exists or returns None.get_help
(ctx)Formats the help into a string and returns it.
get_help_option
(ctx)Returns the help option object.
get_help_option_names
(ctx)Returns the names for the help option.
get_params
(ctx)get_short_help_str
([limit])Gets short help for the command or makes it by shortening the long help string.
get_usage
(ctx)Formats the usage line into a string and returns it.
invoke
(ctx)Given a context, this invokes the attached callback (if it exists) in the right way.
list_commands
(ctx)Returns a list of subcommand names in the order they should appear.
main
([args, prog_name, complete_var, …])This is the way to invoke a script with all the bells and whistles as a command line application.
make_context
(info_name, args[, parent])This function when given an info name and arguments will kick off the parsing and create a new
Context
.make_parser
(ctx)Creates the underlying option parser for this command.
parse_args
(ctx, args)Given a context and a list of arguments this creates the parser and parses the arguments, then modifies the context as necessary.
plugin_for_command
(command_name)resolve_command
(ctx, args)resultcallback
([replace])Adds a result callback to the chain command.
Attributes
allow_extra_args
allow_interspersed_args
ignore_unknown_options
-