doot.workflow.job

Utility classes for building tasks with a bit of structure

Classes

`_JobStubbing_m`
`DootJob`	Util Class for building single tasks

Module Contents

class doot.workflow.job._JobStubbing_m[source]

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

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]

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

class doot.workflow.job.DootJob(spec: doot.workflow._interface.TaskSpec_i)[source]

Bases: doot.workflow.task.DootTask

Util Class for building single tasks wraps with setup and teardown tasks, manages cleaning, and holds state

Parameters:: spec (doot.workflow._interface.TaskSpec_i)

_help = ('A Basic Task Constructor',)

_default_flags: ClassVar

version: str = '0.1'

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

Job class help.

Return type:: list[str]

default_task( name: jgdv.Maybe[str | doot.workflow._interface.TaskName_p], extra: jgdv.Maybe[dict | jgdv.structs.chainguard.ChainGuard], ) → doot.workflow._interface.TaskSpec_i[source]

Parameters:

name (jgdv.Maybe[str | doot.workflow._interface.TaskName_p])
extra (jgdv.Maybe[dict | jgdv.structs.chainguard.ChainGuard])

Return type:

doot.workflow._interface.TaskSpec_i

is_stale( task: doot.workflow._interface.Task_p, ) → bool[source]

Parameters:: task (doot.workflow._interface.Task_p)
Return type:: bool

specialize_task( task: doot.workflow._interface.Task_p, ) → doot.workflow._interface.Task_p[source]

Parameters:: task (doot.workflow._interface.Task_p)
Return type:: doot.workflow._interface.Task_p

expand_job() → list[source]

Return type:: list