bw2data.serialization

Module Contents

Classes

CompoundJSONDict	Subclass of SerializedDict that allows tuples as dictionary keys (not allowed in JSON).
JsonSanitizer
JsonWrapper
PickledDict	Subclass of SerializedDict that uses the pickle format instead of JSON.
SerializedDict	Base class for dictionary that can be serialized to or unserialized from disk. Uses JSON as its storage format. Has most of the methods of a dictionary.

Attributes

anyjson

class bw2data.serialization.CompoundJSONDict(dirpath=None)

Bases: SerializedDict

Subclass of SerializedDict that allows tuples as dictionary keys (not allowed in JSON).

pack(data)

Transform the dictionary to a list because JSON can’t handle lists as keys

unpack(data)

Transform data back to a dictionary

class bw2data.serialization.JsonSanitizer

classmethod load(data)

classmethod sanitize(data)

class bw2data.serialization.JsonWrapper

classmethod dump(data, filepath)

classmethod dump_bz2(data, filepath)

classmethod dumps(data)

classmethod load(file)

classmethod load_bz2(filepath)

classmethod loads(data)

class bw2data.serialization.PickledDict(dirpath=None)

Bases: SerializedDict

Subclass of SerializedDict that uses the pickle format instead of JSON.

deserialize()

Load the serialized data. Can be replaced with other serialization formats.

serialize()

Method to do the actual serialization. Can be replaced with other serialization formats.

Args:

• filepath (str, optional): Provide an alternate filepath (e.g. for backup).

class bw2data.serialization.SerializedDict(dirpath=None)

Bases: collections.abc.MutableMapping

Base class for dictionary that can be serialized to or unserialized from disk. Uses JSON as its storage format. Has most of the methods of a dictionary.

Upon instantiation, the serialized dictionary is read from disk.

property list

List the keys of the dictionary. This is a property, and does not need to be called.

backup()

Write a backup version of the data to the backups directory.

deserialize()

Load the serialized data. Can be replaced with other serialization formats.

flush()

Serialize the current data to disk.

keys()

D.keys() -> a set-like object providing a view on D’s keys

load()

Load the serialized data. Creates the file if not yet present.

pack(data)

Transform the data, if necessary. Needed because JSON must have strings as dictionary keys.

random()

Return a random key.

serialize(filepath=None)

Method to do the actual serialization. Can be replaced with other serialization formats.

Args:

• filepath (str, optional): Provide an alternate filepath (e.g. for backup).

unpack(data)

Return serialized data to true form.

values()

D.values() -> an object providing a view on D’s values

bw2data.serialization.anyjson