hpcflow.sdk.submission.types.JobScriptCreationArguments#

class hpcflow.sdk.submission.types.JobScriptCreationArguments#

Bases: TypedDict

Arguments to pass to create a Jobscript.

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

task_insert_IDs

The task insertion IDs.

task_actions

The actions of the tasks.

task_elements

The elements of the tasks.

EAR_ID

Element action run information.

resources

Resources to use.

task_loop_idx

Description of what loops are in play.

dependencies

Description of dependencies.

is_array

Whether this is an array jobscript.

submit_time

When the jobscript was submitted, if known.

submit_hostname

Where the jobscript was submitted, if known.

submit_machine

Description of what the jobscript was submitted to, if known.

submit_cmdline

The command line used to do the commit, if known.

scheduler_job_ID

The job ID from the scheduler, if known.

process_ID

The process ID of the subprocess, if known.

version_info

Version info about the target system.

os_name

The name of the OS.

shell_name

The name of the shell.

scheduler_name

The scheduler used.

running

Whether the jobscript is currently running.

resource_hash

Do not supply!

elements

Do not supply!

EAR_ID: NDArray#

Element action run information.

clear()#

Remove all items from the dict.

copy()#

Return a shallow copy of the dict.

dependencies: dict[int | tuple[int, int], ResolvedJobscriptBlockDependencies]#

Description of dependencies.

elements: NotRequired[dict[int, list[int]]]#

Do not supply!

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.

is_array: NotRequired[bool]#

Whether this is an array jobscript.

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.

os_name: NotRequired[str]#

The name of the OS.

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.

process_ID: NotRequired[int]#

The process ID of the subprocess, if known.

resource_hash: NotRequired[str]#

Do not supply!

resources: NotRequired[ElementResources]#

Resources to use.

running: NotRequired[bool]#

Whether the jobscript is currently running.

scheduler_job_ID: NotRequired[str]#

The job ID from the scheduler, if known.

scheduler_name: NotRequired[str]#

The scheduler used.

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.

shell_name: NotRequired[str]#

The name of the shell.

submit_cmdline: NotRequired[list[str]]#

The command line used to do the commit, if known.

submit_hostname: NotRequired[str]#

Where the jobscript was submitted, if known.

submit_machine: NotRequired[str]#

Description of what the jobscript was submitted to, if known.

submit_time: NotRequired[datetime]#

When the jobscript was submitted, if known.

task_actions: list[tuple[int, int, int]]#

The actions of the tasks.

task_elements: dict[int, list[int]]#

The elements of the tasks.

task_insert_IDs: list[int]#

The task insertion IDs.

task_loop_idx: list[dict[str, int]]#

Description of what loops are in play.

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.

version_info: NotRequired[dict[str, str | list[str]]]#

Version info about the target system.