argclz.core.pos_argument#

argclz.core.pos_argument(option: str, validator: Callable[[T], bool] = None, *, nargs: Literal['*', '+', '?', '...'] | None = None, action: Literal['store', 'store_const', 'store_true', 'store_false', 'append', 'append_const', 'extend', 'count', 'help', 'version', 'boolean'] = ..., const: T = ..., default: T = ..., type: Type | Callable[[str], T] = ..., choices: Sequence[str] = ..., required: bool = False, help: str = ...) → T[source]#

create a positional (non-flag) command-line argument attribute.

Usage

>>> class Example:
...     a: str = pos_argument('A')

shorten for argument(metavar=option, nargs=nargs, validator=validator, **kwargs)

Parameters:

  • option – The name for the positional argument shown in usage messages

  • validator – value validator with signature (T) -> bool.

  • nargs – number of following values. Please see argparse.ArgumentParser.add_argument(nargs) for detailed.

  • action – argument action. Please see argparse.ArgumentParser.add_argument(action) for detailed.

  • const – Please see argparse.ArgumentParser.add_argument(const) for detailed.

  • default – default value of argument. Please see argparse.ArgumentParser.add_argument(default) for detailed.

  • type – type caster with signature (str) -> T. Please see argparse.ArgumentParser.add_argument(type) for detailed.

  • choices – Please see argparse.ArgumentParser.add_argument(choices) for detailed.

  • required – Please see argparse.ArgumentParser.add_argument(required) for detailed.

  • help – help document for this argument.