hpcflow.sdk.persistence.types.ZarrAttrsDict

class hpcflow.sdk.persistence.types.ZarrAttrsDict

Bases: TypedDict

Zarr workflow attributes descriptor.

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

name	Workflow name.
ts_fmt	Timestamp format.
ts_name_fmt	Timestamp format for names.
creation_info	Information about the creation of the workflow and persistent store.
template	The template used to build the workflow.
template_components	Custom components used to build the workflow.
num_added_tasks	Number of tasks added.
tasks	Tasks in the workflow.
loops	Loops in the workflow.
submissions	Submissions by the workflow.
replaced_workflow	Replacement workflow, if any.

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

copy() → a shallow copy of D

creation_info: StoreCreationInfo

Information about the creation of the workflow and persistent store.

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.

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

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

loops: list[dict[str, Any]]

Loops in the workflow.

name: str

Workflow name.

num_added_tasks: int

Number of tasks added.

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.

replaced_workflow: NotRequired[str]

Replacement workflow, if any.

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.

submissions: list[JSONDocument]

Submissions by the workflow.

tasks: list[dict[str, Any]]

Tasks in the workflow.

template: TemplateMeta

The template used to build the workflow.

template_components: dict[str, Any]

Custom components used to build the workflow.

ts_fmt: str

Timestamp format.

ts_name_fmt: str

Timestamp format for names.

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