Option_Strings Module

Containers for option strings

author:

Doug Skrypa

class cli_command_parser.parameters.option_strings.OptionStrings(option_strs: ~typing.Collection[str], name_mode: ~cli_command_parser.config.OptionNameMode | str | None = <object object>)

Bases: object

Container for the option strings registered for a given BaseOption (or subclass thereof).

name_mode: OptionNameMode | None

combinable: set[str]

has_long() → Bool

Whether any (primary / non-alternate, for TriFlag) long option strings were defined

has_min_opts() → Bool

Returns a truthy value if the minimum required number of option strings have been registered

update(name: str)

Called by BaseOption.__set_name__() to add the assigned name to the long option strings for this param.

get_sets() → tuple[set[str], set[str]]

property long: list[str]

property short: list[str]

property display_long: list[str]

get_usage_opt() → str

option_strs() → Iterator[str]

all_option_strs() → Iterator[str]

class cli_command_parser.parameters.option_strings.TriFlagOptionStrings(option_strs: ~typing.Collection[str], name_mode: ~cli_command_parser.config.OptionNameMode | str | None = <object object>)

Bases: OptionStrings

Container for the option strings registered for a given TriFlag.

has_long() → Bool

Whether any primary / non-alternate long option strings were defined

has_min_opts() → Bool

add_alts(prefix: str | None, long: str | None, short: str | None)

update_alts(name: str)

Called by TriFlag.__set_name__() to add the assigned name to the alt long option strings for this param.

property alt_allowed: set[str]

property display_long_primary: list[str]

property short_primary: list[str]

property display_long_alt: list[str]

property short_alt: list[str]

primary_option_strs() → Iterator[str]

alt_option_strs() → Iterator[str]

get_usage_opt(alt: bool = False) → str

option_strs(alt: bool = False) → Iterator[str]

all_option_strs() → Iterator[str]