GitHub

Optional

API reference for Optional.

Attributes

AttributeTypeDescription
paramParam[X_co]
kindKind = field(init=False)

Functions

__init__

__init__(param) -> None
ParameterTypeDescription
paramParam[X_co]

parse

parse(args) -> Parsed[X_co | None]
ParameterTypeDescription
argsParsedArgs

Returns Parsed[X_co | None]

def parse(self, args: ParsedArgs) -> Parsed[X_co | None]:
    missing = (MissingOption, MissingArgument)
    return (
        self.param.parse(args)
        .map(lambda parsed: (parsed[0], cast("X_co | None", parsed[1])))
        .catch_if(
            lambda error: isinstance(error, missing),
            lambda _: succeed((args.arguments, None)),
        )
    )

map_singles

map_singles(f) -> Param[X_co | None]
ParameterTypeDescription
fCallable[[Single[Any]], Single[Any]]

Returns Param[X_co | None]

def map_singles(self, f: Callable[[Single[Any]], Single[Any]]) -> Param[X_co | None]:
    return Optional(self.param.map_singles(f))

singles

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

Returns list[Single[Any]]

def singles(self) -> list[Single[Any]]:
    return self.param.singles()

metadata

metadata() -> ParamMetadata

Returns ParamMetadata

def metadata(self) -> ParamMetadata:
    return replace(self.param.metadata(), is_optional=True)