Arguments API

pydantic model code_genie.io.StringArg[source]
Fields:

  • default_value (Optional[Any])

  • env_var (Optional[str])

  • name (Optional[str])

Validators:

  • must_be_str » default_value

  • name_or_default_value » all fields

  • name_valid » name

field default_value: Optional[Any] = None

Default value of the argument if not provided

Validated by:

  • must_be_str

  • name_or_default_value

field env_var: Optional[str] = None

Name of the environment variable from which this argument should be read if not provided

Validated by:

  • name_or_default_value

field name: Optional[str] = None

Name of the argument, should only contain numbers, letters, dash and underscores; should start with a letter. If a name is provided, then the value of this argument can be set when running the script. If name is not provided, then default_value must be provided and the value of this argument cannot be set while running the pipeline.

Validated by:

  • name_or_default_value

  • name_valid

validator must_be_str  »  default_value[source]
pydantic model code_genie.io.IntArg[source]
Fields:

  • default_value (Optional[Any])

  • env_var (Optional[str])

  • name (Optional[str])

Validators:

  • must_be_int » default_value

  • name_or_default_value » all fields

  • name_valid » name

field default_value: Optional[Any] = None

Default value of the argument if not provided

Validated by:

  • must_be_int

  • name_or_default_value

field env_var: Optional[str] = None

Name of the environment variable from which this argument should be read if not provided

Validated by:

  • name_or_default_value

field name: Optional[str] = None

Name of the argument, should only contain numbers, letters, dash and underscores; should start with a letter. If a name is provided, then the value of this argument can be set when running the script. If name is not provided, then default_value must be provided and the value of this argument cannot be set while running the pipeline.

Validated by:

  • name_or_default_value

  • name_valid

validator must_be_int  »  default_value[source]
pydantic model code_genie.io.BoolArg[source]
Fields:

  • default_value (Optional[Any])

  • env_var (Optional[str])

  • name (Optional[str])

Validators:

  • must_be_bool » default_value

  • name_or_default_value » all fields

  • name_valid » name

field default_value: Optional[Any] = None

Default value of the argument if not provided

Validated by:

  • must_be_bool

  • name_or_default_value

field env_var: Optional[str] = None

Name of the environment variable from which this argument should be read if not provided

Validated by:

  • name_or_default_value

field name: Optional[str] = None

Name of the argument, should only contain numbers, letters, dash and underscores; should start with a letter. If a name is provided, then the value of this argument can be set when running the script. If name is not provided, then default_value must be provided and the value of this argument cannot be set while running the pipeline.

Validated by:

  • name_or_default_value

  • name_valid

validator must_be_bool  »  default_value[source]