.. _doot.errors.control:
  
===================
doot.errors.control
===================
  


.. py:module:: doot.errors.control

.. autoapi-nested-parse::

   These are the doot specific errors that can occur

 










Exceptions
----------

.. autoapisummary::

   doot.errors.control.ControlError
   doot.errors.control.TrackingError
   doot.errors.control.TaskExecutionError
   doot.errors.control.JobExpansionError
   doot.errors.control.ActionCallError
   doot.errors.control.ActionStateError




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


.. _doot.errors.control.ControlError:
  


.. py:exception:: ControlError

   Bases: :py:obj:`doot.errors._base.BackendError` 
  
   The base class for all Doot Errors
   will try to % format the first argument with remaining args in str()


 

.. _doot.errors.control.TrackingError:
  


.. py:exception:: TrackingError

   Bases: :py:obj:`ControlError` 
  
   The underlying sequencing of task running failed in some way.


   .. py:attribute:: general_msg
      :type:  str
      :value: 'Doot Tracking Failure:'


 

.. _doot.errors.control.TaskExecutionError:
  


.. py:exception:: TaskExecutionError(msg: str, *args: Any, task: jgdv.Maybe[doot.workflow._interface.Task_i] = None)

   Bases: :py:obj:`ControlError` 
  
   An Error indicating a specific task failed


   .. py:attribute:: general_msg
      :value: 'Doot Task Error:'


   .. py:attribute:: task
      :value: None


   .. py:property:: task_name

   .. py:property:: task_source

 

.. _doot.errors.control.JobExpansionError:
  


.. py:exception:: JobExpansionError(msg: str, *args: Any, task: jgdv.Maybe[doot.workflow._interface.Task_i] = None)

   Bases: :py:obj:`TaskExecutionError` 
  
   An Error indicating a specific task failed


 

.. _doot.errors.control.ActionCallError:
  


.. py:exception:: ActionCallError(msg: str, *args: Any, task: jgdv.Maybe[doot.workflow._interface.Task_i] = None)

   Bases: :py:obj:`TaskExecutionError` 
  
   In the course of executing a task, one of it's actions failed.


   .. py:attribute:: general_msg
      :value: 'Doot Action Failure:'


 

.. _doot.errors.control.ActionStateError:
  


.. py:exception:: ActionStateError(msg: str, *args: Any, task: jgdv.Maybe[doot.workflow._interface.Task_i] = None)

   Bases: :py:obj:`ActionCallError` 
  
   An action required certain state to exist, but it wasn't found.


   .. py:attribute:: general_msg
      :value: 'Doot Action State Fields Missing:'