textnets.config.TextnetsConfiguration

class textnets.config.TextnetsConfiguration(dict=None, /, **kwargs)

Bases: UserDict

Container for global parameters.

Methods

clear
copy
fromkeys
get
items
keys
load	Load parameters from file.
pop	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem	as a 2-tuple; but raise KeyError if D is empty.
save	Save parameters to file.
setdefault
update	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values

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

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

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

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

load(source: PathLike[str] | str) → None

Load parameters from file.

Parameters:

source (path) – Location of file to load parameters from.

Raises:

FileNotFoundError – If the path does not exist.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

save(target: PathLike[str] | str) → None

Save parameters to file.

Parameters:

target (path) – Location of file to save parameters to.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values