class documentation
class FishComplete(ShellComplete): (source)
Shell completion for Fish.
Method | format |
Format a completion item into the form recognized by the shell script. This must be implemented by subclasses. |
Method | get |
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 :func:`add_completion_class`. This is used in completion instructions (``{name}_source`` and ``{name}_complete``). |
Inherited from ShellComplete
:
Method | __init__ |
Undocumented |
Method | complete |
Produce the completion data to send back to the shell. |
Method | get |
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 |
Produce the shell script that defines the completion function. By default this ``%``-style formats :attr:`source_template` with the dict returned by :meth:`source_vars`. |
Method | source |
Vars for formatting :attr:`source_template`. |
Class Variable | source |
Completion script template formatted by :meth:`source`. This must be provided by subclasses. |
Instance Variable | cli |
Undocumented |
Instance Variable | complete |
Undocumented |
Instance Variable | ctx |
Undocumented |
Instance Variable | prog |
Undocumented |
Property | func |
The name of the shell function defined by the completion script. |
Format a completion item into the form recognized by the shell script. This must be implemented by subclasses. :param item: Completion item to format.
Parameters | |
item:CompletionItem | Undocumented |
Returns | |
str | Undocumented |