dealing with enums and py 3.11

Author: seperman

deepdiff/diff.py

@@ -7,6 +7,7 @@
 # However the docstring expects it in a specific order in order to pass!
 import difflib
 import logging
+from enum import Enum
 from copy import deepcopy
 from math import isclose as is_close
 from collections.abc import Mapping, Iterable
@@ -21,7 +22,7 @@
                              number_to_string, datetime_normalize, KEY_TO_VAL_STR, booleans,
                              np_ndarray, get_numpy_ndarray_rows, OrderedSetPlus, RepeatedTimer,
                              TEXT_VIEW, TREE_VIEW, DELTA_VIEW, detailed__dict__,
-                             np, get_truncate_datetime, dict_, CannotCompare)
+                             np, get_truncate_datetime, dict_, CannotCompare, ENUM_IGNORE_KEYS)
 from deepdiff.serialization import SerializationMixin
 from deepdiff.distance import DistanceMixin
 from deepdiff.model import (
@@ -388,8 +389,19 @@ def unmangle(attribute):
 
         return {i: getattr(object, unmangle(i)) for i in all_slots}
 
-    def _diff_obj(self, level, parents_ids=frozenset(),
-                  is_namedtuple=False):
+    def _diff_enum(self, level, parents_ids=frozenset()):
+        t1 = detailed__dict__(level.t1, ignore_private_variables=self.ignore_private_variables, ignore_keys=ENUM_IGNORE_KEYS)
+        t2 = detailed__dict__(level.t2, ignore_private_variables=self.ignore_private_variables, ignore_keys=ENUM_IGNORE_KEYS)
+
+        self._diff_dict(
+            level,
+            parents_ids,
+            print_as_attribute=True,
+            override=True,
+            override_t1=t1,
+            override_t2=t2)
+
+    def _diff_obj(self, level, parents_ids=frozenset(), is_namedtuple=False):
         """Difference of 2 objects"""
         try:
             if is_namedtuple:
@@ -1356,6 +1368,9 @@ def _diff(self, level, parents_ids=frozenset(), _original_type=None):
         elif isinstance(level.t1, Iterable):
             self._diff_iterable(level, parents_ids, _original_type=_original_type)
 
+        elif isinstance(level.t1, Enum):
+            self._diff_enum(level, parents_ids)
+
         else:
             self._diff_obj(level, parents_ids)
 

deepdiff/helper.py

@@ -123,6 +123,8 @@ class np_type:
 TEXT_VIEW = 'text'
 DELTA_VIEW = '_delta'
 
+ENUM_IGNORE_KEYS = frozenset(['_name_', '_value_', '_sort_order_'])
+
 
 def short_repr(item, max_length=15):
     """Short representation of item if it is too long"""
@@ -584,21 +586,27 @@ def get_homogeneous_numpy_compatible_type_of_seq(seq):
         return False
 
 
-def detailed__dict__(obj, ignore_private_variables=True):
+def detailed__dict__(obj, ignore_private_variables=True, ignore_keys=frozenset()):
     """
     Get the detailed dictionary of an object.
 
     This is used so we retrieve object properties too.
     """
     result = obj.__dict__.copy()  # A shallow copy
     private_var_prefix = f"_{obj.__class__.__name__}__"  # The semi private variables in Python get this prefix
+    for key in ignore_keys:
+        if key in result or (
+            ignore_private_variables and key.startswith('__') and not key.startswith(private_var_prefix)
+        ):
+            del result[key]
     for key in dir(obj):
-        if key not in result and (
+        if key not in result and key not in ignore_keys and (
                 not ignore_private_variables or (
                     ignore_private_variables and not key.startswith('__') and not key.startswith(private_var_prefix)
                 )
         ):
             value = getattr(obj, key)
             if not callable(value):
+                print(f"{key}: {value}")
                 result[key] = value
     return result

requirements-cli.txt

@@ -1,4 +1,4 @@
-click==8.0.3
-pyyaml==5.4.1
+click==8.1.3
+pyyaml==6.0
 toml==0.10.2
-clevercsv==0.7.1
+clevercsv==0.7.4

requirements-dev.txt

@@ -2,14 +2,14 @@ wheel==0.37.0
 -r requirements.txt
 -r requirements-cli.txt
 bump2version==1.0.1
-jsonpickle==2.0.0
-coverage==6.0.2
+jsonpickle==2.2.0
+coverage==6.4.3
 ipdb==0.13.9
-numpy==1.21.2
-pytest==6.2.5
+numpy==1.23.1
+pytest==7.1.2
 pytest-cov==3.0.0
-python-dotenv==0.19.1
-watchdog==2.1.6
-Sphinx==4.2.0
+python-dotenv==0.20.0
+watchdog==2.1.9
+Sphinx==5.1.1
 sphinx-sitemap==2.2.0
-flake8==4.0.1
+flake8==5.0.4

tests/test_diff_text.py

@@ -3,7 +3,7 @@
 import pytest
 import logging
 import uuid
-import numpy as np
+from enum import Enum
 from decimal import Decimal
 from deepdiff import DeepDiff
 from deepdiff.helper import pypy3
@@ -550,7 +550,6 @@ def test_named_tuples(self):
         assert result == ddiff
 
     def test_enums(self):
-        from enum import Enum
 
         class MyEnum(Enum):
             A = 1
@@ -563,14 +562,6 @@ class MyEnum(Enum):
         ddiff = DeepDiff(MyEnum.A, MyEnum.B)
         result = {
             'values_changed': {
-                'root._name_': {
-                    'old_value': 'A',
-                    'new_value': 'B'
-                },
-                'root._value_': {
-                    'old_value': 1,
-                    'new_value': 2
-                },
                 'root.name': {
                     'old_value': 'A',
                     'new_value': 'B'

tests/test_hash.py

@@ -8,8 +8,9 @@
 from enum import Enum
 from deepdiff import DeepHash
 from deepdiff.deephash import (
-    prepare_string_for_hashing, unprocessed, UNPROCESSED_KEY, BoolObj, HASH_LOOKUP_ERR_MSG, combine_hashes_lists)
-from deepdiff.helper import pypy3, get_id, number_to_string, np
+    prepare_string_for_hashing, unprocessed,
+    UNPROCESSED_KEY, BoolObj, HASH_LOOKUP_ERR_MSG, combine_hashes_lists)
+from deepdiff.helper import pypy3, get_id, number_to_string, np, py_current_version
 from tests import CustomClass2
 
 logging.disable(logging.CRITICAL)
@@ -261,12 +262,15 @@ def test_named_tuples(self):
             }
             assert expected_result == result
 
-    def test_enum(self):
+    def test_hash_enum(self):
         class MyEnum(Enum):
             A = 1
             B = 2
 
-        assert DeepHashPrep(MyEnum.A)[MyEnum.A] == r'objMyEnum:{str:_name_:str:A;str:_value_:int:1}'
+        if py_current_version >= 3.11:
+            assert DeepHashPrep(MyEnum.A)[MyEnum.A] == r'objMyEnum:{str:_name_:str:A;str:_sort_order_:int:0;str:_value_:int:1}'
+        else:
+            assert DeepHashPrep(MyEnum.A)[MyEnum.A] == r'objMyEnum:{str:_name_:str:A;str:_value_:int:1}'
         assert DeepHashPrep(MyEnum.A) == DeepHashPrep(MyEnum(1))
         assert DeepHashPrep(MyEnum.A) != DeepHashPrep(MyEnum.A.name)
         assert DeepHashPrep(MyEnum.A) != DeepHashPrep(MyEnum.A.value)

tests/test_helper.py

@@ -2,15 +2,22 @@
 import pytest
 import datetime
 import numpy as np
+from enum import Enum
 from decimal import Decimal
 from deepdiff.helper import (
     short_repr, number_to_string, get_numpy_ndarray_rows,
     cartesian_product_of_shape, literal_eval_extended,
     not_found, OrderedSetPlus, diff_numpy_array, cartesian_product_numpy,
-    get_truncate_datetime, datetime_normalize
+    get_truncate_datetime, datetime_normalize,
+    detailed__dict__, ENUM_IGNORE_KEYS,
 )
 
 
+class MyEnum(Enum):
+    A = 1
+    B = 2
+
+
 class TestHelper:
     """Helper Tests."""
 
@@ -140,3 +147,14 @@ def test_get_truncate_datetime(self):
     def test_datetime_normalize(self, truncate_datetime, obj, expected):
         result = datetime_normalize(truncate_datetime, obj)
         assert expected == result
+
+    @pytest.mark.parametrize('obj, ignore_keys, expected', [
+        (
+            MyEnum.A,
+            ENUM_IGNORE_KEYS,
+            {'__objclass__': MyEnum, 'name': 'A', 'value': 1},
+        )
+    ])
+    def test_detailed__dict__(self, obj, ignore_keys, expected):
+        result = detailed__dict__(obj, ignore_private_variables=True, ignore_keys=ignore_keys)
+        assert expected == result, f"test_detailed__dict__ failed for {obj}"