hpcflow.sdk.typing.KnownSubmission

class hpcflow.sdk.typing.KnownSubmission

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.
is_active	Whether the submission is active.
sub_idx	Submission index.
submit_time	Submission time.
path	Path to submission.
start_time	Start time.
end_time	Finish time.

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

end_time: str

Finish time.

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_active: bool

Whether the submission is active.

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.

local_id: int

Local ID.

path: str

Path to submission.

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

Start time.

sub_idx: int

Submission index.

submit_time: str

Submission time.

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.