hpcflow.sdk.submission.enums.JobscriptElementState#

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

Bases: _ReportableStateEnum

Enumeration to convey a particular jobscript element state as reported by the scheduler.

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

Waiting for resource allocation.

waiting

Waiting for one or more dependencies to finish.

running

Executing now.

finished

Previously submitted but is no longer active.

cancelled

Cancelled by the user.

errored

The scheduler reports an error state.

cancelled = _ReportableStateData(id=4, symbol='C', colour='red3', __doc__='Cancelled by the user.')#

Cancelled by the user.

property colour: str#

The colour associated with this state.

errored = _ReportableStateData(id=5, symbol='E', colour='red3', __doc__='The scheduler reports an error state.')#

The scheduler reports an error state.

finished = _ReportableStateData(id=3, symbol='■', colour='grey46', __doc__='Previously submitted but is no longer active.')#

Previously submitted but is no longer active.

property id: int#

The integer ID associated with this state.

pending = _ReportableStateData(id=0, symbol='○', colour='yellow', __doc__='Waiting for resource allocation.')#

Waiting for resource allocation.

property rich_repr: str#

Rich representation of this enumeration element.

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

Executing now.

property symbol: str#

The symbol associated with this state.

waiting = _ReportableStateData(id=1, symbol='◊', colour='grey46', __doc__='Waiting for one or more dependencies to finish.')#

Waiting for one or more dependencies to finish.