hpcflow.sdk.persistence.types.RunMeta

class hpcflow.sdk.persistence.types.RunMeta

Bases: TypedDict

The kwargs supported for StoreEAR.

Methods

clear	Remove all items from the dict.
copy	Return a shallow copy of the dict.
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items	Return a set-like object providing a view on the dict's items.
keys	Return a set-like object providing a view on the dict's keys.
pop	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
update	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values	Return an object providing a view on the dict's values.

Attributes

id_	The ID of the EAR.
elem_iter_ID	The ID of the element iteration containing the EAR.
action_idx	The index of the action that generated the EAR.
commands_idx	The commands that the EAR will run.
data_idx	The data handled by the EAR.
metadata	Metadata about the EAR.
end_time	When the EAR ended, if known.
exit_code	The exit code of the EAR, if known.
start_time	When the EAR started, if known.
snapshot_start	Working directory snapshot at start.
snapshot_end	Working directory snapshot at end.
submission_idx	The index of the EAR in the submissions.
run_hostname	Where the EAR is set to run.
success	Whether the EAR succeeded, if known.
skip	The skip reason ID, if EAR was skipped.
port_number	Port number used by ZeroMQ during execution.
commands_file_ID	Run ID whose command file can be used for this run (may be this run's ID).

action_idx: int

The index of the action that generated the EAR.

clear()

Remove all items from the dict.

commands_file_ID: int | None

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

commands_idx: list[int]

The commands that the EAR will run.

copy()

Return a shallow copy of the dict.

data_idx: DataIndex

The data handled by the EAR.

elem_iter_ID: int

The ID of the element iteration containing the EAR.

end_time: NotRequired[str | None]

When the EAR ended, if known.

exit_code: int | None

The exit code of the EAR, if known.

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

id_: int

The ID of the EAR.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

metadata: Metadata | None

Metadata about the EAR.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

port_number: int | None

Port number used by ZeroMQ during execution.

run_hostname: str | None

Where the EAR is set to run.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

skip: int

The skip reason ID, if EAR was skipped.

snapshot_end: dict[str, Any] | None

Working directory snapshot at end.

snapshot_start: dict[str, Any] | None

Working directory snapshot at start.

start_time: NotRequired[str | None]

When the EAR started, if known.

submission_idx: int | None

The index of the EAR in the submissions.

success: bool | None

Whether the EAR succeeded, if known.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.