GitHub

API reference for Single.

One named flag or positional argument.

Attributes

AttributeTypeDescription
kindKind
namestr
primitivePrimitive[A_co]
descriptionstr | None = None
aliasestuple[str, ...] = ()
type_namestr | None = None
hiddenbool = False
optional_valuestr | None = None

The value a flag takes when given without one (--flag).

negationstr | Literal[False] | None = None

A boolean flag's negated name; None is no-<name>, False none.

Functions

__init__

__init__(kind, name, primitive, description=None, aliases=(), type_name=None, hidden=False, optional_value=None, negation=None) -> None
ParameterTypeDescription
kindKind
namestr
primitivePrimitive[A_co]
descriptionstr | None = None
aliasestuple[str, ...] = ()
type_namestr | None = None
hiddenbool = False
optional_valuestr | None = None
negationstr | Literal[False] | None = None

parse

parse(args) -> Parsed[A_co]
ParameterTypeDescription
argsParsedArgs

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]
ParameterTypeDescription
fCallable[[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() -> ParamMetadata

Returns ParamMetadata

def metadata(self) -> ParamMetadata:
    return ParamMetadata()