Cli¶

class glotaran.cli.main.Cli(*args, **kwargs)[source]¶

Bases: click.core.Group

Attributes Summary

`allow_extra_args`	the default for the `Context.allow_extra_args` flag.
`allow_interspersed_args`	the default for the `Context.allow_interspersed_args` flag.
`ignore_unknown_options`	the default for the `Context.ignore_unknown_options` flag.

Methods Summary

`add_command`	Registers another `Command` with this group.
`collect_usage_pieces`	Returns all the pieces that go into the usage line and returns it as a list of strings.
`command`	Behaves the same as click.Group.command() except capture a priority for listing command names in help.
`format_commands`	Extra format methods for multi methods that adds all the commands after the options.
`format_epilog`	Writes the epilog into the formatter if it exists.
`format_help`	Writes the help into the formatter if it exists.
`format_help_text`	Writes the help text to the formatter if it exists.
`format_options`	Writes all the options into the formatter if they exist.
`format_usage`	Writes the usage line into the formatter.
`get_command`	Given a context and a command name, this returns a `Command` object if it exists or returns None.
`get_help`	Formats the help into a string and returns it.
`get_help_option`	Returns the help option object.
`get_help_option_names`	Returns the names for the help option.
`get_params`
`get_short_help_str`	Gets short help for the command or makes it by shortening the long help string.
`get_usage`	Formats the usage line into a string and returns it.
`group`	A shortcut decorator for declaring and attaching a group to the group.
`invoke`	Given a context, this invokes the attached callback (if it exists) in the right way.
`list_commands`	Returns a list of subcommand names in the order they should appear.
`list_commands_for_help`	reorder the list of commands when listing the help
`main`	This is the way to invoke a script with all the bells and whistles as a command line application.
`make_context`	This function when given an info name and arguments will kick off the parsing and create a new `Context`.
`make_parser`	Creates the underlying option parser for this command.
`parse_args`	Given a context and a list of arguments this creates the parser and parses the arguments, then modifies the context as necessary.
`resolve_command`
`resultcallback`	Adds a result callback to the chain command.

Methods Documentation

add_command(cmd, name=None)¶: Registers another Command with this group. If the name is not provided, the name of the command is used.

allow_extra_args = True¶: the default for the Context.allow_extra_args flag.

allow_interspersed_args = False¶: the default for the Context.allow_interspersed_args flag.

callback¶: the callback to execute when the command fires. This might be None in which case nothing happens.

collect_usage_pieces(ctx)¶: Returns all the pieces that go into the usage line and returns it as a list of strings.

command(*args, **kwargs)[source]¶: Behaves the same as click.Group.command() except capture a priority for listing command names in help.

commands¶: the registered subcommands by their exported names.

context_settings¶: an optional dictionary with defaults passed to the context.

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.

This is a low-level method called by get_help().

This calls the following methods:

format_usage()
format_help_text()
format_options()
format_epilog()

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.

This is a low-level method called by get_usage().

get_command(ctx, cmd_name)¶: Given a context and a command name, this returns a Command object if it exists or returns None.

get_help(ctx)[source]¶

Formats the help into a string and returns it.

Calls format_help() internally.

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=45)¶: 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.

Calls format_usage() internally.

group(*args, **kwargs)¶: A shortcut decorator for declaring and attaching a group to the group. This takes the same arguments as group() but immediately registers the created command with this instance by calling into add_command().

ignore_unknown_options = False¶: the default for the Context.ignore_unknown_options flag.

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.

list_commands_for_help(ctx)[source]¶: reorder the list of commands when listing the help

main(args=None, prog_name=None, complete_var=None, standalone_mode=True, **extra)¶

This is the way to invoke a script with all the bells and whistles as a command line application. This will always terminate the application after a call. If this is not wanted, SystemExit needs to be caught.

This method is also available by directly calling the instance of a Command.

New in version 3.0: Added the standalone_mode flag to control the standalone mode.

Parameters

args – the arguments that should be used for parsing. If not provided, sys.argv[1:] is used.
prog_name – the program name that should be used. By default the program name is constructed by taking the file name from sys.argv[0].
complete_var – the environment variable that controls the bash completion support. The default is "_<prog_name>_COMPLETE" with prog_name in uppercase.
standalone_mode – the default behavior is to invoke the script in standalone mode. Click will then handle exceptions and convert them into error messages and the function will never return but shut down the interpreter. If this is set to False they will be propagated to the caller and the return value of this function is the return value of invoke().
extra – extra keyword arguments are forwarded to the context constructor. See Context for more information.

make_context(info_name, args, parent=None, **extra)¶

This function when given an info name and arguments will kick off the parsing and create a new Context. It does not invoke the actual command callback though.

Parameters

info_name – the info name for this invokation. Generally this is the most descriptive name for the script or command. For the toplevel script it’s usually the name of the script, for commands below it it’s the name of the script.
args – the arguments to parse as list of strings.
parent – the parent context if available.
extra – extra keyword arguments forwarded to the context constructor.

make_parser(ctx)¶: Creates the underlying option parser for this command.

name¶: the name the command thinks it has. Upon registering a command on a Group the group will default the command name with this information. You should instead use the Context's info_name attribute.

params¶: the list of parameters for this command in the order they should show up in the help page and execute. Eager parameters will automatically be handled before non eager ones.

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. This is automatically invoked by make_context().

resolve_command(ctx, args)¶

result_callback¶: The result callback that is stored. This can be set or overridden with the resultcallback() decorator.

resultcallback(replace=False)¶

Adds a result callback to the chain command. By default if a result callback is already registered this will chain them but this can be disabled with the replace parameter. The result callback is invoked with the return value of the subcommand (or the list of return values from all subcommands if chaining is enabled) as well as the parameters as they would be passed to the main callback.

Example:

@click.group()
@click.option('-i', '--input', default=23)
def cli(input):
    return 42

@cli.resultcallback()
def process_result(result, input):
    return result + input

New in version 3.0.

Parameters: replace – if set to True an already existing result callback will be removed.