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 get_action(change: Change) → Action

Checks the Change to determine what action should be taken. If no action is needed, an action with ActionType.NONE should be returned.

Parameters

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

Returns

The Action the Step wants to take.

Return type

Action

name: ClassVar[StepName]

class autotransform.step.base.StepName(value)

Bases: str, Enum

A simple enum for mapping.

CONDITIONAL = 'conditional'