hpcflow.sdk.typing.TemplateComponents

class hpcflow.sdk.typing.TemplateComponents

Bases: TypedDict

Components loaded from templates.

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

parameters	Parameters loaded from templates.
command_files	Command files loaded from templates.
environments	Execution environments loaded from templates.
task_schemas	Task schemas loaded from templates.
scripts	Scripts discovered by templates.

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

command_files: NotRequired[CommandFilesList]

Command files loaded from templates.

copy() → a shallow copy of D

environments: NotRequired[EnvironmentsList]

Execution environments loaded from templates.

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

parameters: NotRequired[ParametersList]

Parameters loaded from templates.

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.

scripts: NotRequired[dict[str, Path]]

Scripts discovered by templates.

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.

task_schemas: NotRequired[TaskSchemasList]

Task schemas loaded from templates.

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