COT.help
module¶
Provide ‘help’ keyword for COT CLI.
-
class
COTHelp
(UI)[source]¶ Bases:
COT.submodule.COTGenericSubmodule
Provide ‘help <subcommand>’ syntax.
Inherited attributes:
UI
Attributes:
subcommand
-
create_subparser
(parent, storage)[source]¶ Add subparser for the CLI of this submodule.
Parameters: - parent (object) – Subparser grouping object returned by
ArgumentParser.add_subparsers()
- storage (dict) – Dict of { ‘label’: subparser } to be updated with subparser(s) created, if any.
- parent (object) – Subparser grouping object returned by
-
subcommand
¶ CLI subcommand to give help for.
If
None
, then help will be displayed for the COT global parser.
-