GitHub

Variadic

API reference for Variadic.

Attributes

AttributeTypeDescription
paramParam[X_co]
minint | None = None
maxint | None = None
kindKind = field(init=False)

Functions

__init__

__init__(param, min=None, max=None) -> None
ParameterTypeDescription
paramParam[X_co]
minint | None = None
maxint | None = None

parse

parse(args) -> Parsed[tuple[X_co, ...]]
ParameterTypeDescription
argsParsedArgs

Returns Parsed[tuple[X_co, ...]]

def parse(self, args: ParsedArgs) -> Parsed[tuple[X_co, ...]]:
    single = get_underlying_single_or_throw(self.param)
    if single.kind == ARGUMENT:
        return _parse_positional_variadic(self, single, args)
    return _parse_flag_variadic(self, single, args)

map_singles

map_singles(f) -> Param[tuple[X_co, ...]]
ParameterTypeDescription
fCallable[[Single[Any]], Single[Any]]

Returns Param[tuple[X_co, ...]]

def map_singles(self, f: Callable[[Single[Any]], Single[Any]]) -> Param[tuple[X_co, ...]]:
    return Variadic(self.param.map_singles(f), self.min, self.max)

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:
    inner = self.param.metadata()
    return replace(inner, is_variadic=True, variadic_min=self.min, variadic_max=self.max)