class ZshArgumentsGenerator: (source)
Constructor: ZshArgumentsGenerator(options, cmdName, file)
Generate a call to the zsh _arguments completion function based on data in a usage.Options instance
The first three instance variables are populated based on constructor arguments. The remaining non-constructor variables are populated by this class with data gathered from the Options instance passed in, and its base classes.
Method | __init__ |
Undocumented |
Method | add |
Add additional options to the optFlags and optParams lists. These will be defined by 'opt_foo' methods of the Options subclass |
Method | exclude |
Generate an "exclusion string" for the given option |
Method | get |
Return a zsh "action" string for the given argument |
Method | get |
Return the description to be used for this argument |
Method | get |
Return the short option letter or None |
Method | make |
No summary |
Method | verify |
Ensure that none of the option names given in the metadata are typoed |
Method | write |
Write the zsh completion code to the file given to __init__ |
Method | write |
Write out completion information for extra arguments appearing on the command-line. These are extra positional arguments not associated with a named option. That is, the stuff that gets passed to Options... |
Method | write |
Write the last bit of code that finishes the call to _arguments |
Method | write |
This is the start of the code that calls _arguments |
Method | write |
Write out the zsh code for the given argument. This is just part of the one big call to _arguments |
Method | write |
Write out zsh code for each option in this command |
Instance Variable | all |
Undocumented |
Instance Variable | cmd |
The name of the command we're generating completions for. |
Instance Variable | descriptions |
A dict mapping long option names to alternate descriptions. When this variable is defined, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables. |
Instance Variable | excludes |
Undocumented |
Instance Variable | extra |
Extra arguments are those arguments typically appearing at the end of the command-line, which are not associated with any particular named option. That is, the arguments that are given to the parseArgs() method of your usage... |
Instance Variable | file |
The file to write the completion function to. The file must have bytes I/O semantics. |
Instance Variable | flag |
Undocumented |
Instance Variable | multi |
An iterable containing those long option names which may appear on the command line more than once. By default, options will only be completed one time. |
Instance Variable | mutually |
A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together. |
Instance Variable | opt |
A dict mapping long option names to shell "actions". These actions define what may be completed as the argument to the given option, and should be given as instances of twisted.python.usage.Completer . |
Instance Variable | opt |
Undocumented |
Instance Variable | options |
The twisted.python.usage.Options instance to generate for |
Instance Variable | opt |
Undocumented |
Instance Variable | param |
Undocumented |
Add additional options to the optFlags and optParams lists. These will be defined by 'opt_foo' methods of the Options subclass
Returns | |
None |
Generate an "exclusion string" for the given option
Parameters | |
longname:str | The long option name (e.g. "verbose" instead of "v") |
build | May be True to indicate we're building an excludes string for the short option that corresponds to the given long opt. |
Returns | |
The generated str |
Ensure that none of the option names given in the metadata are typoed
Returns | |
None | |
Raises | |
ValueError | If unknown option names have been found. |
Write out completion information for extra arguments appearing on the command-line. These are extra positional arguments not associated with a named option. That is, the stuff that gets passed to Options.parseArgs().
Returns | |
None | |
Raises | |
ValueError | If Completer with repeat=True is found and is not the last item in the extraActions list. |
Write out the zsh code for the given argument. This is just part of the one big call to _arguments
Parameters | |
longname:str | The long option name (e.g. "verbose" instead of "v") |
Returns | |
None |
A dict mapping long option names to alternate descriptions. When this variable is defined, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables.
Extra arguments are those arguments typically appearing at the end of the command-line, which are not associated with any particular named option. That is, the arguments that are given to the parseArgs() method of your usage.Options subclass.
An iterable containing those long option names which may appear on the command line more than once. By default, options will only be completed one time.
A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together.
A dict mapping long option names to shell "actions". These actions define what may be completed as the argument to the given option, and should be given as instances of twisted.python.usage.Completer
.
Callables may instead be given for the values in this dict. The callable should accept no arguments, and return a Completer instance used as the action.