Pydantic 2.x compatibility (#106)

docs/release.rst

@@ -3,6 +3,22 @@ Release Notes
 
 The full list of releases can be found in the GitHub repository's `releases page <https://github.com/fsoubelet/PyhDToolkit/releases>`_.
 
+Version 1.4.0
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    releases/v1.4.0
+
+Version 1.3.2
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    releases/v1.3.2
+
 Version 1.3.1
 -------------
 

docs/releases/v1.3.2.rst

@@ -0,0 +1,14 @@
+.. _release_1.4.0:
+
+1.4.0
+-----
+
+Release `1.4.0`` is a small compatibility release with `pydantic v2.x`.
+
+Maintenance
+~~~~~~~~~~~
+
+* The version requirement on `pydantic` has been updated to `>=2.0`.
+* Carious places in the `PyhDToolkit` codebase have been updated to be compatible with `pydantic v2.x`.
+
+See `v1.4.0 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.4.0>`_ and the `full changes since v1.3.2 <https://github.com/fsoubelet/PyhDToolkit/compare/1.3.2...1.4.0>`_.

docs/releases/v1.4.0.rst

@@ -0,0 +1,13 @@
+.. _release_1.3.1:
+
+1.3.2
+-----
+
+Release `1.3.2` is a small compatibility release.
+
+Maintenance
+~~~~~~~~~~~
+
+* The version requirement on `pydantic` has been constrained to `>=1.0,<2.0` to guarantee code bases compatibility.
+
+See `v1.3.2 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.3.2>`_ and the `full changes since v1.3.1 <https://github.com/fsoubelet/PyhDToolkit/compare/1.3.1...1.3.2>`_.

pyhdtoolkit/models/beam.py

@@ -20,12 +20,12 @@ class BeamParameters(BaseModel):
     One can find a usage example in the :ref:`beam enveloppe demo <demo-beam-enveloppe>`.
     """
 
-    pc_GeV: Optional[float]  # Beam momentum [GeV]
+    pc_GeV: Optional[float] = None  # Beam momentum [GeV]
     E_0_GeV: Optional[float] = 0.9382720813  # Particle rest mass energy [GeV], defaults to that of a proton
     charge: Optional[float] = 1  # Particle charge in [e], defaults to that of a proton
-    en_x_m: Optional[float]  # Horizontal normalized emittance [m]
-    en_y_m: Optional[float]  # Vertical normalized emittance [m]
-    deltap_p: Optional[float]  # Momentum deviation
+    en_x_m: Optional[float] = None  # Horizontal normalized emittance [m]
+    en_y_m: Optional[float] = None  # Vertical normalized emittance [m]
+    deltap_p: Optional[float] = None  # Momentum deviation
 
     @property
     def B_rho_Tm(self) -> float:

pyhdtoolkit/models/htc.py

@@ -9,7 +9,7 @@
 from typing import Union
 
 from pendulum import DateTime
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 
 class BaseSummary(BaseModel):
@@ -47,6 +47,8 @@ class HTCTaskSummary(BaseModel):
 
     Class to encompass and validate a specific job's line in the ``condor_q`` output.
     """
+    # This is so pydantic accepts pendulum.DateTime as a validated type
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
     owner: str
     batch_name: int

pyhdtoolkit/utils/htc_monitor.py

@@ -152,13 +152,13 @@ def _make_cluster_table(owner_name: str, cluster: ClusterSummary) -> Table:
     for i, source in enumerate(["query", "user", "cluster"]):
         table.add_row(
             "Query" if i == 0 else ("All Users" if i == 2 else owner_name),
-            str(cluster.dict()[source]["jobs"]),
-            str(cluster.dict()[source]["completed"]),
-            str(cluster.dict()[source]["running"]),
-            str(cluster.dict()[source]["idle"]),
-            str(cluster.dict()[source]["held"]),
-            str(cluster.dict()[source]["suspended"]),
-            str(cluster.dict()[source]["removed"]),
+            str(cluster.model_dump()[source]["jobs"]),
+            str(cluster.model_dump()[source]["completed"]),
+            str(cluster.model_dump()[source]["running"]),
+            str(cluster.model_dump()[source]["idle"]),
+            str(cluster.model_dump()[source]["held"]),
+            str(cluster.model_dump()[source]["suspended"]),
+            str(cluster.model_dump()[source]["removed"]),
         )
     return table
 

pyhdtoolkit/version.py

@@ -1,4 +1,4 @@
-VERSION = "1.3.2"
+VERSION = "1.4.0"
 
 
 def version_info() -> str:

pyproject.toml

@@ -45,6 +45,7 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: Physics",
@@ -61,7 +62,7 @@ dependencies = [
   "loguru < 1.0",
   "cpymad >= 1.9",
   "rich >= 12.0",
-  "pydantic >= 1.0,<2.0",
+  "pydantic >= 2.0",
   "pendulum >= 2.0",
   "optics-functions >= 0.1",
 ]