paramdb - v0.15.3

Fixed

• New fields can be defined on a ParamDataclass without causing a KeyError.

- Python
Published by painterlab 4 months ago

paramdb - v0.15.2

• ParamDataFrame now saves and loads DataFrames to and from Pickle files instead of CSV files.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.15.1

Fixed

• ParamDict treats dunder names (e.g. __init__) as attributes, allowing internal Python functionalities to work.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.15.0

Added

• Added ParamDB.__repr__() for better debugging.

Changed

• ParamDB.commit() now has a raw_json option, allowing a raw JSON string to be committed to the database.
• Updated the underlying JSON representation to be more self-describing; see ParamDB.load() for the new format specification.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.14.0

Changed

• The option decode_json in ParamDB.load() was replaced with raw_json, which allows loading the raw JSON string from the database.
• The order of data for ParamData objects in the underlying JSON representation was changed; see ParamDB.load() for the new order.

Removed

• ParamDBKey.WRAPPER was removed in favor of encoding these values using ParamDBKey.PARAM with a class name of None.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.13.0

Added

• The timestamps of non-ParamData children are now tracked internally and can be accessed via the new method ParamData.child_last_updated().
• The class ParamDBKey contains the keys used in the JSON representation of a commit.

Changed

• ParamDict dot notation now treates names of existing attributes and names of class type annotations as attributes (rather than treating all names beginning with underscores as attributes).
• The JSON format of a commit has been changed, as specified in the docstring for ParamDB.load().
• ParamData.to_dict() and ParamData.from_dict() have been replaced by ParamData.to_json() and ParamData.from_json().

Removed

• Parameter primitive classes have been replaced by the new timestamp tracking.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.12.0

Added

• If Pydantic is installed, parameter data classes automatically have Pydantic type validation enabled.
• Parameter primitives classes ParamInt, ParamFloat, ParamBool, ParamStr, and ParamNone.
• Parameter file classes ParamFile and ParamDataFrame.

Changed

• All ParamData objects now internally track the latest time that they or any of their children were last updated, which is returned by ParamData.last_updated.
• Param and Struct are combined into a single class ParamDataclass.

- Python
Published by alexhad6 over 1 year ago

paramdb - v0.11.0

Added

• ParamDB.load_commit_entry() loads a commit entry by ID or the most recent commit.
• ParamDB.commit_history_with_data() to retrieve the commit history with data.
• CommitEntryWithData to store a commit entry containing data.

Changed

• ParamDB.commit() returns a CommitEntry instead of the commit ID.

Removed

• ParamDB.latest_commit is replaced by ParamDB.load_commit_entry()

- Python
Published by alexhad6 almost 2 years ago

paramdb - v0.10.2

Changed

• Change supported Python versions from >=3.9,<3.13 to ^3.9 for better compatibility with other Poetry projects and future versions of Python.

- Python
Published by alexhad6 about 2 years ago

paramdb - v0.10.1

Added

• Support for Python 3.12

- Python
Published by alexhad6 about 2 years ago

paramdb - v0.10.0

Added

• Support for Python 3.9

Removed

• Parameter dataclass bases (Param and Struct) no longer set kw_only to True by default (since this feature does not exist in Python 3.9).

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.9.1

Changed

• Custom ParamData subclasses have an improved error message if extra keyword arguments are passed.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.9.0

Added

• ParamDB.path to retrieve the database path.
• ParamDB.latest_commit to retrieve the latest commit entry.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.8.0

Changed

• Documentation website moved to Read the Docs.

Added

• Badges for latest PyPI version, license, CI status, Codecov, and docs website build.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.7.0

Changed

• ParamDB.commit() returns the ID of the newly created commit.
• ParamDB.load() converts datetime objects to local time regardless of the timezone stored internally in the database.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.6.0

Added

• ParamDB.dispose() function for cases where it is required to fully clean up the database before the program ends, such as in testing suites.

Changed

• Commits get the current time in a way that can be mocked in tests where we want to control the time.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.5.0

Changed

• datetime objects (currently used in CommitEntry.timestamp and ParamData.last_updated) are timezone-aware.
• If ParamDB load_classes parameter is False, datetime and Astropy Quantity objects are not loaded either.

- Python
Published by alexhad6 over 2 years ago

paramdb - v0.4.0

Added

• ParamDB load_classes parameter can be set to False to load parameter data classes as dictionaries (created to allow ParamView to access data)
• Keys for special properties in dictionary representations of parameter data can be imported
• ParamDict returns keys in __dir__() so that they are suggested by interactive prompts like IPython.

Changed

• ParamDict uses dictkeys, dictvalues, and dict_items instead of default KeysView, ValuesView, and ItemsView since they print nicely

- Python
Published by alexhad6 almost 3 years ago

paramdb - v0.3.0

Added

• Ability to specify start and end indices in ParamDB.commit_history()
• Support for scalar astropy.units.Quantity objects
• Parameter dataclass bases (Param and Struct) automatically convert subclasses into dataclasses kw_only as True by default

Changed

• ParamDict can be initialized from keyword arguments in addition to dictionaries

- Python
Published by alexhad6 almost 3 years ago

paramdb - v0.2.0

Added

• Ability to specify commit ID in ParamDB.load()
• ParamData.parent and ParamData.root properties
• Mixins ParentType[PT] and RootType[PT] to type cast parent and root
• Parameter collection classes ParamList and ParamDict
• Database now ignores dataclass fields where init is False

Removed

• CommitNotFoundError (replaced with built-in IndexError)
• Private _last_updated dataclass field in parameter dataclasses

- Python
Published by alexhad6 almost 3 years ago

paramdb - v0.1.0

Added

• Parameter data base class ParamData
• Parameter dataclass bases (Param and Struct)
• Database class ParamDB to store parameters in a SQLite file
• Ability to retrieve the commit history as CommitEntry objects

- Python
Published by alexhad6 almost 3 years ago