class documentation

class ZshComplete(ShellComplete):

View In Hierarchy

Shell completion for Zsh.
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):
Format a completion item into the form recognized by the shell script. This must be implemented by subclasses.
Parameters
item:CompletionItemCompletion item to format.
Returns
strUndocumented
def get_completion_args(self):
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 =
Name to register the shell as with add_completion_class. This is used in completion instructions ({name}_source and {name}_complete).