hpcflow.sdk.persistence.types.LoopDescriptor

class hpcflow.sdk.persistence.types.LoopDescriptor

Bases: TypedDict

Descriptor for loop 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

iterable_parameters	The parameters iterated over by the loop.
output_parameters	The parameters output by the loop, and the final task insert ID from which they are output.
loop_template	The template data from which the loop was created.
num_added_iterations	The number of iterations generated by a loop.
parents	The parents of the loop.

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

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.

iterable_parameters: dict[str, IterableParam]

The parameters iterated over by the loop.

keys()

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

loop_template: NotRequired[dict[str, Any]]

The template data from which the loop was created.

num_added_iterations: list[list[list[int] | int]]

The number of iterations generated by a loop. Note that the type is really list[tuple[tuple[int, ...], int]] but the persistence implementations don’t handle tuples usefully.

output_parameters: dict[str, int]

The parameters output by the loop, and the final task insert ID from which they are output.

parents: list[str]

The parents of the loop.

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.

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.

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.