Args - Aspect Build

type Args function string_list

def string_list(
*,
required: bool = False,
default: None | list[str] = None,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines a string list flag that can be specified multiple times. Use long = "override-name" to override the default kebab-case derivation. function uint_list

def uint_list(
*,
required: bool = False,
default: None | list[int] = None,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines an unsigned integer list flag that can be specified multiple times. Use long = "override-name" to override the default kebab-case derivation. function trailing_var_args

def trailing_var_args(
*,
description: None | str = None
) -> args.Arg

Defines a trailing variable argument that captures the remaining arguments without further parsing. Only one such argument is permitted, and it must be the last in the sequence. function boolean

def boolean(
*,
required: bool = False,
default: bool = …,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines a boolean flag. Use --flag_name (true) or --flag_name=false. Use long = "override-name" to override the default kebab-case derivation. function int

def int(
*,
required: bool = False,
default: int = …,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines an integer flag. Use long = "override-name" to override the default kebab-case derivation. function uint

def uint(
*,
required: bool = False,
default: int = …,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines an unsigned integer flag. Use long = "override-name" to override the default kebab-case derivation. function int_list

def int_list(
*,
required: bool = False,
default: None | list[int] = None,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines an integer list flag that can be specified multiple times. Use long = "override-name" to override the default kebab-case derivation. function custom

def custom(
typ: typing.Any,
/,
*,
default: typing.Any = …,
description: None | str = None
) -> args.Arg

Defines a config-only arg — not exposed on the CLI. Set via config.axl only. The type argument must be a built-in or otherwise frozen type (e.g. str, int, bool, list[str]). If provided, default must match the declared type. Example:

my_task = task(
    implementation = _impl,
    args = {
        "mode": args.string(default = "auto"),
        "bucket": args.custom(str | None, default = None),  # config.axl only
    },
)

function string

def string(
*,
required: bool = False,
default: str = …,
short: None | str = None,
long: None | str = None,
values: None | list[str] = None,
description: None | str = None
) -> args.Arg

Defines a string flag that can be specified as --flag_name=flag_value. Use long = "override-name" to override the default kebab-case derivation. function boolean_list

def boolean_list(
*,
required: bool = False,
default: None | list[bool] = None,
short: None | str = None,
long: None | str = None,
description: None | str = None
) -> args.Arg

Defines a boolean list flag that can be specified multiple times. Use long = "override-name" to override the default kebab-case derivation. function positional

def positional(
*,
minimum: int = 0,
maximum: int = 1,
default: None | list[str] = None,
description: None | str = None
) -> args.Arg

Defines a positional argument that accepts a range of values.