core.exceptions
===============

.. py:module:: core.exceptions

.. autoapi-nested-parse::

   Custom Exceptions used throughout Jobmon.



Exceptions
----------

.. autoapisummary::

   core.exceptions.InvalidResponse
   core.exceptions.InvalidRequest
   core.exceptions.RemoteExitInfoNotAvailable
   core.exceptions.CallableReturnedInvalidObject
   core.exceptions.WorkflowAlreadyExists
   core.exceptions.WorkflowAlreadyComplete
   core.exceptions.WorkflowNotResumable
   core.exceptions.EmptyWorkflowError
   core.exceptions.DistributorStartupTimeout
   core.exceptions.DistributorNotAlive
   core.exceptions.DistributorUnexpected
   core.exceptions.WorkflowRunStateError
   core.exceptions.ResumeSet
   core.exceptions.NodeDependencyNotExistError
   core.exceptions.DuplicateNodeArgsError
   core.exceptions.InvalidMemoryFormat
   core.exceptions.InvalidMemoryUnit
   core.exceptions.ConfigError
   core.exceptions.InvalidStateTransition
   core.exceptions.TransitionError
   core.exceptions.WorkflowTestError
   core.exceptions.DistributorInterruptedError
   core.exceptions.CyclicGraphError
   core.exceptions.UserTaskFunctionError


Classes
-------

.. autoapisummary::

   core.exceptions.ReturnCodes


Module Contents
---------------

.. py:class:: ReturnCodes

   Bases: :py:obj:`object`


   Bash return codes used in distributor wrapper.


   .. py:attribute:: OK
      :value: 0



   .. py:attribute:: WORKER_NODE_ENV_FAILURE
      :value: 198



   .. py:attribute:: WORKER_NODE_CLI_FAILURE
      :value: 199



.. py:exception:: InvalidResponse

   Bases: :py:obj:`Exception`


   Invalid Response type Exception.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: InvalidRequest

   Bases: :py:obj:`Exception`


   Invalid Request type Exception.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: RemoteExitInfoNotAvailable

   Bases: :py:obj:`Exception`


   Exception raised when Exit Info is not available for different executor types.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: CallableReturnedInvalidObject

   Bases: :py:obj:`Exception`


   Invalid Object got returned.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: WorkflowAlreadyExists

   Bases: :py:obj:`Exception`


   Workflow with the same workflow args already exists.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: WorkflowAlreadyComplete

   Bases: :py:obj:`Exception`


   This Workflow is already done.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: WorkflowNotResumable

   Bases: :py:obj:`Exception`


   This Workflow is not set to be resumed.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: EmptyWorkflowError

   Bases: :py:obj:`Exception`


   This Workflow is empty.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: DistributorStartupTimeout

   Bases: :py:obj:`Exception`


   Distributor was not able to start in time.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: DistributorNotAlive

   Bases: :py:obj:`Exception`


   The Distributor is not running.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: DistributorUnexpected

   Bases: :py:obj:`Exception`


   Unexpected situation in Distributor.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: WorkflowRunStateError

   Bases: :py:obj:`Exception`


   Error with the Workflow Run status.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: ResumeSet

   Bases: :py:obj:`Exception`


   Resume Exception.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: NodeDependencyNotExistError

   Bases: :py:obj:`Exception`


   Dependency does not exist.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: DuplicateNodeArgsError

   Bases: :py:obj:`Exception`


   Multiple nodes with the same args for the same TaskTemplate not allowed.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: InvalidMemoryFormat

   Bases: :py:obj:`Exception`


   Memory input invalid.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: InvalidMemoryUnit

   Bases: :py:obj:`Exception`


   Memory convert unit invalid.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: ConfigError

   Bases: :py:obj:`Exception`


   No configuration found for server.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: InvalidStateTransition(model: str, id: int, old_state: str, new_state: str)

   Bases: :py:obj:`Exception`


   Invalid State Transition implementation.

   Initialize Exception.


.. py:exception:: TransitionError

   Bases: :py:obj:`Exception`


   Transition failed.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: WorkflowTestError

   Bases: :py:obj:`Exception`


   Workflow Run encountered and error.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: DistributorInterruptedError

   Bases: :py:obj:`Exception`


   raised when signal is sent to distributor.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: CyclicGraphError

   Bases: :py:obj:`Exception`


   Cyclic graph detected.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: UserTaskFunctionError

   Bases: :py:obj:`Exception`


   Raised when a user's task function raises an exception.

   Used as a marker to distinguish user task failures from jobmon-internal
   errors at log boundaries. The original exception is chained via ``raise
   ... from e`` so the full traceback is preserved.

   Initialize self.  See help(type(self)) for accurate signature.