One named flag or positional argument.
Attributes#
| Attribute | Type | Description |
|---|---|---|
kind | Kind | |
name | str | |
primitive | Primitive[A_co] | |
description | str | None = None | |
aliases | tuple[str, ...] = () | |
type_name | str | None = None | |
hidden | bool = False | |
optional_value | str | None = None | The value a flag takes when given without one ( |
negation | str | Literal[False] | None = None | A boolean flag's negated name; |
Functions#
__init__#
__init__(kind, name, primitive, description=None, aliases=(), type_name=None, hidden=False, optional_value=None, negation=None) -> None| Parameter | Type | Description |
|---|---|---|
kind | Kind | |
name | str | |
primitive | Primitive[A_co] | |
description | str | None = None | |
aliases | tuple[str, ...] = () | |
type_name | str | None = None | |
hidden | bool = False | |
optional_value | str | None = None | |
negation | str | Literal[False] | None = None |
parse#
parse(args) -> Parsed[A_co]| Parameter | Type | Description |
|---|---|---|
args | ParsedArgs |
Returns Parsed[A_co]
def parse(self, args: ParsedArgs) -> Parsed[A_co]:
if self.kind == ARGUMENT:
return _parse_positional(self.name, self.primitive, args)
return _parse_flag(self.name, self.primitive, args)map_singles#
map_singles(f) -> Param[A_co]| Parameter | Type | Description |
|---|---|---|
f | Callable[[Single[Any]], Single[Any]] |
Returns Param[A_co]
def map_singles(self, f: Callable[[Single[Any]], Single[Any]]) -> Param[A_co]:
return f(self)singles#
singles() -> list[Single[Any]]Returns list[Single[Any]]
def singles(self) -> list[Single[Any]]:
return [self]metadata#
metadata() -> ParamMetadataReturns ParamMetadata
def metadata(self) -> ParamMetadata:
return ParamMetadata()