Module

autodoc.models.cli

CLI-specific metadata dataclasses for autodoc system.

Provides typed metadata for:

  • Commands (CLICommandMetadata)
  • Command groups (CLIGroupMetadata)
  • Options and arguments (CLIOptionMetadata)
View source
3 Classes

Classes

CLIOptionMetadata dataclass
Metadata for CLI option or argument.
0

Metadata for CLI option or argument.

Attributes

Name Type Description
name str

Parameter name
param_type Literal['option', 'argument']

Type of parameter ("option" or "argument")
type_name str

Type name (e.g., "STRING", "INT", "BOOL")
required bool

Whether parameter is required
default Any

Default value
multiple bool

Whether parameter accepts multiple values
is_flag bool

Whether option is a boolean flag
count bool

Whether option counts occurrences
opts tuple[str, ...]

Option flags (e.g., ("-v", "--verbose"))
envvar str | None

Environment variable name
help_text str

Help text description
CLICommandMetadata dataclass
Metadata specific to CLI commands.
0

Metadata specific to CLI commands.

Attributes

Name Type Description
callback str | None

Name of callback function
option_count int

Number of options
argument_count int

Number of arguments
is_group bool

Whether this is a command group
is_hidden bool

Whether command is hidden
CLIGroupMetadata dataclass
Metadata specific to CLI command groups.
0

Metadata specific to CLI command groups.

Attributes

Name Type Description
callback str | None

Name of callback function
command_count int

Number of subcommands