doot.workflow.task

A Utility implementation of most of what a task needs

Classes

`_TaskActionPrep_m`
`_TaskProperties_m`
`_TaskStubbing_m`
`_TaskHelp_m`
`DootTask`	The simplest task, which can import action classes.

Module Contents

class doot.workflow.task._TaskActionPrep_m[source]

prepare_actions() → None[source]

if the task/action spec requires particular action ctors, load them.: if the action spec doesn’t have a ctor, use the task’s action_ctor

collects any action errors together, then raises them as a task error

Return type:: None

class doot.workflow.task._TaskProperties_m[source]

classmethod param_specs() → list[jgdv.cli.ParamSpec][source]

make class parameter specs

Return type:: list[jgdv.cli.ParamSpec]

property name: doot.workflow.structs.TaskName[source]

Return type:: doot.workflow.structs.TaskName

property short_doc: str[source]

Generate Job Class 1 line help string

Return type:: str

property doc: list[str][source]

Return type:: list[str]

property is_stale: bool[source]

Return type:: bool

class doot.workflow.task._TaskStubbing_m[source]

classmethod stub_class( stub: doot.cmds.structs.task_stub.TaskStub, ) → doot.cmds.structs.task_stub.TaskStub[source]

Create a basic toml stub for this task

Parameters:: stub (doot.cmds.structs.task_stub.TaskStub)
Return type:: doot.cmds.structs.task_stub.TaskStub

stub_instance( stub: doot.cmds.structs.task_stub.TaskStub, ) → doot.cmds.structs.task_stub.TaskStub[source]

extend the class toml stub with details from this instance

Parameters:: stub (doot.cmds.structs.task_stub.TaskStub)
Return type:: doot.cmds.structs.task_stub.TaskStub

class doot.workflow.task._TaskHelp_m[source]

classmethod class_help() → list[str][source]

Task class help.

Return type:: list[str]

class doot.workflow.task.DootTask(

spec: doot.workflow._interface.TaskSpec_i,

*,

action_ctor: jgdv.Maybe[collections.abc.Callable] = None,

**kwargs: Any,

)[source]

The simplest task, which can import action classes. eg: actions = [ {do = “doot.workflow.actions.shell_action:DootShellAction”, args = [“echo”, “this is a test”] } ]

Actions are imported upon task creation.

Parameters: