.. _doot.workflow.job:
  
=================
doot.workflow.job
=================
  


.. py:module:: doot.workflow.job

.. autoapi-nested-parse::

   Utility classes for building tasks with a bit of structure

 











Classes
-------
  


.. autoapisummary::

    doot.workflow.job._JobStubbing_m
    doot.workflow.job.DootJob

Module Contents
===============


.. doot.workflow.job._JobStubbing_m:
  


.. py:class:: _JobStubbing_m

 

   
   .. py:method:: stub_class(stub: doot.cmds.structs.task_stub.TaskStub) -> doot.cmds.structs.task_stub.TaskStub
      :classmethod:



   
   .. py:method:: stub_instance(stub: doot.cmds.structs.task_stub.TaskStub) -> doot.cmds.structs.task_stub.TaskStub



 

.. _doot.workflow.job.DootJob:
  


.. py:class:: DootJob(spec: doot.workflow._interface.TaskSpec_i)

   Bases: :py:obj:`doot.workflow.task.DootTask` 
  
   Util Class for building single tasks
   wraps with setup and teardown tasks,
   manages cleaning,
   and holds state



   .. py:attribute:: _help
      :value: ('A Basic Task Constructor',)


   .. py:attribute:: _default_flags
      :type:  ClassVar

   .. py:attribute:: version
      :type:  str
      :value: '0.1'


   
   .. py:method:: class_help() -> list[str]
      :classmethod:


      Job *class* help.



   
   .. py:method:: default_task(name: jgdv.Maybe[str | doot.workflow._interface.TaskName_p], extra: jgdv.Maybe[dict | jgdv.structs.chainguard.ChainGuard]) -> doot.workflow._interface.TaskSpec_i



   
   .. py:method:: is_stale(task: doot.workflow._interface.Task_p) -> bool



   
   .. py:method:: specialize_task(task: doot.workflow._interface.Task_p) -> doot.workflow._interface.Task_p



   
   .. py:method:: expand_job() -> list