DotDict#

jeanspy.model.DotDict

See methods and properties for individual lookup pages, or the alphabetical API dictionary to search all classes. The full class contract and existing member anchors are retained below.

class jeanspy.model.DotDict#

Bases: dict

Dictionary with attribute access to existing keys.

Notes

Inputs and units. An optional mapping plus keyword values; keys are strings and units belong to the stored values.

Returns and shape. A dict subclass: mapping operations and keys()/values() retain dict behavior. Reading an attribute falls back to an existing key; assigning or deleting an attribute changes an existing key if present.

Validity. Container operations have no physical validation. Assignment to a new attribute creates an ordinary instance attribute, not a mapping key. Use item assignment to insert keys. Dict method names take precedence over attribute access to identically named keys.

Errors. Missing mapping keys raise KeyError; missing attributes raise AttributeError.

Backend. Python host-side containers.

Differentiation. No physical-parameter automatic differentiation on this API.

Examples. DotDict({"R_pc": [10., 20.]}).R_pc returns the stored list.

clear() → None.  Remove all items from D.#
copy() → a shallow copy of D#
classmethod fromkeys(iterable, 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#
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 dict/iterable E and F.#

If E is present and has a .keys() method, then does: for k in E: 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#