Step (autotransform.step.base)

The base class and associated classes for Step components.

class autotransform.step.base.Step

Bases: NamedComponent

The base for Step components. Used by AutoTransform to manage outstanding Changes, determining what actions to take.

name

The name of the component.

Type

ClassVar[StepName]

abstract continue_management(change: Change) → bool

Checks if management should be continued after this Step when Actions were provided.

Parameters

change (Change) – The Change the Step is running against.

Returns

Whether to continue management.

Return type

bool

abstract get_actions(change: Change) → List[Action]

Checks the Change to determine what actions should be taken. If no Actions are returned, the Step is considered skipped.

Parameters

change (Change) – The Change the Step is running against.

Returns

The Actions the Step wants to take.

Return type

List[Action]

name: ClassVar[StepName]

class autotransform.step.base.StepName(value)

Bases: str, Enum

A simple enum for mapping.

CONDITIONAL = 'conditional'