roboto.action_runtime.invocation_context#

Module Contents#

class roboto.action_runtime.invocation_context.ActionRuntime(*args, **kwargs)#

Bases: InvocationContext

Deprecated. Use InvocationContext instead.

class roboto.action_runtime.invocation_context.InvocationContext(dataset_id, input_dir, invocation_id, org_id, output_dir, input_data_manifest_file=None, parameters_file=None, secrets_file=None, roboto_client=None)#

A utility for performing common lookups and other operations during a Roboto Action’s runtime.

The easiest and most common way to initialize this is: >>> from roboto import InvocationContext >>> context = InvocationContext.from_env()

…which will inspect environment variables to initialize the InvocationContext.

If you want to test a script using InvocationContext in a setting such as a developer machine or unit test, and you don’t want to set environment variables to mirror Roboto’s remote execution environment, initialize InvocationContext directly:

>>> import pathlib
>>> from roboto import InvocationContext
>>> context = InvocationContext(
...     dataset_id="ds_XXXXXXXXXXXX",
...     input_dir=pathlib.Path("/path/to/local/input/dir"),
...     invocation_id="iv_XXXXXXXXXXXX",
...     org_id="og_XXXXXXXXXXXX",
...     output_dir=pathlib.Path("/path/to/local/output/dir"),
... )
Parameters:

  • dataset_id (str)

  • input_dir (pathlib.Path)

  • invocation_id (str)

  • org_id (str)

  • output_dir (pathlib.Path)

  • input_data_manifest_file (Optional[pathlib.Path])

  • parameters_file (Optional[pathlib.Path])

  • secrets_file (Optional[pathlib.Path])

  • roboto_client (Optional[roboto.http.RobotoClient])

property dataset: roboto.domain.datasets.Dataset#

A Dataset object for the dataset whose data this action is operating on.

This object will be lazy-initialized the first time it is accessed, which might result in a RobotoNotFoundException if the dataset does not exist. After the first call, the dataset will be cached.

This is particularly useful for adding tags or metadata to a dataset at runtime, for example:

>>> from roboto import InvocationContext
>>> context = InvocationContext.from_env()
>>> context.dataset.put_tags(["tagged_by_action"])
>>> context.dataset.put_metadata({"voltage_spikes_seen": 693})
Return type:

roboto.domain.datasets.Dataset

property dataset_id: str#

The ID of the dataset whose data this action is operating on.

Return type:

str

property file_changeset_manager: roboto.action_runtime.file_changeset.FilesChangesetFileManager#

A FilesChangesetFileManager which can be used to associate tags and metadata with the yet-to-be-uploaded files in this invocation’s output directory. In practice, you might use this like:

>>> from roboto import InvocationContext
>>> context = InvocationContext.from_env()
>>> my_output_file = context.output_dir / "my_output_file.txt"
>>> my_output_file.write_text("Hello World")
>>> context.file_changeset_manager.put_tags(my_output_file.name, ["tagged_by_action"])
>>> context.file_changeset_manager.put_fields(
... my_output_file.name, {"roboto_proficiency": "extreme - I can annotate output files!"}
... )

This only works for files that have not yet been uploaded to Roboto. To tag existing files, you should instead use:

>>> from roboto import InvocationContext
>>> context = InvocationContext.from_env()
>>> existing_file = context.dataset.get_file_by_path("some_file_that_already_exists.txt")
>>> existing_file.put_tags(["tagged_by_action"])
>>> existing_file.put_metadata({"roboto_proficiency": "also extreme - I can annotate input files!"})

For more info, see the top-level docs on the FilesChangesetFileManager class.

Return type:

roboto.action_runtime.file_changeset.FilesChangesetFileManager

classmethod from_env()#

Initialize an InvocationContext from values in environment variables. Will throw an exception if any required environment variables are not available.

All required environment variables will be available at runtime when an action is running in Roboto’s remote execution environment.

Example

>>> from roboto import InvocationContext
>>> context = InvocationContext.from_env()
Return type:

InvocationContext

get_input()#

Instance of ActionInput containing resolved references to input data.

Return type:

roboto.action_runtime.action_input.ActionInput

get_optional_parameter(name, default_value=None)#

Retrieve the value of the action parameter with the given name, defaulting to default_value if the parameter is not set.

Parameters:

  • name (str) – The name of the parameter to retrieve.

  • default_value (Optional[str]) – The value to return if the parameter is not set. Defaults to None.

Returns:

The parameter value, or default_value if not set. If the value is a secret URI, returns the resolved secret value.

Return type:

Optional[str]

Examples

>>> import roboto
>>> context = roboto.InvocationContext.from_env()
>>> context.get_optional_parameter("model_version", "latest")
"latest"
get_parameter(name)#

Gets the value of the action parameter with the given name, raising an ActionRuntimeException if the parameter is not set.

Parameters:

name (str)

Return type:

str

get_secret_parameter(name)#

Gets the value of the secret action parameter with the given name.

Parameters:

name (str)

Return type:

str

property input_dir: pathlib.Path#

The directory where the action’s input files are located.

Return type:

pathlib.Path

property invocation: roboto.domain.actions.Invocation#

An Invocation object for the currently running action invocation.

This object will be lazy-initialized the first time it is accessed, which might result in a RobotoNotFoundException if the invocation does not exist. After the first call, the invocation will be cached.

Return type:

roboto.domain.actions.Invocation

property invocation_id: str#

The ID of the currently running action invocation.

Return type:

str

property org: roboto.domain.orgs.Org#

An Org object for the org which invoked the currently running action.

This object will be lazy-initialized the first time it is accessed, which might result in a RobotoNotFoundException if the org does not exist. After the first call, the org will be cached.

Return type:

roboto.domain.orgs.Org

property org_id: str#

The ID of the org which invoked the currently running action.

Return type:

str

property output_dir: pathlib.Path#

The directory where the action’s output files are expected. After the user portion of the action runtime concludes (i.e. when their container exits with a 0 exit code), every file in this directory will be uploaded to the dataset associated with this action invocation.

Return type:

pathlib.Path

property roboto_client: roboto.http.RobotoClient#

The RobotoClient instance used by this action runtime.

Return type:

roboto.http.RobotoClient

roboto.action_runtime.invocation_context.log#
On this page