hpcflow.sdk.config.types.ConfigDescriptor

class hpcflow.sdk.config.types.ConfigDescriptor

Bases: TypedDict

Configuration descriptor.

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

machine	Execution machine.
log_file_path	Where to log.
environment_sources	Where to find execution environments.
task_schema_sources	Where to find task schemas.
command_file_sources	Where to find command files.
parameter_sources	Where to find parameter implementations.
default_scheduler	Default scheduler.
default_shell	Default shell.
schedulers	Supported schedulers.
shells	Supported shells.

clear()

Remove all items from the dict.

command_file_sources: NotRequired[list[str]]

Where to find command files.

copy()

Return a shallow copy of the dict.

default_scheduler: NotRequired[str]

Default scheduler.

default_shell: NotRequired[str]

Default shell.

environment_sources: NotRequired[list[str]]

Where to find execution environments.

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.

keys()

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

log_file_path: NotRequired[str]

Where to log.

machine: NotRequired[str]

Execution machine.

parameter_sources: NotRequired[list[str]]

Where to find parameter implementations.

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.

schedulers: NotRequired[dict[str, SchedulerConfigDescriptor]]

Supported schedulers.

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.

shells: NotRequired[dict[str, ShellConfigDescriptor]]

Supported shells.

task_schema_sources: NotRequired[list[str]]

Where to find task schemas.

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.