rs_rich.ext.cli_doc

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rs_rich.ext.cli_doc: command help, errors, completions, docs and config from one description (rich_ext::cli_doc).

No Rich counterpart: this is the port's own rs-rich-ext crate.

HELP_STYLES module-attribute

HELP_STYLES: List[Any]

HELP_STACK_BELOW module-attribute

HELP_STACK_BELOW: int

COMPLETION_SHELLS module-attribute

COMPLETION_SHELLS: List[Any]

Layer module-attribute

Layer = ConfigLayer

STYLES module-attribute

STYLES = HELP_STYLES

STACK_BELOW module-attribute

STACK_BELOW = HELP_STACK_BELOW

SHELLS module-attribute

SHELLS = COMPLETION_SHELLS

ArgSpec

choices property

choices: Any

group property

group: Any

help property

help: Any

id property

id: Any

long property

long: Any

metavar property

metavar: Any

names property

names: Any

primary property

primary: Any

short property

short: Any

switches property

switches: Any

takes_value property

takes_value: Any

flag staticmethod

flag(long: Any, **kwargs: Any) -> Any

option staticmethod

option(long: Any, **kwargs: Any) -> Any

positional staticmethod

positional(name: Any, **kwargs: Any) -> Any

CommandSpec

about property

about: Any

args property

args: Any

display_name property

display_name: Any

name property

name: Any

subcommands property

subcommands: Any

version property

version: Any

completion

completion(shell: Any) -> Any

completion_catalog

completion_catalog() -> Any

config_reference

config_reference() -> Any

find_subcommand

find_subcommand(name: Any) -> Any

help

help(*, long: Any = ..., path: Any = ...) -> Any

markdown

markdown() -> Any

subcommand_names

subcommand_names() -> Any

switch_names

switch_names() -> Any

to_man

to_man(section: Any = ..., date: Any = ...) -> Any

to_man_pages

to_man_pages(section: Any = ..., date: Any = ...) -> Any

to_markdown

to_markdown() -> Any

unknown

unknown(argument: Any) -> Any

usage_lines

usage_lines() -> Any

HelpView

MarkdownReference

CompletionCatalog

items

items() -> Any

CliError

argument property

argument: Any

exit_code property

exit_code: Any

headline property

headline: Any

kind property

kind: Any

suggestions property

suggestions: Any

invalid_value classmethod

invalid_value(argument: Any, value: Any, possible: Any) -> Any

missing_required classmethod

missing_required(arguments: Any) -> Any

missing_value classmethod

missing_value(argument: Any) -> Any

to_diagnostic

to_diagnostic() -> Any

unknown_argument classmethod

unknown_argument(argument: Any, candidates: Any) -> Any

unknown_subcommand classmethod

unknown_subcommand(name: Any, candidates: Any) -> Any

ConfigEntry

ConfigReference

from_spec classmethod

from_spec(spec: Any, *, description: Any = ..., sources: Any = ..., entries: Any = ...) -> Any

to_markdown

to_markdown() -> Any

ConfigLayer

Precedence

explain

explain(key: Any) -> Any

resolve

resolve() -> Any

PrecedenceExplanation

key property

key: Any

shadowed property

shadowed: Any

value property

value: Any

winner property

winner: Any

suggest

suggest(input: Any, candidates: Any) -> Any