proj_flow.api.arg

The proj_flow.api.arg is used by various commands to declare CLI arguments.

class proj_flow.api.arg.ExclusiveArgumentGroup(opt: bool = False)

opt: bool = False

visit(parser: _ActionsContainer) → _ActionsContainer

class proj_flow.api.arg.Argument(help: str | Callable[[], str] = '', pos: bool = False, names: List[str] | Callable[[], List[str]] = <factory>, nargs: str | int | None | Callable[[], str | int | None] = None, opt: bool | None | Callable[[], bool | None] = None, meta: str | None | Callable[[], str | None] = None, action: str | argparse.Action | None | Callable[[], str | argparse.Action | None] = None, default: Any | None | Callable[[], Any | None] = None, choices: List[str] | None | Callable[[], List[str] | None] = None, completer: proj_flow.base.inspect.Function | None = None, group: proj_flow.api.arg.ExclusiveArgumentGroup | None = None)

help: str | Callable[[], str] = ''

pos: bool = False

names: List[str] | Callable[[], List[str]]

nargs: str | int | None | Callable[[], str | int | None] = None

opt: bool | None | Callable[[], bool | None] = None

meta: str | None | Callable[[], str | None] = None

action: str | Action | None | Callable[[], str | Action | None] = None

default: Any | None | Callable[[], Any | None] = None

choices: List[str] | None | Callable[[], List[str] | None] = None

completer: Function | None = None

group: ExclusiveArgumentGroup | None = None

visit(parser: _ActionsContainer, name: str)

class proj_flow.api.arg.FlagArgument(help: str = '', names: List[str] = [], group: ExclusiveArgumentGroup | None = None)

proj_flow.api.arg.command(*name: str)

proj_flow.api.arg.get_commands()