[feat, refactor] refactor dtype map to use Enum DTypes. Implemented constrained dataset. Datastore.model_dump_hdf5 default mode changed to "w".

Author: yhteoh

examples/custom_group.ipynb

@@ -11,7 +11,7 @@
     "import numpy as np\n",
     "from rich.pretty import pprint\n",
     "\n",
-    "from oqd_dataschema.base import Dataset, GroupBase, GroupRegistry\n",
+    "from oqd_dataschema.base import Dataset, GroupBase, GroupRegistry, condataset\n",
     "from oqd_dataschema.datastore import Datastore\n",
     "from oqd_dataschema.groups import (\n",
     "    SinaraRawDataGroup,\n",
@@ -29,7 +29,7 @@
     "    Here we define a custom Group, which is automatically added at runtime to the GroupRegistry.\n",
     "    \"\"\"\n",
     "\n",
-    "    array: Dataset"
+    "    array: condataset(shape_constraint=(None, 10))  # type: ignore"
    ]
   },
   {
@@ -119,7 +119,8 @@
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   │   </span><span style=\"font-weight: bold\">)</span>,\n",
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   │   </span><span style=\"color: #808000; text-decoration-color: #808000\">class_</span>=<span style=\"color: #008000; text-decoration-color: #008000\">'YourCustomGroup'</span>\n",
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   </span><span style=\"font-weight: bold\">)</span>\n",
-       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"font-weight: bold\">}</span>\n",
+       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"font-weight: bold\">}</span>,\n",
+       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"color: #808000; text-decoration-color: #808000\">attrs</span>=<span style=\"font-weight: bold\">{}</span>\n",
        "<span style=\"font-weight: bold\">)</span>\n",
        "</pre>\n"
       ],
@@ -164,7 +165,8 @@
        "\u001b[2;32m│   │   │   \u001b[0m\u001b[1m)\u001b[0m,\n",
        "\u001b[2;32m│   │   │   \u001b[0m\u001b[33mclass_\u001b[0m=\u001b[32m'YourCustomGroup'\u001b[0m\n",
        "\u001b[2;32m│   │   \u001b[0m\u001b[1m)\u001b[0m\n",
-       "\u001b[2;32m│   \u001b[0m\u001b[1m}\u001b[0m\n",
+       "\u001b[2;32m│   \u001b[0m\u001b[1m}\u001b[0m,\n",
+       "\u001b[2;32m│   \u001b[0m\u001b[33mattrs\u001b[0m=\u001b[1m{\u001b[0m\u001b[1m}\u001b[0m\n",
        "\u001b[1m)\u001b[0m\n"
       ]
      },
@@ -230,7 +232,8 @@
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   │   </span><span style=\"font-weight: bold\">)</span>,\n",
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   │   </span><span style=\"color: #808000; text-decoration-color: #808000\">class_</span>=<span style=\"color: #008000; text-decoration-color: #008000\">'YourCustomGroup'</span>\n",
        "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   │   </span><span style=\"font-weight: bold\">)</span>\n",
-       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"font-weight: bold\">}</span>\n",
+       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"font-weight: bold\">}</span>,\n",
+       "<span style=\"color: #7fbf7f; text-decoration-color: #7fbf7f\">│   </span><span style=\"color: #808000; text-decoration-color: #808000\">attrs</span>=<span style=\"font-weight: bold\">{}</span>\n",
        "<span style=\"font-weight: bold\">)</span>\n",
        "</pre>\n"
       ],
@@ -275,7 +278,8 @@
        "\u001b[2;32m│   │   │   \u001b[0m\u001b[1m)\u001b[0m,\n",
        "\u001b[2;32m│   │   │   \u001b[0m\u001b[33mclass_\u001b[0m=\u001b[32m'YourCustomGroup'\u001b[0m\n",
        "\u001b[2;32m│   │   \u001b[0m\u001b[1m)\u001b[0m\n",
-       "\u001b[2;32m│   \u001b[0m\u001b[1m}\u001b[0m\n",
+       "\u001b[2;32m│   \u001b[0m\u001b[1m}\u001b[0m,\n",
+       "\u001b[2;32m│   \u001b[0m\u001b[33mattrs\u001b[0m=\u001b[1m{\u001b[0m\u001b[1m}\u001b[0m\n",
        "\u001b[1m)\u001b[0m\n"
       ]
      },
@@ -287,13 +291,6 @@
     "parse = Datastore.model_validate_hdf5(filepath)\n",
     "pprint(parse)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

pyproject.toml

@@ -26,11 +26,7 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
 ]
 
-dependencies = [
-    "bidict>=0.23.1",
-    "h5py>=3.13.0",
-    "pydantic>=2.10.6",
-]
+dependencies = ["h5py>=3.14.0", "pydantic>=2.10.6"]
 
 [project.optional-dependencies]
 docs = [
@@ -52,12 +48,7 @@ select = ["E4", "E7", "E9", "F", "I"]
 fixable = ["ALL"]
 
 [dependency-groups]
-dev = [
-    "jupyter>=1.1.1",
-    "pre-commit>=4.1.0",
-    "rich>=14.1.0",
-    "ruff>=0.13.1",
-]
+dev = ["jupyter>=1.1.1", "pre-commit>=4.1.0", "rich>=14.1.0", "ruff>=0.13.1"]
 
 
 [project.urls]

src/oqd_dataschema/__init__.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .base import Dataset, GroupBase, GroupRegistry
+from .base import Dataset, GroupBase, GroupRegistry, condataset
 from .datastore import Datastore
 from .groups import (
     ExpectationValueDataGroup,
@@ -32,4 +32,5 @@
     "MeasurementOutcomesDataGroup",
     "OQDTestbenchDataGroup",
     "SinaraRawDataGroup",
+    "condataset",
 ]