add_history

caput.containers.Container.add_history(name: str, history: collections.abc.Mapping | None = None) → None

Create a new history entry.

Parameters:

namestr

Name for history entry.

historydict | None

History entry (optional). Needs to be json serializable.

Notes

Previously only dictionaries with depth=1 were supported here. The key/value pairs of these where added as attributes to the history group when written to disk. Reading the old history format is still supported, however the history is now an attribute itself and dictionaries of any depth are allowed as history entries.