GitHub

API reference for HelpDoc.

Attributes

AttributeTypeDescription
descriptionstr
usagestr
flagstuple[FlagDoc, ...]
annotationsContext[Any] = field(default_factory=(Context[Any]))
global_flagstuple[FlagDoc, ...] = ()

Global flags active at this command, built-ins (--help) included.

argstuple[ArgDoc, ...] = ()
subcommandstuple[SubcommandGroupDoc, ...] = ()
examplestuple[ExampleDoc, ...] = ()
inherited_flagstuple[FlagDoc, ...] = ()

Shared flags inherited from ancestor commands.

global_flags_scopetuple[str, ...] | None = None

Root-to-command path of the nearest command (this one or an ancestor) declaring global flags; the root when only built-ins are active.

command_pathtuple[str, ...] | None = None

Command names from the root to this command: ("myapp", "deploy").

Functions

__init__

__init__(description, usage, flags, annotations=Context[Any](), global_flags=(), args=(), subcommands=(), examples=(), inherited_flags=(), global_flags_scope=None, command_path=None) -> None
ParameterTypeDescription
descriptionstr
usagestr
flagstuple[FlagDoc, ...]
annotationsContext[Any] = Context[Any]()
global_flagstuple[FlagDoc, ...] = ()
argstuple[ArgDoc, ...] = ()
subcommandstuple[SubcommandGroupDoc, ...] = ()
examplestuple[ExampleDoc, ...] = ()
inherited_flagstuple[FlagDoc, ...] = ()
global_flags_scopetuple[str, ...] | None = None
command_pathtuple[str, ...] | None = None