hpcflow.sdk.submission.types.JobscriptHeaderArgs

class hpcflow.sdk.submission.types.JobscriptHeaderArgs

Bases: TypedDict

Keyword arguments to use when creating a job script from a Jobscript.

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

app_invoc	Application invocation.
config_dir	Configuration directory.
config_invoc_key	Configuration key.
EAR_file_name	Name of EAR file.
element_run_dirs_file_path	Name of file containing run directories.
env_setup	Environment setup.
js_idx	Jobscript index.
run_log_file	Log file for the run.
sub_idx	Submission index.
workflow_app_alias	Workflow application alias.
workflow_path	Path to workflow.

EAR_file_name: NotRequired[str]

Name of EAR file.

app_invoc: str | Sequence[str]

Application invocation. (Arguments, etc.)

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

config_dir: NotRequired[str]

Configuration directory.

config_invoc_key: NotRequired[Any]

Configuration key.

copy() → a shallow copy of D

element_run_dirs_file_path: NotRequired[str]

Name of file containing run directories.

env_setup: NotRequired[str]

Environment setup.

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

js_idx: NotRequired[int]

Jobscript index.

keys() → a set-like object providing a view on D's keys

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.

run_log_file: NotRequired[str]

Log file for the run.

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.

sub_idx: NotRequired[int]

Submission index.

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

workflow_app_alias: NotRequired[str]

Workflow application alias.

workflow_path: NotRequired[str]

Path to workflow.