bw2data.backends.single_file.database#

Module Contents#

Classes#

SingleFileDatabase

A data store for LCI databases where each database is stored as a pickle file.
class bw2data.backends.single_file.database.SingleFileDatabase(name)[source]#

Bases: bw2data.backends.base.LCIBackend

Inheritance diagram of bw2data.backends.single_file.database.SingleFileDatabase

A data store for LCI databases where each database is stored as a pickle file.

Databases are automatically versioned. See below for reversion, etc. methods

Parameters

*name* (str) – Name of the database to manage.

property filename[source]#

Remove filesystem-unsafe characters and perform unicode normalization on self.name using utils.safe_filename().

property version[source]#

The current version number (integer) of this database.

Returns

Version number

backend = 'singlefile'[source]#
validator[source]#
filename_for_version(version=None)[source]#

Filename for given version; Default is current version.

Returns

Filename (not path)

filepath_intermediate(version=None)[source]#
get(code)[source]#

Get Activity proxy for this dataset

load(version=None, **kwargs)[source]#

Load the intermediate data for this database.

Can also load previous versions of this database’s intermediate data.

Parameters

version (*) – Version of the database to load. Default version is the latest version.

Returns

The intermediate data, a dictionary.

make_latest_version()[source]#

Make the current version the latest version.

Requires loading data because a new intermediate data file is created.

register(**kwargs)[source]#

Register a database with the metadata store.

Databases must be registered before data can be written.

revert(version)[source]#

Return data to a previous state.

Warning

Reverting can lead to data loss, e.g. if you revert from version 3 to version 1, and then save your database, you will overwrite version 2. Use make_latest_version() before saving, which will set the current version to 4.

Parameters

version (*) – Number of the version to revert to.

versions()[source]#

Get a list of available versions of this database.

Returns

List of (version, datetime created) tuples.

write(data, process=True)[source]#

Serialize data to disk.

Parameters

data (*) – Inventory data