adding support to ip addresses

Author: seperman

deepdiff/helper.py

@@ -188,7 +188,7 @@ def get_semvar_as_integer(version):
 only_complex_number = (complex,) + numpy_complex_numbers
 only_numbers = (int, float, complex, Decimal) + numpy_numbers
 datetimes = (datetime.datetime, datetime.date, datetime.timedelta, datetime.time, np_datetime64)
-ipranges = (ipaddress.IPv4Interface, ipaddress.IPv6Interface, ipaddress.IPv4Network, ipaddress.IPv6Network)
+ipranges = (ipaddress.IPv4Interface, ipaddress.IPv6Interface, ipaddress.IPv4Network, ipaddress.IPv6Network, ipaddress.IPv4Address, ipaddress.IPv6Address)
 uuids = (uuid.UUID, )
 times = (datetime.datetime, datetime.time,np_datetime64)
 numbers: Tuple = only_numbers + datetimes

deepdiff/serialization.py

@@ -32,6 +32,7 @@
     pydantic_base_model_type,
     PydanticBaseModel,
     NotPresent,
+    ipranges,
 )
 from deepdiff.model import DeltaResult
 
@@ -114,6 +115,7 @@ class UnsupportedFormatErr(TypeError):
     'OrderedDict': collections.OrderedDict,
     'Pattern': re.Pattern,
     'iprange': str,
+    'IPv4Address': str,
 }
 
 
@@ -612,6 +614,7 @@ def _serialize_tuple(value):
     tuple: _serialize_tuple,
     Mapping: dict,
     NotPresent: str,
+    ipranges: str,
 }
 
 if PydanticBaseModel is not pydantic_base_model_type:

tests/test_diff_other.py

@@ -12,6 +12,7 @@
     PURGE_LEVEL_RANGE_MSG)
 from concurrent.futures.process import ProcessPoolExecutor
 from concurrent.futures import as_completed
+from ipaddress import IPv4Address
 
 # Only the prep part of DeepHash. We don't need to test the actual hash function.
 DeepHashPrep = partial(DeepHash, apply_hash=False)
@@ -200,3 +201,9 @@ def test_multi_processing3_deephash(self):
             for future in as_completed(futures, timeout=10):
                 assert not future._exception
                 assert expected_result == future._result
+
+    def test_ip_address_diff(self):
+        ip1 = IPv4Address("128.0.0.1")
+        ip2 = IPv4Address("128.0.0.2")
+        diff = DeepDiff(ip1, ip2)
+        assert {'values_changed': {'root': {'new_value': IPv4Address('128.0.0.2'), 'old_value': IPv4Address('128.0.0.1')}}} == diff

tests/test_serialization.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+from ipaddress import IPv4Address
 import os
 import json
 import sys
@@ -9,6 +10,7 @@
 from pickle import UnpicklingError
 from decimal import Decimal
 from collections import Counter
+from pydantic import BaseModel, IPvAnyAddress
 from deepdiff import DeepDiff
 from deepdiff.helper import pypy3, py_current_version, np_ndarray, Opcode, SetOrdered
 from deepdiff.serialization import (
@@ -25,6 +27,11 @@
 t2 = {1: 1, 2: 2, 3: 3, 4: {"a": "hello", "b": "world\n\n\nEnd"}}
 
 
+class SampleSchema(BaseModel):
+    works: bool = False
+    ips: list[IPvAnyAddress]
+
+
 class SomeStats(NamedTuple):
     counter: Optional[Counter]
     context_aware_counter: Optional[Counter] = None
@@ -115,6 +122,16 @@ def test_to_dict_at_different_verbose_level(self, verbose_level, expected):
         ddiff = DeepDiff(t1, t2, verbose_level=verbose_level)
         assert expected == ddiff.to_dict()
 
+    def test_serialize_pydantic_model(self):
+        obj = SampleSchema(
+            works=True,
+            ips=["128.0.0.1"]
+        )
+        serialized = json_dumps(obj)
+        obj_again = json_loads(serialized)
+        assert {'works': True, 'ips': ['128.0.0.1']} == obj_again
+        assert {'works': True, 'ips': [IPv4Address('128.0.0.1')]} == obj.model_dump()
+
 
 @pytest.mark.skipif(pypy3, reason='clevercsv is not supported in pypy3')
 class TestLoadContet: