Attributes#
| Attribute | Type | Description |
|---|---|---|
description | str | |
usage | str | |
flags | tuple[FlagDoc, ...] | |
annotations | Context[Any] = field(default_factory=(Context[Any])) | |
global_flags | tuple[FlagDoc, ...] = () | Global flags active at this command, built-ins ( |
args | tuple[ArgDoc, ...] = () | |
subcommands | tuple[SubcommandGroupDoc, ...] = () | |
examples | tuple[ExampleDoc, ...] = () | |
inherited_flags | tuple[FlagDoc, ...] = () | Shared flags inherited from ancestor commands. |
global_flags_scope | tuple[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_path | tuple[str, ...] | None = None | Command names from the root to this command: |
Functions#
__init__#
__init__(description, usage, flags, annotations=Context[Any](), global_flags=(), args=(), subcommands=(), examples=(), inherited_flags=(), global_flags_scope=None, command_path=None) -> None| Parameter | Type | Description |
|---|---|---|
description | str | |
usage | str | |
flags | tuple[FlagDoc, ...] | |
annotations | Context[Any] = Context[Any]() | |
global_flags | tuple[FlagDoc, ...] = () | |
args | tuple[ArgDoc, ...] = () | |
subcommands | tuple[SubcommandGroupDoc, ...] = () | |
examples | tuple[ExampleDoc, ...] = () | |
inherited_flags | tuple[FlagDoc, ...] = () | |
global_flags_scope | tuple[str, ...] | None = None | |
command_path | tuple[str, ...] | None = None |