dootle.control.fsm._interface

Protocols

TaskModel_Conditions_p

The conditions a TaskTrackFSM calls

TaskModel_Callbacks_p

Describes the callbacks for the FSM of a task

TaskModel_p

Combines the TaskModel Conditions and Callbacks protocols

ArtifactModel_p

Describes the callbacks for an FSM of a task

Module Contents

class dootle.control.fsm._interface.TaskModel_Conditions_p[source]

Bases: Protocol

The conditions a TaskTrackFSM calls

spec_missing(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → bool[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

bool

should_disable(
source: statemachine.State,
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → bool[source]
Parameters:

  • source (statemachine.State)

  • tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

bool

should_wait(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → bool[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

bool

should_timeout() → bool[source]
Return type:

bool

should_skip() → bool[source]
Return type:

bool

should_halt() → bool[source]
Return type:

bool

should_fail() → bool[source]
Return type:

bool

state_is_needed(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → bool[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

bool

class dootle.control.fsm._interface.TaskModel_Callbacks_p[source]

Bases: Protocol

Describes the callbacks for the FSM of a task

on_enter_INIT(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → None[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

None

on_enter_RUNNING(
*,
step: int,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → None[source]
Parameters:

  • step (int)

  • tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

None

on_enter_HALTED(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → None[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

None

on_enter_FAILED(
*,
tracker: doot.control.tracker._interface.WorkflowTracker_p,
) → None[source]
Parameters:

tracker (doot.control.tracker._interface.WorkflowTracker_p)

Return type:

None

on_exit_TEARDOWN() → None[source]
Return type:

None

class dootle.control.fsm._interface.TaskModel_p[source]

Bases: TaskModel_Callbacks_p, TaskModel_Conditions_p, Protocol

Combines the TaskModel Conditions and Callbacks protocols

class dootle.control.fsm._interface.ArtifactModel_p[source]

Bases: Protocol

Describes the callbacks for an FSM of a task

is_stale() → bool[source]
Return type:

bool

should_clean() → bool[source]
Return type:

bool

does_exist() → bool[source]
Return type:

bool