Merge pull request #185 from PainterQubits/develop

Merge develop

.github/dependabot.yml

@@ -4,10 +4,7 @@ updates:
     directory: "/"
     target-branch: "develop"
     schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "04:00"
-      timezone: "America/Los_Angeles"
+      interval: "monthly"
     groups:
       github-actions:
         patterns: ["*"]
@@ -16,10 +13,7 @@ updates:
     directory: "/"
     target-branch: "develop"
     schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "04:00"
-      timezone: "America/Los_Angeles"
+      interval: "monthly"
     groups:
       python:
         update-types: ["minor", "patch"]

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ on:
       - develop
 
 env:
-  POETRY_VERSION: "1.7.1"
+  POETRY_VERSION: "1.8.3"
   MAIN_PYTHON_VERSION: "3.9"
   PACKAGE_NAME: "paramdb"
 

.github/workflows/publish.yml

@@ -5,7 +5,7 @@ on:
     types: [published]
 
 env:
-  POETRY_VERSION: "1.7.1"
+  POETRY_VERSION: "1.8.3"
 
 jobs:
   build:

.readthedocs.yaml

@@ -6,11 +6,11 @@ build:
     python: "3.10"
   jobs:
     post_create_environment:
-      - pip install poetry==1.6.1
-      - poetry config virtualenvs.create false
+      - pip install poetry==1.8.2
     post_install:
-      - poetry install --without dev
-      - poetry run python -m ipykernel install --user
+      # See https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --all-extras --without dev
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry run python -m ipykernel install --user
 
 sphinx:
   configuration: docs/conf.py

CHANGELOG.md

@@ -7,6 +7,20 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### 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`.
+
 ## [0.11.0] (Jan 31 2024)
 
 ### Added

README.md

@@ -1,12 +1,16 @@
 # ParamDB
 
+<!-- start badges -->
+
 [![PyPI Latest Release](https://img.shields.io/pypi/v/paramdb)](https://pypi.org/project/paramdb/)
 [![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramdb)](https://pypi.org/project/paramdb/)
 [![License](https://img.shields.io/pypi/l/paramdb)](https://github.com/PainterQubits/paramdb/blob/main/LICENSE)
 [![CI](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/github/PainterQubits/paramdb/branch/main/graph/badge.svg?token=PQEJWLBTBK)](https://codecov.io/github/PainterQubits/paramdb)
 [![Documentation Status](https://readthedocs.org/projects/paramdb/badge/?version=stable)](https://paramdb.readthedocs.io/en/stable/?badge=stable)
 
+<!-- end badges -->
+
 <!-- start intro -->
 
 Python package for storing and retrieving experiment parameters.

docs/api-reference.md

@@ -10,12 +10,22 @@ All of the following can be imported from `paramdb`.
 
 ```{eval-rst}
 .. autoclass:: ParamData
-.. autoclass:: Param
-.. autoclass:: Struct
+.. autoclass:: ParamInt
+.. autoclass:: ParamFloat
+.. autoclass:: ParamBool
+.. autoclass:: ParamStr
+.. autoclass:: ParamNone
+.. autoclass:: ParamDataclass
+.. autoclass:: ParamFile
+.. autoclass:: ParamDataFrame
 .. autoclass:: ParamList
+   :no-members:
 .. autoclass:: ParamDict
+   :no-members:
 .. autoclass:: ParentType
+   :no-members:
 .. autoclass:: RootType
+   :no-members:
 ```
 
 ## Database
@@ -26,19 +36,13 @@ All of the following can be imported from `paramdb`.
 .. autoclass:: CommitEntryWithData
 ```
 
-## Keys
-
 <!--
-Changing the current module to paramdb._keys is necessary in order to show the correct
-docstrings.
+Changing the current module to paramdb._database is necessary in order to show the correct
+docstring.
 -->
 
-```{py:currentmodule} paramdb._keys
-
-```
-
 ```{eval-rst}
+.. py:currentmodule:: paramdb._database
 .. autodata:: CLASS_NAME_KEY
-.. autodata:: PARAMLIST_ITEMS_KEY
-.. autodata:: LAST_UPDATED_KEY
+.. py:currentmodule:: paramdb
 ```

docs/conf.py

@@ -25,7 +25,11 @@
 # Autodoc options
 # See https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
 autodoc_default_options = {"members": True, "member-order": "bysource"}
-autodoc_inherit_docstrings = False
+autodoc_type_aliases = {
+    "ConvertibleToInt": "ConvertibleToInt",
+    "ConvertibleToFloat": "ConvertibleToFloat",
+}
+# autodoc_inherit_docstrings = False
 add_module_names = False
 
 

docs/database.md

@@ -23,12 +23,12 @@ the root data type in order for its methods (e.g. {py:meth}`ParamDB.commit`) wor
 with type checking. For example:
 
 ```{jupyter-execute}
-from paramdb import Struct, Param, ParamDB
+from paramdb import ParamDataclass, ParamDB
 
-class Root(Struct):
+class Root(ParamDataclass):
     param: CustomParam
 
-class CustomParam(Param):
+class CustomParam(ParamDataclass):
     value: float
 
 param_db = ParamDB[Root]("path/to/param.db")

docs/index.md

@@ -1,5 +1,10 @@
 # ParamDB
 
+```{include} ../README.md
+:start-after: <!-- start badges -->
+:end-before: <!-- end badges -->
+```
+
 ```{include} ../README.md
 :start-after: <!-- start intro -->
 :end-before: <!-- end intro -->