roboto.env

Module Contents

ROBOTO_ENV_VAR_PREFIX

roboto.env.ROBOTO_ENV_VAR_PREFIX = 'ROBOTO_'#

RobotoEnv

class roboto.env.RobotoEnv(_case_sensitive=None, _nested_model_default_partial_update=None, _env_prefix=None, _env_prefix_target=None, _env_file=ENV_FILE_SENTINEL, _env_file_encoding=None, _env_ignore_empty=None, _env_nested_delimiter=None, _env_nested_max_split=None, _env_parse_none_str=None, _env_parse_enums=None, _cli_prog_name=None, _cli_parse_args=None, _cli_settings_source=None, _cli_parse_none_str=None, _cli_hide_none_type=None, _cli_avoid_json=None, _cli_enforce_required=None, _cli_use_class_docs_for_groups=None, _cli_show_env_vars=None, _cli_exit_on_error=None, _cli_prefix=None, _cli_flag_prefix_char=None, _cli_implicit_flags=None, _cli_ignore_unknown_args=None, _cli_kebab_case=None, _cli_shortcuts=None, _secrets_dir=None, _build_sources=None, **values)#

Bases: pydantic_settings.BaseSettings

Enivronment within an action invocation runtime

Parameters

_case_sensitive bool | None

_nested_model_default_partial_update bool | None

_env_prefix str | None

_env_prefix_target pydantic_settings.sources.EnvPrefixTarget | None

_env_file pydantic_settings.sources.DotenvType | None

_env_file_encoding str | None

_env_ignore_empty bool | None

_env_nested_delimiter str | None

_env_nested_max_split int | None

_env_parse_none_str str | None

_env_parse_enums bool | None

_cli_prog_name str | None

_cli_parse_args bool | list[str] | tuple[str, ...] | None

_cli_settings_source pydantic_settings.sources.CliSettingsSource[Any] | None

_cli_parse_none_str str | None

_cli_hide_none_type bool | None

_cli_avoid_json bool | None

_cli_enforce_required bool | None

_cli_use_class_docs_for_groups bool | None

_cli_show_env_vars bool | None

_cli_exit_on_error bool | None

_cli_prefix str | None

_cli_flag_prefix_char str | None

_cli_implicit_flags bool | Literal['dual', 'toggle'] | None

_cli_ignore_unknown_args bool | None

_cli_kebab_case bool | Literal['all', 'no_enums'] | None

_cli_shortcuts collections.abc.Mapping[str, str | list[str]] | None

_secrets_dir pydantic_settings.sources.PathType | None

_build_sources tuple[tuple[pydantic_settings.sources.PydanticBaseSettingsSource, ...], dict[str, Any]] | None

values Any

Attributes

RobotoEnv.action_inputs_manifest_file

action_inputs_manifest_file pathlib.Path | None = None #

RobotoEnv.action_parameters_file

action_parameters_file str | None = None #

RobotoEnv.action_runtime_config_dir

action_runtime_config_dir str | None = None #

RobotoEnv.action_timeout

action_timeout str | None = None #

RobotoEnv.api_key

api_key str | None = None #

RobotoEnv.cache_dir

cache_dir str | None = None #

RobotoEnv.config_file

config_file str | None = None #

An override for the location of a roboto config file. If not provided, the default ~/.roboto/config.json will be used (subject to RobotoConfig’s implementation)

RobotoEnv.dataset_id

dataset_id str | None = None #

RobotoEnv.dataset_metadata_changeset_file

dataset_metadata_changeset_file str | None = None #

RobotoEnv.default()

classmethod default()#

Return type

RobotoEnv

Attributes

RobotoEnv.default_http_timeout

default_http_timeout Timeout = None #

Give up on Roboto Platform HTTP requests that take longer than this many seconds to complete. If the request is known to be idempotent, it will be automatically retried. Set to None to wait indefinitely.

RobotoEnv.dry_run

dry_run bool | None = None #

Flag that action developers should use to gate side effects during local invocation.

When set to True, actions should skip operations that have side effects, such as: - Uploading files to Roboto datasets - Modifying metadata - Making external API calls that are not idempotent

This enables safe local testing and development without affecting production resources.

RobotoEnv.file_metadata_changeset_file

file_metadata_changeset_file str | None = None #

RobotoEnv.get_env_var()

get_env_var(var_name, default_value=None)#

Parameters

var_name str

default_value Optional[str]

Return type

Optional[str]

Attributes

RobotoEnv.input_dir

input_dir str | None = None #

RobotoEnv.invocation_id

invocation_id str | None = None #

RobotoEnv.log_level

log_level str | None = None #

RobotoEnv.org_id

org_id str | None = None #

RobotoEnv.output_dir

output_dir str | None = None #

RobotoEnv.profile

profile str | None = None #

The profile name to use if getting RobotoConfig from a config file.

RobotoEnv.roboto_env

roboto_env str | None = None #

RobotoEnv.roboto_service_endpoint

roboto_service_endpoint str | None = None #

A Roboto Service API endpoint to send requests to, typically https://api.roboto.ai

RobotoEnv.roboto_service_url

roboto_service_url str | None = None #

Deprecated, use roboto_service_endpoint instead. Left here until 0.3.3 is released so we can migrate existing actions to use the new env var.

RobotoEnvKey

class roboto.env.RobotoEnvKey#

Bases: roboto.compat.StrEnum

Environment variable keys available within an action invocation runtime

Attributes

RobotoEnvKey.ActionInputsManifest

ActionInputsManifest = 'ROBOTO_ACTION_INPUTS_MANIFEST' #

RobotoEnvKey.ActionParametersFile

ActionParametersFile = 'ROBOTO_ACTION_PARAMETERS_FILE' #

RobotoEnvKey.ActionRuntimeConfigDir

ActionRuntimeConfigDir = 'ROBOTO_ACTION_RUNTIME_CONFIG_DIR' #

RobotoEnvKey.ActionTimeout

ActionTimeout = 'ROBOTO_ACTION_TIMEOUT' #

RobotoEnvKey.ApiKey

ApiKey = 'ROBOTO_API_KEY' #

RobotoEnvKey.BearerToken

BearerToken = 'ROBOTO_BEARER_TOKEN' #

Interchangable with ApiKey

RobotoEnvKey.CacheDir

CacheDir = 'ROBOTO_CACHE_DIR' #

RobotoEnvKey.ConfigFile

ConfigFile = 'ROBOTO_CONFIG_FILE' #

RobotoEnvKey.DatasetId

DatasetId = 'ROBOTO_DATASET_ID' #

RobotoEnvKey.DatasetMetadataChangesetFile

DatasetMetadataChangesetFile = 'ROBOTO_DATASET_METADATA_CHANGESET_FILE' #

RobotoEnvKey.DryRun

DryRun = 'ROBOTO_DRY_RUN' #

RobotoEnvKey.FileMetadataChangesetFile

FileMetadataChangesetFile = 'ROBOTO_FILE_METADATA_CHANGESET_FILE' #

RobotoEnvKey.InputDir

InputDir = 'ROBOTO_INPUT_DIR' #

RobotoEnvKey.InvocationId

InvocationId = 'ROBOTO_INVOCATION_ID' #

RobotoEnvKey.LogLevel

LogLevel = 'ROBOTO_LOG_LEVEL' #

RobotoEnvKey.OrgId

OrgId = 'ROBOTO_ORG_ID' #

RobotoEnvKey.OutputDir

OutputDir = 'ROBOTO_OUTPUT_DIR' #

RobotoEnvKey.Profile

Profile = 'ROBOTO_PROFILE' #

RobotoEnvKey.RobotoEnv

RobotoEnv = 'ROBOTO_ENV' #

RobotoEnvKey.RobotoServiceEndpoint

RobotoServiceEndpoint = 'ROBOTO_SERVICE_ENDPOINT' #

RobotoEnvKey.RobotoServiceUrl

RobotoServiceUrl = 'ROBOTO_SERVICE_URL' #

Deprecated, use RobotoServiceEndpoint instead. Left here until 0.3.3 is released so we can migrate existing actions to use the new env var.

RobotoEnvKey.for_parameter()

static for_parameter(param_name)#

Parameters

param_name str

Return type

str

Timeout

type roboto.env.Timeout = typing.Optional[typing.Union[float, NotSetType]]#

Timeout in seconds.

NotSet: Use the client’s default timeout None: No timeout (wait indefinitely) float: Explicit timeout in seconds

resolve_env_variables()

roboto.env.resolve_env_variables(value)#

Given any input string, resolves any environment variables in the string against the current environment.

Parameters

value str