hpcflow.sdk.persistence.base.StoreEAR

class hpcflow.sdk.persistence.base.StoreEAR(id_, is_pending, elem_iter_ID, action_idx, commands_idx, data_idx, submission_idx=None, commands_file_ID=None, run_file_ID=None, run_file_idx=None, skip=0, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, metadata=None, run_hostname=None, port_number=None, task_ID=None, element_idx=None, iteration_idx=None)

Bases: Generic[SerFormT, ContextT]

Represents an element action run in a persistent store.

Parameters:

• id (int) – The ID of this element action run.

• is_pending (bool) – Whether the element action run has changes not yet persisted.

• elem_iter_ID (int) – What element iteration owns this EAR.

• action_idx (int) – The task schema action associated with this EAR.

• commands_idx (list[int]) – The indices of the commands in the EAR.

• data_idx (DataIndex) – Maps parameter names within this EAR to parameter data indices.

• submission_idx (int | None) – Which submission contained this EAR, if known.

• skip (int) – Whether to skip this EAR.

• success (bool | None) – Whether this EAR was successful, if known.

• start_time (datetime | None) – When this EAR started, if known.

• end_time (datetime | None) – When this EAR finished, if known.

• snapshot_start (dict[str, Any] | None) – Snapshot of files at EAR start, if recorded.

• snapshot_end (dict[str, Any] | None) – Snapshot of files at EAR end, if recorded.

• exit_code (int | None) – The exit code of the underlying executable, if known.

• metadata (Metadata | None) – Metadata concerning e.g. the state of the EAR.

• run_hostname (str | None) – Where this EAR was submitted to run, if known.

• id_ (int)

• commands_file_ID (int | None)

• run_file_ID (int | None)

• run_file_idx (int | None)

• port_number (int | None)

• task_ID (int | None)

• element_idx (int | None)

• iteration_idx (int | None)

Methods

decode	Initialise a StoreEAR from persistent store EAR data
encode	Prepare store EAR data for the persistent store.
to_dict	Prepare data for the user-facing ElementActionRun object.
update	Return a shallow copy, with specified data updated.

Attributes

commands_file_ID	Run ID whose commands can be used for this run (may be this run's ID).
element_idx	Element index of the run, only stored to assist with encoding, not available from decode:
end_time	When this EAR finished, if known.
exit_code	The exit code of the underlying executable, if known.
iteration_idx	Element iteration index of the run, only stored to assist with encoding, not available from decode:
metadata	Metadata concerning e.g. the state of the EAR.
port_number
run_file_ID	ID of the file to which execution-time run metadata should be written.
run_file_idx	Index of data within the run file containing the execution-time run metadata.
run_hostname	Where this EAR was submitted to run, if known.
skip	Whether to skip this EAR.
snapshot_end	Snapshot of files at EAR end, if recorded.
snapshot_start	Snapshot of files at EAR start, if recorded.
start_time	When this EAR started, if known.
submission_idx	Which submission contained this EAR, if known.
success	Whether this EAR was successful, if known.
task_ID	Task of the run, only stored to assist with encoding, not available from decode:
id_	The ID of this element action run.
is_pending	Whether the element action run has changes not yet persisted.
elem_iter_ID	What element iteration owns this EAR.
action_idx	The task schema action associated with this EAR.
commands_idx	The indices of the commands in the EAR.
data_idx	Maps parameter names within this EAR to parameter data indices.

action_idx: int

The task schema action associated with this EAR.

commands_file_ID: int | None = None

Run ID whose commands can be used for this run (may be this run’s ID).

commands_idx: list[int]

The indices of the commands in the EAR.

data_idx: DataIndex

Maps parameter names within this EAR to parameter data indices.

abstractmethod classmethod decode(EAR_dat, ts_fmt, context)

Initialise a StoreEAR from persistent store EAR data

Parameters:

• EAR_dat (SerFormT)

• ts_fmt (str)

• context (ContextT)

Return type:

Self

elem_iter_ID: int

What element iteration owns this EAR.

element_idx: int | None = None

Element index of the run, only stored to assist with encoding, not available from decode:

abstractmethod encode(ts_fmt, context)

Prepare store EAR data for the persistent store.

Parameters:

• ts_fmt (str)

• context (ContextT)

Return type:

SerFormT

end_time: datetime | None = None

When this EAR finished, if known.

exit_code: int | None = None

The exit code of the underlying executable, if known.

id_: int

The ID of this element action run.

is_pending: bool

Whether the element action run has changes not yet persisted.

iteration_idx: int | None = None

Element iteration index of the run, only stored to assist with encoding, not available from decode:

metadata: Metadata | None = None

Metadata concerning e.g. the state of the EAR.

port_number: int | None = None

run_file_ID: int | None = None

ID of the file to which execution-time run metadata should be written.

run_file_idx: int | None = None

Index of data within the run file containing the execution-time run metadata.

run_hostname: str | None = None

Where this EAR was submitted to run, if known.

skip: int = 0

Whether to skip this EAR.

snapshot_end: dict[str, Any] | None = None

Snapshot of files at EAR end, if recorded.

snapshot_start: dict[str, Any] | None = None

Snapshot of files at EAR start, if recorded.

start_time: datetime | None = None

When this EAR started, if known.

submission_idx: int | None = None

Which submission contained this EAR, if known.

success: bool | None = None

Whether this EAR was successful, if known.

task_ID: int | None = None

Task of the run, only stored to assist with encoding, not available from decode:

to_dict()

Prepare data for the user-facing ElementActionRun object.

Return type:

dict[str, Any]

update(submission_idx=None, commands_file_ID=None, run_file_ID=None, run_file_idx=None, skip=None, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, run_hostname=None, port_number=None, data_idx=None)

Return a shallow copy, with specified data updated.

Parameters:

• submission_idx (int | None)

• commands_file_ID (int | None)

• run_file_ID (int | None)

• run_file_idx (int | None)

• skip (int | None)

• success (bool | None)

• start_time (datetime | None)

• end_time (datetime | None)

• snapshot_start (dict[str, Any] | None)

• snapshot_end (dict[str, Any] | None)

• exit_code (int | None)

• run_hostname (str | None)

• port_number (int | None)

• data_idx (DataIndex | None)

Return type:

Self