feat: BI-6610 add dl_pydantic model diff (#1265)

Author: ovsds

lib/dl_pydantic/dl_pydantic/base.py

@@ -1,11 +1,23 @@
+import deepdiff
 import pydantic
+from typing_extensions import Self
 
 
 class BaseModel(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(
         populate_by_name=True,
     )
 
+    def model_deepdiff(self, other: Self, exclude_paths: list[str] | None = None) -> deepdiff.DeepDiff:
+        exclude_paths = exclude_paths or []
+
+        return deepdiff.DeepDiff(
+            self,
+            other,
+            ignore_order=True,
+            exclude_paths=exclude_paths,
+        )
+
 
 __all__ = [
     "BaseModel",

lib/dl_pydantic/dl_pydantic_tests/unit/test_base.py

@@ -0,0 +1,33 @@
+import dl_pydantic
+
+
+def test_model_diff() -> None:
+    class Model(dl_pydantic.BaseModel):
+        a: int
+        b: int
+
+    model_a = Model(a=1, b=2)
+    model_b = Model(a=1, b=3)
+
+    diff = model_a.model_deepdiff(model_b)
+    assert diff == {"values_changed": {"root.b": {"new_value": 3, "old_value": 2}}}
+
+    diff = model_a.model_deepdiff(model_a, exclude_paths=["b"])
+    assert diff == {}
+
+
+def test_model_diff_with_nested_model() -> None:
+    class Model(dl_pydantic.BaseModel):
+        class Nested(dl_pydantic.BaseModel):
+            c: int
+            d: int
+
+        a: int
+        b: int
+        nested: Nested
+
+    model_a = Model(a=1, b=2, nested=Model.Nested(c=3, d=4))
+    model_b = Model(a=1, b=2, nested=Model.Nested(c=3, d=5))
+
+    diff = model_a.model_deepdiff(model_b)
+    assert diff == {"values_changed": {"root.nested.d": {"new_value": 5, "old_value": 4}}}

lib/dl_pydantic/pyproject.toml

@@ -8,6 +8,7 @@ readme = "README.md"
 version = "0.0.1"
 
 [tool.poetry.dependencies]
+deepdiff = "*"
 pydantic = "*"
 python = ">=3.10, <3.13"
 typing-extensions = "*"

metapkg/poetry.lock

@@ -27,6 +27,7 @@ cffi = "==1.16.0"
 ciso8601 = "==2.2.0"
 clickhouse-driver = "==0.2.6"
 cryptography = "==43.0.1"
+deepdiff = "==8.6.1"
 dill = "==0.3.6"
 faust-cchardet = ">=2.1.19"
 flask = "==2.2.5"

metapkg/pyproject.toml

@@ -85,6 +85,12 @@ tasks:
       vars:
         - VENV_PATH
 
+  poetry:
+    desc: Run poetry command
+    dir: "{{.USER_WORKING_DIR}}"
+    cmds:
+      - poetry --directory={{.PYPROJECT_TOML_PATH}} {{.CLI_ARGS}}
+
   venv-python:
     desc: Run poetry command
     dir: "{{.USER_WORKING_DIR}}"