class documentation

class HelpCommand(Command): (source)

View In Hierarchy

Class implementing the --help command
Method run Run the command @raises UsageError: when arguments are not correct @implementation: must be implemented by subclasses
Class Variable optionhelp Undocumented
Class Variable usagehelp Undocumented

Inherited from Command:

Method __init__ Constructor @param command: the command switch (first commandline argument) @param pwd: optional working directory path
Method get_arguments Get the arguments, to be used by the implementation of run() @raises UsageError: when arguments are not correct @returns: tuple of arguments, padded with None to correct length
Method get_options Retrieve a dict with a sub-set of the command options @param names: that options in the subset
Method ignore_options Undocumented
Method parse_options No summary
Class Variable arguments Undocumented
Class Variable default_options Undocumented
Class Variable options Undocumented
Instance Variable args Undocumented
Instance Variable command Undocumented
Instance Variable opts Undocumented
Instance Variable pwd Undocumented
def run(self): (source)
Run the command
Raises
UsageErrorwhen arguments are not correct
Unknown Field: implementation
must be implemented by subclasses
optionhelp: str = (source)

Undocumented

usagehelp: str = (source)

Undocumented