hpcflow.sdk.core.enums.EARStatus#

class hpcflow.sdk.core.enums.EARStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: _ReportableStateEnum

Enumeration of all possible EAR statuses, and their associated status colour.

Methods

get_non_running_submitted_states

Return the set of all non-running states, excluding those before submission.

Attributes

id

The integer ID associated with this state.

colour

The colour associated with this state.

symbol

The symbol associated with this state.

rich_repr

Rich representation of this enumeration element.

pending

Not yet associated with a submission.

prepared

Associated with a prepared submission that is not yet submitted.

submitted

Submitted for execution.

running

Executing now.

skipped

Not attempted due to a failure of an upstream action on which this depends, or a loop termination condition being satisfied.

aborted

Aborted by the user; downstream actions will be attempted.

success

Probably exited successfully.

error

Probably failed.

aborted = _ReportableStateData(id=5, symbol='A', colour='deep_pink4', __doc__='Aborted by the user; downstream actions will be attempted.')#

Aborted by the user; downstream actions will be attempted.

property colour: str#

The colour associated with this state.

error = _ReportableStateData(id=7, symbol='E', colour='red3', __doc__='Probably failed.')#

Probably failed.

classmethod get_non_running_submitted_states()#

Return the set of all non-running states, excluding those before submission.

Return type:

frozenset[EARStatus]

property id: int#

The integer ID associated with this state.

pending = _ReportableStateData(id=0, symbol='.', colour='grey46', __doc__='Not yet associated with a submission.')#

Not yet associated with a submission.

prepared = _ReportableStateData(id=1, symbol='.', colour='grey46', __doc__='Associated with a prepared submission that is not yet submitted.')#

Associated with a prepared submission that is not yet submitted.

property rich_repr: str#

Rich representation of this enumeration element.

running = _ReportableStateData(id=3, symbol='●', colour='dodger_blue1', __doc__='Executing now.')#

Executing now.

skipped = _ReportableStateData(id=4, symbol='s', colour='dark_orange', __doc__='Not attempted due to a failure of an upstream action on which this depends, or a loop termination condition being satisfied.')#

Not attempted due to a failure of an upstream action on which this depends, or a loop termination condition being satisfied.

submitted = _ReportableStateData(id=2, symbol='.', colour='grey46', __doc__='Submitted for execution.')#

Submitted for execution.

success = _ReportableStateData(id=6, symbol='■', colour='green3', __doc__='Probably exited successfully.')#

Probably exited successfully.

property symbol: str#

The symbol associated with this state.