twisted.python.usage.Completer(object) class documentationtwisted.python.usage
(View In Hierarchy)
Known subclasses: twisted.python._shellcomp.SubcommandAction, twisted.python.usage.CompleteDirs, twisted.python.usage.CompleteFiles, twisted.python.usage.CompleteGroups, twisted.python.usage.CompleteHostnames, twisted.python.usage.CompleteList, twisted.python.usage.CompleteMultiList, twisted.python.usage.CompleteNetInterfaces, twisted.python.usage.CompleteUserAtHost, twisted.python.usage.CompleteUsernames
A completion "action" - provides completion possibilities for a particular command-line option. For example we might provide the user a fixed list of choices, or files/dirs according to a glob.
This class produces no completion matches itself - see the various subclasses for specific completion functionality.
| Method | __init__ | |
| Method | _getRepeatFlag | Undocumented |
| Method | _description | Undocumented |
| Method | _shellCode | Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py |
| Parameters | descr | An optional descriptive string displayed above matches. (type: str) |
| repeat | A flag, defaulting to False, indicating whether this Completer
should repeat - that is, be used to complete more than one command-line
word. This may ONLY be set to True for actions in the
extraActions keyword argument to Completions. And
ONLY if it is the LAST (or only) action in the extraActions
list. (type: bool) |
Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
| Parameters | optName | The long name of the option this action is being used for. (type: str) |
| shellType | One of the supported shell constants e.g.
twisted.python.usage._ZSH (type: str) |