exception documentation

Exception class for deadlocks. Contains functionality to swap the default traceback for another.

Class Method from_deadlocked_workflow Undocumented
Method __init__ Create a new DeadlockError, with message message and optionally a traceback replacement_tb to be swapped in later.
Method swap_traceback Swap the current traceback for the replacement passed during construction. Used to work around Python adding the current frame to the stack trace.
Instance Variable __traceback__ Undocumented
Static Method _gen_tb_helper Take a thread id and construct a stack trace.
Instance Variable _new_tb Undocumented
@classmethod
def from_deadlocked_workflow(cls, workflow: WorkflowInstance, timeout: Optional[int]): (source)

Undocumented

def __init__(self, message: str, replacement_tb: Optional[TracebackType] = None): (source)

Create a new DeadlockError, with message message and optionally a traceback replacement_tb to be swapped in later.

Parameters
message:strMessage to be presented through exception.
replacement_tb:Optional[TracebackType]Optional TracebackType to be swapped later.
def swap_traceback(self): (source)

Swap the current traceback for the replacement passed during construction. Used to work around Python adding the current frame to the stack trace.

Returns
None
__traceback__ = (source)

Undocumented

@staticmethod
def _gen_tb_helper(tid: int) -> Optional[TracebackType]: (source)

Take a thread id and construct a stack trace.

Returns
Optional[TracebackType]<Optional[TracebackType]> the traceback that was constructed, None if the thread could not be found.

Undocumented