hpcflow.sdk.persistence.types.ElemMeta

class hpcflow.sdk.persistence.types.ElemMeta

Bases: TypedDict

The kwargs supported for a StoreElement.

Methods

clear
copy
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
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

Attributes

id_	The ID of the element.
index	The index of the element.
es_idx	The index of the element in its element set.
seq_idx	The indices of the element in the sequences that contain it.
src_idx	The indices of the element's sources.
task_ID	The task associated with the element.
iteration_IDs	The iteration IDs.

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

es_idx: int

The index of the element in its element set.

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 element.

index: int

The index of the element.

items() → a set-like object providing a view on D's items

iteration_IDs: list[int]

The iteration IDs.

keys() → a set-like object providing a view on D's keys

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.

seq_idx: dict[str, int]

The indices of the element in the sequences that contain it.

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.

src_idx: dict[str, int]

The indices of the element’s sources.

task_ID: int

The task associated with the element.

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() → an object providing a view on D's values