hpcflow.sdk.typing.KnownSubmissionItem

class hpcflow.sdk.typing.KnownSubmissionItem

Bases: TypedDict

Describes a known submission.

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

local_id	Local ID.
workflow_id	Workflow global ID.
workflow_path	Path to the workflow.
submit_time	Time of submission.
submit_time_obj	Parsed time of submission.
start_time	Time of start.
start_time_obj	Parsed time of start.
end_time	Time of finish.
end_time_obj	Parsed time of finish.
sub_idx	Submission index.
jobscripts	Jobscripts in submission.
active_jobscripts	Active jobscript state.
deleted	Whether this is deleted.
unloadable	Whether this is unloadable.
submission	Expanded submission object.

active_jobscripts: Mapping[int, Mapping[int, Mapping[int, JobscriptElementState]]]

Active jobscript state.

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

deleted: bool

Whether this is deleted.

end_time: str

Time of finish.

end_time_obj: datetime | None

Parsed time of finish.

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.

jobscripts: list[int]

Jobscripts in submission.

keys()

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

local_id: int

Local ID.

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.

start_time: str

Time of start.

start_time_obj: datetime | None

Parsed time of start.

sub_idx: int

Submission index.

submission: NotRequired[Submission]

Expanded submission object.

submit_time: str

Time of submission.

submit_time_obj: NotRequired[datetime | None]

Parsed time of submission.

unloadable: bool

Whether this is unloadable.

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.

workflow_id: str

Workflow global ID.

workflow_path: str

Path to the workflow.