ngsildclient.model.ngsidict#

Classes

NgsiDict(*args[, dtcached])

This class is a custom dictionary that backs an entity.

class ngsildclient.model.ngsidict.NgsiDict(*args, dtcached=None, **kwargs)[source]#

Bases: dict

This class is a custom dictionary that backs an entity.

NgsiDict is used to build and hold the entity properties, as well as the entity’s root. It’s not exposed to the user but intended to be used by the Entity class. NgsiDict provides methods that allow to build a dictionary compliant with a NGSI-LD structure.

See also

model.Entity

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

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.

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 key is not found, default is returned if given, otherwise KeyError is raised

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.

pprint(*args, **kwargs)[source]#

Returns the dict pretty-json-formatted

Return type: None

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.

to_json(indent=None)[source]#

Returns the dict in json format

Return type: str

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#