GitHub

FlagDescriptor

API reference for FlagDescriptor.

Attributes

AttributeTypeDescription
namestr
aliasestuple[str, ...]
descriptionstr | None
typeFlagType
optional_valuebool = False
negationstr | Literal[False] | None = None
repeatablebool = False

Whether the flag can be given more than once, so completion keeps offering it after it is used.

Functions

__init__

__init__(name, aliases, description, type, optional_value=False, negation=None, repeatable=False) -> None
ParameterTypeDescription
namestr
aliasestuple[str, ...]
descriptionstr | None
typeFlagType
optional_valuebool = False
negationstr | Literal[False] | None = None
repeatablebool = False