click.shell_completion.FishComplete

class documentation

class FishComplete(ShellComplete):

Shell completion for Fish.

Method	`format_completion`	Format a completion item into the form recognized by the shell script. This must be implemented by subclasses.
Method	`get_completion_args`	Use the env vars defined by the shell script to return a tuple of `args, incomplete`. This must be implemented by subclasses.
Class Variable	`name`	Name to register the shell as with `add_completion_class`. This is used in completion instructions (`{name}_source` and `{name}_complete`).

Inherited from ShellComplete:

Method	`complete`	Produce the completion data to send back to the shell.
Method	`get_completions`	Determine the context and last complete command or parameter from the complete args. Call that object's `shell_complete` method to get the completions for the incomplete value.
Method	`source`	No summary
Method	`source_vars`	Vars for formatting `source_template`.
Class Variable	`source_template`	Completion script template formatted by `source`. This must be provided by subclasses.
Property	`func_name`	The name of the shell function defined by the completion script.
Method	`__init__`	Undocumented
Instance Variable	`cli`	Undocumented
Instance Variable	`complete_var`	Undocumented
Instance Variable	`ctx_args`	Undocumented
Instance Variable	`prog_name`	Undocumented

def format_completion(self, item):

overrides click.shell_completion.ShellComplete.format_completion

Format a completion item into the form recognized by the shell script. This must be implemented by subclasses.

def get_completion_args(self):

overrides click.shell_completion.ShellComplete.get_completion_args

Use the env vars defined by the shell script to return a tuple of args, incomplete. This must be implemented by subclasses.

Returns
`t.Tuple[t.List[str], str]`	Undocumented

name: str =

overrides click.shell_completion.ShellComplete.name

Name to register the shell as with add_completion_class. This is used in completion instructions ({name}_source and {name}_complete).