apsbits.utils.stored_dict

Storage-backed Dictionary

A dictionary that writes its contents to YAML file. Replaces bluesky.utils.PersistentDict. * Contents must be JSON serializable. * Contents stored in a single human-readable YAML file. * Sync to disk shortly after dictionary is updated. .. autosummary:

~StoredDict

Classes

StoredDict(file[, delay, title, serializable])

Dictionary that syncs to storage. .. autosummary:: ~flush ~popitem ~reload .. rubric:: Static methods All support for the YAML format is implemented in the static methods. .. autosummary:: ~dump ~load ----.

class apsbits.utils.stored_dict.StoredDict(file, delay=5, title=None, serializable=True)

Bases: MutableMapping

Dictionary that syncs to storage. .. autosummary:

~flush
~popitem
~reload

Static methods

All support for the YAML format is implemented in the static methods. .. autosummary:

~dump
~load

---

__init__(file, delay=5, title=None, serializable=True)

StoredDict : Dictionary that syncs to storage PARAMETERS file : str or pathlib.Path

Name of file to store dictionary contents.

delaynumber

Time delay (s) since last dictionary update to write to storage. Default: 5 seconds.

titlestr or None

Comment to write at top of file. Default: “Written by StoredDict.”

serializablebool

If True, validate new dictionary entries are JSON serializable.

_abc_impl = <_abc._abc_data object>

_delayed_sync_to_storage()

Sync the metadata to storage. Start a time-delay thread. New writes to the metadata dictionary will extend the deadline. Sync once the deadline is reached.

static dump(file, contents, title=None)

Write dictionary to YAML file.

flush()

Force a write of the dictionary to disk

static load(file)

Read dictionary from YAML file.

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.

reload()

Read dictionary from storage.