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, skip=False, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, metadata=None, run_hostname=None)

Bases: object

Parameters:

• data_idx (Dict[str, int]) – Maps parameter names within this EAR to parameter data indices.

• metadata (Dict[str, Any]) – Metadata concerning e.g. the state of the EAR.

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

• id_ (int) –

• is_pending (bool) –

• elem_iter_ID (int) –

• commands_idx (List[int]) –

• submission_idx (int | None) –

• skip (bool | None) –

• success (bool | None) –

• start_time (datetime | None) –

• end_time (datetime | None) –

• snapshot_start (Dict | None) –

• snapshot_end (Dict | None) –

• exit_code (int | None) –

• run_hostname (str | 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

end_time
exit_code
metadata
run_hostname
skip
snapshot_end
snapshot_start
start_time
submission_idx
success
id_
is_pending
elem_iter_ID
action_idx
commands_idx
data_idx

action_idx: int

commands_idx: List[int]

data_idx: Dict[str, int]

classmethod decode(EAR_dat, ts_fmt)

Initialise a StoreEAR from persistent store EAR data

Parameters:

• EAR_dat (Dict) –

• ts_fmt (str) –

Return type:

StoreEAR

elem_iter_ID: int

encode(ts_fmt)

Prepare store EAR data for the persistent store.

Parameters:

ts_fmt (str) –

Return type:

Dict

end_time: datetime | None = None

exit_code: int | None = None

id_: int

is_pending: bool

metadata: Dict[str, Any] = None

run_hostname: str | None = None

skip: bool | None = False

snapshot_end: Dict | None = None

snapshot_start: Dict | None = None

start_time: datetime | None = None

submission_idx: int | None = None

success: bool | None = None

to_dict()

Prepare data for the user-facing ElementActionRun object.

Return type:

Dict

update(submission_idx=None, skip=None, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, run_hostname=None)

Return a shallow copy, with specified data updated.

Parameters:

• submission_idx (int | None) –

• skip (bool | None) –

• success (bool | None) –

• start_time (datetime | None) –

• end_time (datetime | None) –

• snapshot_start (Dict | None) –

• snapshot_end (Dict | None) –

• exit_code (int | None) –

• run_hostname (str | None) –

Return type:

AnySEAR