hpcflow.sdk.config.types.ConfigMetadata

class hpcflow.sdk.config.types.ConfigMetadata

Bases: TypedDict

Metadata supported by the Config class.

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

config_directory	Location of directory containing the config file.
config_file_name	Name of the config file.
config_file_path	Full path to the config file.
config_file_contents	The contents of the config file.
config_key	The key identifying the config section within the config file.
config_schemas	Schemas that apply to the config.
invoking_user_id	The user that invoked things.
host_user_id	The user hosting things.
host_user_id_file_path	Path to file holding description of :attr:host_user_id.

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

config_directory: Path

Location of directory containing the config file.

config_file_contents: str

The contents of the config file.

config_file_name: str

Name of the config file.

config_file_path: Path

Full path to the config file.

config_key: str

The key identifying the config section within the config file.

config_schemas: Sequence[Schema]

Schemas that apply to the config.

copy() → a shallow copy of D

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.

host_user_id: str

The user hosting things.

host_user_id_file_path: Path

Path to file holding description of :attr:host_user_id.

invoking_user_id: str

The user that invoked things.

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

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.

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.

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