hpcflow.sdk.persistence.types.Metadata

class hpcflow.sdk.persistence.types.Metadata

Bases: TypedDict

Workflow metadata.

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

creation_info	Information about the store's creation.
elements	Elements in the workflow.
iters	Iterations in the workflow.
loops	Loops in the workflow.
name	The name of the workflow.
num_added_tasks	The number of added tasks.
replaced_workflow	The replacement workflow, if any.
runs	Element Action Runs in the workflow.
tasks	Tasks in the workflow.
template	The template that generated the workflow.
template_components	Custom template components used.
ts_fmt	Format for timestamps.
ts_name_fmt	Format for timestamps used in naming.

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

creation_info: StoreCreationInfo

Information about the store’s creation.

elements: list[hpcflow.sdk.persistence.types.ElemMeta]

Elements in the workflow.

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()

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

iters: list[hpcflow.sdk.persistence.types.IterMeta]

Iterations in the workflow.

keys()

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

loops: list[hpcflow.sdk.persistence.types.LoopDescriptor]

Loops in the workflow.

name: str

The name of the workflow.

num_added_tasks: int

The number of added tasks.

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: str

The replacement workflow, if any.

runs: list[hpcflow.sdk.persistence.types.RunMeta]

Element Action Runs in the workflow.

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.

tasks: list[hpcflow.sdk.persistence.types.TaskMeta]

Tasks in the workflow.

template: TemplateMeta

The template that generated the workflow.

template_components: dict[str, Any]

Custom template components used.

ts_fmt: str

Format for timestamps.

ts_name_fmt: str

Format for timestamps used in naming.

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.