click.shell_completion

module documentation

Undocumented

Class	`CompletionItem`	No summary
Class	`ShellComplete`	Base class for providing shell completion support. A subclass for a given shell will override attributes and methods to implement the completion instructions (`source` and `complete`).
Function	`add_completion_class`	Register a `ShellComplete` subclass under the given name. The name will be provided by the completion instruction environment variable during completion.
Class	`BashComplete`	Shell completion for Bash.
Class	`FishComplete`	Shell completion for Fish.
Class	`ZshComplete`	Shell completion for Zsh.
Function	`_is_incomplete_argument`	Determine if the given parameter is an argument that can still accept values.
Function	`_is_incomplete_option`	Determine if the given parameter is an option that needs a value.
Function	`_resolve_context`	Produce the context hierarchy starting with the command and traversing the complete arguments. This only follows the commands, it doesn't trigger input prompts or callbacks.
Function	`_resolve_incomplete`	Find the Click object that will handle the completion of the incomplete value. Return the object and the incomplete value.
Function	`_start_of_option`	Check if the value looks like the start of an option.
Function	`get_completion_class`	Look up a registered `ShellComplete` subclass by the name provided by the completion instruction environment variable. If the name isn't registered, returns `None`.
Function	`shell_complete`	Perform shell completion for the given CLI program.
Constant	`_SOURCE_BASH`	Undocumented
Constant	`_SOURCE_FISH`	Undocumented
Constant	`_SOURCE_ZSH`	Undocumented
Variable	`_available_shells`	Undocumented

def add_completion_class(cls, name=None):

Register a ShellComplete subclass under the given name. The name will be provided by the completion instruction environment variable during completion.

Parameters
cls:`t.Type[ShellComplete]`	The completion class that will handle completion for the shell.
name:`t.Optional[str]`	Name to register the class under. Defaults to the class's `name` attribute.

def _is_incomplete_argument(ctx, param):

Determine if the given parameter is an argument that can still accept values.

Parameters
ctx:`Context`	Invocation context for the command represented by the parsed complete args.
param:`Parameter`	Argument object being checked.
Returns
`bool`	Undocumented

def _is_incomplete_option(args, param):

Determine if the given parameter is an option that needs a value.

Parameters
args:`t.List[str]`	List of complete args before the incomplete value.
param:`Parameter`	Option object being checked.
Returns
`bool`	Undocumented

def _resolve_context(cli, ctx_args, prog_name, args):

Produce the context hierarchy starting with the command and traversing the complete arguments. This only follows the commands, it doesn't trigger input prompts or callbacks.

Parameters
cli:`BaseCommand`	Command being called.
ctx_args:`t.Dict[str, t.Any]`	Undocumented
prog_name:`str`	Name of the executable in the shell.
args:`t.List[str]`	List of complete args before the incomplete value.
Returns
`Context`	Undocumented

def _resolve_incomplete(ctx, args, incomplete):

Find the Click object that will handle the completion of the incomplete value. Return the object and the incomplete value.

Parameters
ctx:`Context`	Invocation context for the command represented by the parsed complete args.
args:`t.List[str]`	List of complete args before the incomplete value.
incomplete:`str`	Value being completed. May be empty.
Returns
`t.Tuple[t.Union[BaseCommand, Parameter], str]`	Undocumented

def _start_of_option(value):

Check if the value looks like the start of an option.

Parameters
value:`str`	Undocumented
Returns
`bool`	Undocumented

def get_completion_class(shell):

Look up a registered ShellComplete subclass by the name provided by the completion instruction environment variable. If the name isn't registered, returns None.

Parameters
shell:`str`	Name the class is registered under.
Returns
`t.Optional[t.Type[ShellComplete]]`	Undocumented

def shell_complete(cli, ctx_args, prog_name, complete_var, instruction):

Perform shell completion for the given CLI program.

Parameters
cli:`BaseCommand`	Command being called.
ctx_args:`t.Dict[str, t.Any]`	Extra arguments to pass to `cli.make_context`.
prog_name:`str`	Name of the executable in the shell.
complete_var:`str`	Name of the environment variable that holds the completion instruction.
instruction:`str`	Value of `complete_var` with the completion instruction and shell, in the form `instruction_shell`.
Returns
`int`	Status code to exit with.

_SOURCE_BASH: str =

Undocumented

Value

'''%(complete_func)s() {
    local IFS=$\'\\n\'
    local response

    response=$(env COMP_WORDS="${COMP_WORDS[*]}" COMP_CWORD=$COMP_CWORD %(comple↵
te_var)s=bash_complete $1)

...

_SOURCE_FISH: str =

Undocumented

Value

'''function %(complete_func)s;
    set -l response;

    for value in (env %(complete_var)s=fish_complete COMP_WORDS=(commandline -cp↵
) COMP_CWORD=(commandline -t) %(prog_name)s);
        set response $response $value;
    end;
...

_SOURCE_ZSH: str =

Undocumented

Value

'''#compdef %(prog_name)s

%(complete_func)s() {
    local -a completions
    local -a completions_with_descriptions
    local -a response
    (( ! $+commands[%(prog_name)s] )) && return 1
...

_available_shells: t.Dict[str, t.Type[ShellComplete]] =

Undocumented