GitHub

Transformed

API reference for Transformed.

A parse built from the inner param's parse and its alternatives'.

Attributes

AttributeTypeDescription
paramParam[X]
fCallable[[Parse[X], tuple[Callable[[], Parse[Any]], ...]], Parse[A_co]]
alternativestuple[Alternative, ...] = ()
kindKind = field(init=False)

Functions

__init__

__init__(param, f, alternatives=()) -> None
ParameterTypeDescription
paramParam[X]
fCallable[[Parse[X], tuple[Callable[[], Parse[Any]], ...]], Parse[A_co]]
alternativestuple[Alternative, ...] = ()

parse

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

Returns Parsed[A_co]

def parse(self, args: ParsedArgs) -> Parsed[A_co]:
    parsers = tuple(_lazy_parse(alternative) for alternative in self.alternatives)
    return self.f(self.param.parse, parsers)(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]:
    alternatives = tuple(_mapped_alternative(alt, f) for alt in self.alternatives)
    return Transformed(self.param.map_singles(f), self.f, alternatives)

singles

singles() -> list[Single[Any]]

Returns list[Single[Any]]

def singles(self) -> list[Single[Any]]:
    found = self.param.singles()
    for alternative in self.alternatives:
        found.extend(alternative().singles())
    return found

metadata

metadata() -> ParamMetadata

Returns ParamMetadata

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