twisted.python._shellcomp.ZshBuilder(object)
class documentationtwisted.python._shellcomp
View Source
(View In Hierarchy)
Known subclasses: twisted.python._shellcomp.ZshSubcommandBuilder
Constructs zsh code that will complete options for a given usage.Options instance, possibly including a list of subcommand names.
Completions for options to subcommands won't be generated because this
class will never be used if the user is completing options for a specific
subcommand. (See ZshSubcommandBuilder
below)
Instance Variable | options | The twisted.python.usage.Options
instance defined for this command. (type: twisted.python.usage.Options ) |
Instance Variable | cmdName | The name of the command we're generating completions for. (type: str ) |
Instance Variable | file | The file to write the completion function to. The
file must have bytes
I/O semantics. (type: file ) |
Method | __init__ | Undocumented |
Method | write | Generate the completion function and write it to the output file
@return: None |
twisted.python.usage.Options
instance defined for this command. (type: twisted.python.usage.Options
)
Generate the completion function and write it to the output file
Parameters | genSubs | Flag indicating whether or not completions for the list of subcommand
should be generated. Only has an effect if the subCommands
attribute has been defined on the twisted.python.usage.Options
instance. (type: bool ) |
Returns | None |