[DPE-7309] Switch to Pydantic 2 and data_models v1 (#902)

* Switch to pydantic 2

* Apply suggestions from code review

Co-authored-by: Marcelo Henrique Neppel <[email protected]>

* Add optimizer_cpu_tuple_cost constraints

* Remove JujuVersion warning

* Sync to dpl repo

---------

Co-authored-by: Marcelo Henrique Neppel <[email protected]>

Author: dragomirp

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 coverage.xml
 requirements.txt
 requirements-last-build.txt
+.last_refresh_unit_status.json
 
 # PyCharm project folder.
 .idea/

lib/charms/data_platform_libs/v0/data_models.py renamed to lib/charms/data_platform_libs/v1/data_models.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@
 
 ```python
 
-from charms.data_platform_libs.v0.data_models import BaseConfigModel
+from charms.data_platform_libs.v1.data_models import BaseConfigModel
 
 class MyConfig(BaseConfigModel):
 
@@ -164,20 +164,27 @@ class MergedDataBag(ProviderDataBag, RequirerDataBag):
 LIBID = "cb2094c5b07d47e1bf346aaee0fcfcfe"
 
 # Increment this major API version when introducing breaking changes
-LIBAPI = 0
+LIBAPI = 1
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 5
+LIBPATCH = 0
 
-PYDEPS = ["ops>=2.0.0", "pydantic>=1.10,<2"]
+PYDEPS = ["ops>=2.0.0", "pydantic>=2,<3"]
 
 G = TypeVar("G")
 T = TypeVar("T", bound=BaseModel)
 AppModel = TypeVar("AppModel", bound=BaseModel)
 UnitModel = TypeVar("UnitModel", bound=BaseModel)
 
-DataBagNativeTypes = (int, str, float)
+DataBagNativeTypes = (
+    int,
+    str,
+    float,
+    Optional[int],
+    Optional[str],
+    Optional[float],
+)
 
 
 class BaseConfigModel(BaseModel):
@@ -233,7 +240,7 @@ def write(relation_data: RelationDataContent, model: BaseModel):
         relation_data: pointer to the relation databag
         model: instance of pydantic model to be written
     """
-    for key, value in model.dict(exclude_none=False).items():
+    for key, value in model.model_dump(exclude_none=False).items():
         if value:
             relation_data[key.replace("_", "-")] = (
                 str(value)
@@ -255,10 +262,10 @@ def read(relation_data: MutableMapping[str, str], obj: Type[T]) -> T:
         **{
             field_name: (
                 relation_data[parsed_key]
-                if field.outer_type_ in DataBagNativeTypes
+                if field_info.annotation in DataBagNativeTypes
                 else json.loads(relation_data[parsed_key])
             )
-            for field_name, field in obj.__fields__.items()
+            for field_name, field_info in obj.model_fields.items()
             # pyright: ignore[reportGeneralTypeIssues]
             if (parsed_key := field_name.replace("_", "-")) in relation_data
             if relation_data[parsed_key]

poetry.lock

@@ -13,7 +13,7 @@ pgconnstr = "^1.0.1"
 requests = "^2.32.3"
 tenacity = "^9.1.2"
 psycopg2 = "^2.9.10"
-pydantic = "^1.10.22"
+pydantic = "^2.11.4"
 jinja2 = "^3.1.6"
 pysyncobj = "^0.3.14"
 psutil = "^7.0.0"
@@ -23,7 +23,7 @@ charm-refresh = "^3.0.0.1"
 # data_platform_libs/v0/data_interfaces.py
 ops = ">=2.0.0"
 # data_platform_libs/v0/data_models.py
-pydantic = "^1.10"
+pydantic = "*"
 # grafana_agent/v0/cos_agent.py
 cosl = ">=0.0.50"
 # tls_certificates_interface/v2/tls_certificates.py

pyproject.toml

@@ -26,7 +26,7 @@
 import psycopg2
 import tomli
 from charms.data_platform_libs.v0.data_interfaces import DataPeerData, DataPeerUnitData
-from charms.data_platform_libs.v0.data_models import TypedCharmBase
+from charms.data_platform_libs.v1.data_models import TypedCharmBase
 from charms.grafana_agent.v0.cos_agent import COSAgentProvider, charm_tracing_config
 from charms.operator_libs_linux.v2 import snap
 from charms.postgresql_k8s.v0.postgresql import (
@@ -43,7 +43,7 @@
 from charms.postgresql_k8s.v0.postgresql_tls import PostgreSQLTLS
 from charms.rolling_ops.v0.rollingops import RollingOpsManager, RunWithLock
 from charms.tempo_coordinator_k8s.v0.charm_tracing import trace_charm
-from ops import JujuVersion, main
+from ops import main
 from ops.charm import (
     ActionEvent,
     HookEvent,
@@ -261,8 +261,7 @@ def __init__(self, *args):
             deleted_label=SECRET_DELETED_LABEL,
         )
 
-        juju_version = JujuVersion.from_environ()
-        run_cmd = "/usr/bin/juju-exec" if juju_version.major > 2 else "/usr/bin/juju-run"
+        run_cmd = "/usr/bin/juju-exec"
         self._observer = ClusterTopologyObserver(self, run_cmd)
         self._rotate_logs = RotateLogs(self)
         self.framework.observe(self.on.cluster_topology_change, self._on_cluster_topology_change)