Runner (autotransform.runner.base)

The base class and associated classes for Runner components.

class autotransform.runner.base.Runner

Bases: NamedComponent

The base for Runner components. Used by AutoTransform to run an AutoTransformSchema, either locally on the machine or on remote infrastructure.

name

The name of the component.

Type:

ClassVar[RunnerName]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: ClassVar[RunnerName]
abstract run(schema: AutoTransformSchema) None

Triggers a full run of a Schema.

Parameters:

schema (AutoTransformSchema) – The schema that will be run.

abstract update(change: Change) None

Triggers an update of the Change.

Parameters:

change (Change) – The Change to update.

class autotransform.runner.base.RunnerName(value)

Bases: str, Enum

A simple enum for mapping.

GITHUB = 'github'
JENKINS_API = 'jenkins_api'
JENKINS_FILE = 'jenkins_file'
LOCAL = 'local'