Skip to main content

​
boolean

def boolean(
*,
required: ‘bool’ = False,
default: ‘bool’ = …,
) -> ‘args.TaskArg’
Defines a boolean flag that can be specified as --flag_name=true|false or simply --flag_name, which is equivalent to --flag_name=true. Examples 
task(
  args = {
    "color": args.boolean(),
  }
)

​
boolean_list

def boolean_list(
*,
required: ‘bool’ = False,
default: None | list[‘bool’] = None,
) -> ‘args.TaskArg’
Defines a boolean list flag that can be specified multiple times as --flag_name=true|false. Examples 
task(
  args = {
    "flags": args.boolean_list(),
  }
)

​
int

def int(
*,
required: ‘bool’ = False,
default: ‘int’ = …,
) -> ‘args.TaskArg’
Creates an integer flag that can be set as --flag_name=flag_value or --flag_name=flag_value. Examples 
task(
  args = {
    "color": args.int(),
  }
)

​
int_list

def int_list(
*,
required: ‘bool’ = False,
default: None | list[‘int’] = None,
) -> ‘args.TaskArg’
Defines an integer list flag that can be specified multiple times as --flag_name=flag_value. Examples 
task(
  args = {
    "numbers": args.int_list(),
  }
)

​
positional

def positional(
*,
minimum: ‘int’ = 0,
maximum: ‘int’ = 1,
default: None | list[‘str’] = None,
) -> ‘args.TaskArg’
Defines a positional argument that accepts a range of values, with a required minimum number of values and an optional maximum number of values. Examples 
**Take** one positional argument with no dashes.
task(
 args = { "named": args.positional() }
)

**Take** two positional argument with no dashes.
task(
 args = { "named": args.positional(minimum = 2, maximum = 2) }
)

​
string

def string(
*,
required: ‘bool’ = False,
default: ‘str’ = …,
) -> ‘args.TaskArg’
Defines a string flag that can be specified as --flag_name=flag_value. Examples 
task(
  args = {
    "bes_backend": args.string(),
  }
)

​
string_list

def string_list(
*,
required: ‘bool’ = False,
default: None | list[‘str’] = None,
) -> ‘args.TaskArg’
Defines a string list flag that can be specified multiple times as --flag_name=flag_value. Examples 
task(
  args = {
    "bes_headers": args.string_list(),
  }
)

​
trailing_var_args

def trailing_var_args() -> ‘args.TaskArg’
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. Examples 
task(
  args = {
    # take one positional argument with no dashes.
    "target": args.positional(minimum = 0, maximum = 1),
    # take rest of the commandline
    "run_args": args.trailing_var_args()
  }
)

​
uint

def uint(
*,
required: ‘bool’ = False,
default: ‘int’ = …,
) -> ‘args.TaskArg’
Defines an unsigned integer flag that can be specified using the format --flag_name=flag_value. Examples 
task(
  args = {
    "color": args.uint(),
  }
)

​
uint_list

def uint_list(
*,
required: ‘bool’ = False,
default: None | list[‘int’] = None,
) -> ‘args.TaskArg’
Defines an unsigned integer list flag that can be specified multiple times as --flag_name=flag_value. Examples 
task(
  args = {
    "ports": args.uint_list(),
  }
)