Refactor diff_get class to Diffr and enhance type assertion checks; update version to 0.2.0

Author: SoundsSerious

diffgetr/diff_get.py

@@ -7,14 +7,25 @@
 from pprint import pprint
 
 
-class diff_get:
+class Diffr:
 
     def __init__(
         self, s0, s1, loc=None, path=None, deep_diff_kw=None, ignore_added=False
     ):
 
-        assert type(s0) is type(s1), f"bad types!"
-        if isinstance(s0, (tuple, list)) and isinstance(s1, (tuple, list)):
+        #TODO: fail here for type differences
+        st0 = type(s0)
+        st1 = type(s1)
+        if st0 != st1:
+            preview_0 = str(s0)[:100]
+            preview_1 = str(s1)[:100]            
+            raise Exception(f'{loc}.{path}| types different: {st0} vs {st1} |0: {preview_0} | 1:{preview_1}')
+        elif st0 in (str,int,float):
+            preview_0 = str(s0)[:100]
+            preview_1 = str(s1)[:100]            
+            if s0 != s1:
+                raise Exception(f'{loc}.{path}| values different: {preview_0} vs {preview_1}')
+        elif isinstance(s0, (tuple, list)) and isinstance(s1, (tuple, list)):
             print(f"converting lists -> dict")
             s0 = {i: v for i, v in enumerate(s0)}
             s1 = {i: v for i, v in enumerate(s1)}
@@ -39,7 +50,7 @@ def __init__(
 
     def __getitem__(self, key):
         if key in self.s0 and key in self.s1:
-            return diff_get(
+            return Diffr(
                 self.s0[key],
                 self.s1[key],
                 path=key,
@@ -68,7 +79,7 @@ def dict_keys(self)->set:
                 and isinstance(self.s1[k],dict)
                 ))
 
-    def path_diffs(self,syskey:str):
+    def path_diffs(self,syskey:str) -> "Diffr":
         """take sys key like  root.p1.p2.pk[0].*.po[*].val and generate diffs through each matching key. If there is a key prefix'd with path, such as root.p1.p2 be sure to strip that so you can navigate the data.
         """
         if '.' not in syskey and '[' not in syskey:
@@ -107,7 +118,7 @@ def path_diffs(self,syskey:str):
                         for j in range(min(len(array1),len(array2))):
                             v1 = array1[j]
                             v2 = array2[j]
-                            for val in diff_getr(v1,v2).path_diffs(nxt):
+                            for val in Diffrr(v1,v2).path_diffs(nxt):
                                 yield val
 
                     elif key_seg in self.dict_keys():
@@ -327,14 +338,14 @@ def parent_key(key):
                 )
                 if pct is not None and abs(pct) > threshold:
                     if group_print is False:
-                        print(f"\nGROUP: {p}")
+                        print(f"\nGROUP: {self.path}.{p}")
                         group_print = True
                     print(
                         f" >{key:<50} | {v0s:^30} | {v1s:^30} | {diff:>14.4f} |{pct_diff:>10}"
                     )
                 elif pct is None and v0 != v1:
                     if group_print is False:
-                        print(f"\nGROUP: {p}")
+                        print(f"\nGROUP: {self.path}.{p}")
                         group_print = True
                     print(
                         f" >{key:<50} | {v0s:^30} | {v1s:^30} | {'-':^14} | {'-':^10}"
@@ -417,7 +428,7 @@ def main():
     with open(args.file2, "r", encoding="utf-8") as f:
         s1 = json.load(f)
 
-    DIFF = diff_get(s0, s1)
+    DIFF = Diffr(s0, s1)
     keys = args.path.split(".")
     try:
         for key in keys:
@@ -427,7 +438,7 @@ def main():
                 DIFF = DIFF[base]
                 loc = DIFF.loc.copy()
                 loc.append(f"[{idx}]")
-                DIFF = diff_get(DIFF.s0[idx], DIFF.s1[idx], loc=loc)
+                DIFF = Diffr(DIFF.s0[idx], DIFF.s1[idx], loc=loc)
                 continue
             else:
                 DIFF = DIFF[key]

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "diffgetr"
-version = "0.1.1"
+version = "0.2.0"
 description = "A Python library for comparing nested data structures with detailed diff reporting and interactive navigation."
 authors = [
     { name = "Your Name", email = "your.email@example.com" }

tests/test_diff_get.py

@@ -1,7 +1,7 @@
 import unittest
 import json
 import io
-from diffgetr.diff_get import diff_get
+from diffgetr.diff_get import Diffr
 
 
 class TestDiffGet(unittest.TestCase):
@@ -11,7 +11,7 @@ def test_basic_diff(self):
         s0 = {"a": 1, "b": 2, "c": {"d": 3}}
         s1 = {"a": 1, "b": 3, "c": {"d": 4}}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         assert diff.location == "root"
 
         # Test that diff object is created
@@ -23,7 +23,7 @@ def test_navigation(self):
         s0 = {"level1": {"level2": {"value": 10}}}
         s1 = {"level1": {"level2": {"value": 20}}}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         nested_diff = diff['level1']['level2']
 
         assert nested_diff.location == "root.level1.level2"
@@ -35,7 +35,7 @@ def test_list_conversion(self):
         s0 = [1, 2, 3]
         s1 = [1, 2, 4]
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         assert isinstance(diff.s0, dict)
         assert isinstance(diff.s1, dict)
         assert diff.s0[2] == 3
@@ -46,7 +46,7 @@ def test_keys_method(self):
         s0 = {"a": 1, "b": 2, "c": 3}
         s1 = {"a": 1, "b": 3, "d": 4}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         keys = diff.keys()
 
         assert keys == {"a", "b"}
@@ -56,7 +56,7 @@ def test_ignore_added(self):
         s0 = {"a": 1, "b": 2}
         s1 = {"a": 1, "b": 2, "c": 3}
 
-        diff = diff_get(s0, s1, ignore_added=True)
+        diff = Diffr(s0, s1, ignore_added=True)
         diff_obj = diff.diff_obj
 
         # Should not contain dictionary_item_added
@@ -68,19 +68,19 @@ def test_custom_deep_diff_params(self):
         s1 = {"value": 1.123457}
 
         # With default precision (3), should see no difference
-        diff1 = diff_get(s0, s1)
+        diff1 = Diffr(s0, s1)
         assert len(diff1.diff_obj) == 0
 
         # With high precision, should see difference
-        diff2 = diff_get(s0, s1, deep_diff_kw={'significant_digits': 6})
+        diff2 = Diffr(s0, s1, deep_diff_kw={'significant_digits': 6})
         assert len(diff2.diff_obj) > 0
 
     def test_keyerror_handling(self):
         """Test KeyError handling when navigating to non-existent keys"""
         s0 = {"a": {"b": 1}}
         s1 = {"a": {"c": 2}}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
 
         with self.assertRaises(KeyError) as context:
             diff['a']['nonexistent']
@@ -92,7 +92,7 @@ def test_string_representation(self):
         s0 = {"a": 1}
         s1 = {"a": 2}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         str_repr = str(diff)
 
         assert "root diffing summary" in str_repr
@@ -103,7 +103,7 @@ def test_repr(self):
         s0 = {"a": 1}
         s1 = {"a": 2}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         repr_str = repr(diff)
 
         assert repr_str == "diff[root]"
@@ -113,7 +113,7 @@ def test_diff_summary_output(self):
         s0 = {"a": 1, "b": {"c": 2}}
         s1 = {"a": 2, "b": {"c": 3}}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
 
         # Test with StringIO
         output = io.StringIO()
@@ -128,7 +128,7 @@ def test_diff_all_output(self):
         s0 = {"a": 1}
         s1 = {"a": 2}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
 
         # Test with StringIO
         output = io.StringIO()
@@ -140,14 +140,14 @@ def test_diff_all_output(self):
     def test_type_assertion(self):
         """Test that different types raise assertion error"""
         with self.assertRaises(AssertionError):
-            diff_get({"a": 1}, ["a", 1])
+            Diffr({"a": 1}, ["a", 1])
 
     def test_ipython_key_completions(self):
         """Test IPython tab completion support"""
         s0 = {"a": 1, "b": 2, "c": 3}
         s1 = {"a": 1, "b": 3, "d": 4}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         completions = diff._ipython_key_completions_()
 
         assert set(completions) == {"a", "b"}
@@ -158,7 +158,7 @@ class TestCLI(unittest.TestCase):
 
     def test_main_function_exists(self):
         """Test that main function exists and is callable"""
-        from diffgetr.diff_get import main
+        from diffgetr.Diffr import main
         self.assertTrue(callable(main))
 
 
@@ -169,7 +169,7 @@ def test_uuid_pattern_replacement(self):
         s0 = {"id": "550e8400-e29b-41d4-a716-446655440000"}
         s1 = {"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"}
 
-        diff = diff_get(s0, s1)
+        diff = Diffr(s0, s1)
         output = io.StringIO()
         diff.diff_summary(file=output)
         summary = output.getvalue()