Merge pull request #314 from seperman/dev

5.8.1

Author: seperman

README.md

@@ -1,4 +1,4 @@
-# DeepDiff v 5.8.0
+# DeepDiff v 5.8.1
 
 ![Downloads](https://img.shields.io/pypi/dm/deepdiff.svg?style=flat)
 ![Python Versions](https://img.shields.io/pypi/pyversions/deepdiff.svg?style=flat)
@@ -14,10 +14,16 @@
 
 Tested on Python 3.6+ and PyPy3.
 
-- **[Documentation](https://zepworks.com/deepdiff/5.8.0/)**
+- **[Documentation](https://zepworks.com/deepdiff/5.8.1/)**
 
 ## What is new?
 
+DeepDiff 5-8-1 includes bug fixes:
+- Fixed test suite for 32bit systems (https://github.com/seperman/deepdiff/issues/302) by [Louis-Philippe Véronneau](https://github.com/baldurmen)
+- Fixed the issue when using `ignore_order=True` and `group_by` simultaneously
+- Added the support for diffing object properties (`@property`) (https://github.com/seperman/deepdiff/issues/312)
+- Better support of diffing private variables
+
 DeepDiff 5-8-0 includes bug fixes and improvements:
 
 - Fixed the bug with delta randomly not producing the same results when `ignore_order=True` (https://github.com/seperman/deepdiff/issues/277)
@@ -61,13 +67,13 @@ Note: if you want to use DeepDiff via commandline, make sure to run `pip install
 
 DeepDiff gets the difference of 2 objects.
 
-> - Please take a look at the [DeepDiff docs](https://zepworks.com/deepdiff/5.8.0/diff.html)
-> - The full documentation of all modules can be found on <https://zepworks.com/deepdiff/5.8.0/>
+> - Please take a look at the [DeepDiff docs](https://zepworks.com/deepdiff/5.8.1/diff.html)
+> - The full documentation of all modules can be found on <https://zepworks.com/deepdiff/5.8.1/>
 > - Tutorials and posts about DeepDiff can be found on <https://zepworks.com/tags/deepdiff/>
 
 ## A few Examples
 
-> Note: This is just a brief overview of what DeepDiff can do. Please visit <https://zepworks.com/deepdiff/5.8.0/> for full documentation.
+> Note: This is just a brief overview of what DeepDiff can do. Please visit <https://zepworks.com/deepdiff/5.8.1/> for full documentation.
 
 ### List difference ignoring order or duplicates
 
@@ -271,8 +277,8 @@ Example:
 ```
 
 
-> - Please take a look at the [DeepDiff docs](https://zepworks.com/deepdiff/5.8.0/diff.html)
-> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.0/>
+> - Please take a look at the [DeepDiff docs](https://zepworks.com/deepdiff/5.8.1/diff.html)
+> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.1/>
 
 
 # Deep Search
@@ -304,17 +310,17 @@ And you can pass all the same kwargs as DeepSearch to grep too:
 {'matched_paths': {"root['somewhere']": 'around'}, 'matched_values': {"root['long']": 'somewhere'}}
 ```
 
-> - Please take a look at the [DeepSearch docs](https://zepworks.com/deepdiff/5.8.0/dsearch.html)
-> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.0/>
+> - Please take a look at the [DeepSearch docs](https://zepworks.com/deepdiff/5.8.1/dsearch.html)
+> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.1/>
 
 # Deep Hash
 (New in v4-0-0)
 
 DeepHash is designed to give you hash of ANY python object based on its contents even if the object is not considered hashable!
 DeepHash is supposed to be deterministic in order to make sure 2 objects that contain the same data, produce the same hash.
 
-> - Please take a look at the [DeepHash docs](https://zepworks.com/deepdiff/5.8.0/deephash.html)
-> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.0/>
+> - Please take a look at the [DeepHash docs](https://zepworks.com/deepdiff/5.8.1/deephash.html)
+> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.1/>
 
 Let's say you have a dictionary object.
 
@@ -362,8 +368,8 @@ Which you can write as:
 At first it might seem weird why DeepHash(obj)[obj] but remember that DeepHash(obj) is a dictionary of hashes of all other objects that obj contains too.
 
 
-> - Please take a look at the [DeepHash docs](https://zepworks.com/deepdiff/5.8.0/deephash.html)
-> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.0/>
+> - Please take a look at the [DeepHash docs](https://zepworks.com/deepdiff/5.8.1/deephash.html)
+> - The full documentation can be found on <https://zepworks.com/deepdiff/5.8.1/>
 
 
 # Using DeepDiff in unit tests
@@ -443,11 +449,11 @@ Thank you!
 
 How to cite this library (APA style):
 
-    Dehpour, S. (2022). DeepDiff (Version 5.8.0) [Software]. Available from https://github.com/seperman/deepdiff.
+    Dehpour, S. (2022). DeepDiff (Version 5.8.1) [Software]. Available from https://github.com/seperman/deepdiff.
 
 How to cite this library (Chicago style):
 
-    Dehpour, Sep. 2022. DeepDiff (version 5.8.0).
+    Dehpour, Sep. 2022. DeepDiff (version 5.8.1).
 
 # Authors
 

deepdiff/__init__.py

@@ -1,6 +1,6 @@
 """This module offers the DeepDiff, DeepSearch, grep, Delta and DeepHash classes."""
 # flake8: noqa
-__version__ = '5.8.0'
+__version__ = '5.8.1'
 import logging
 
 if __name__ == '__main__':

deepdiff/diff.py

@@ -20,7 +20,7 @@
                              type_is_subclass_of_type_group, type_in_type_group, get_doc,
                              number_to_string, datetime_normalize, KEY_TO_VAL_STR, booleans,
                              np_ndarray, get_numpy_ndarray_rows, OrderedSetPlus, RepeatedTimer,
-                             TEXT_VIEW, TREE_VIEW, DELTA_VIEW,
+                             TEXT_VIEW, TREE_VIEW, DELTA_VIEW, detailed__dict__,
                              np, get_truncate_datetime, dict_, CannotCompare)
 from deepdiff.serialization import SerializationMixin
 from deepdiff.distance import DistanceMixin
@@ -231,6 +231,7 @@ def __init__(self,
             self.progress_logger = progress_logger
             self.cache_size = cache_size
             _parameters = self.__dict__.copy()
+            _parameters['group_by'] = None  # overwriting since these parameters will be passed on to other passes.
 
         # Non-Root
         if _shared_parameters:
@@ -393,8 +394,8 @@ def _diff_obj(self, level, parents_ids=frozenset(),
                 t1 = level.t1._asdict()
                 t2 = level.t2._asdict()
             else:
-                t1 = level.t1.__dict__
-                t2 = level.t2.__dict__
+                t1 = detailed__dict__(level.t1, ignore_private_variables=self.ignore_private_variables)
+                t2 = detailed__dict__(level.t2, ignore_private_variables=self.ignore_private_variables)
         except AttributeError:
             try:
                 t1 = self._dict_from_slots(level.t1)

deepdiff/helper.py

@@ -582,3 +582,23 @@ def get_homogeneous_numpy_compatible_type_of_seq(seq):
         return PYTHON_TYPE_TO_NUMPY_TYPE.get(type_, False)
     else:
         return False
+
+
+def detailed__dict__(obj, ignore_private_variables=True):
+    """
+    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 dir(obj):
+        if key not in result 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):
+                result[key] = value
+    return result

docs/conf.py

@@ -60,9 +60,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '5.8.0'
+version = '5.8.1'
 # The full version, including alpha/beta/rc tags.
-release = '5.8.0'
+release = '5.8.1'
 
 load_dotenv(override=True)
 DOC_VERSION = os.environ.get('DOC_VERSION', version)

docs/deephash_doc.rst

@@ -149,6 +149,12 @@ truncate_datetime: string, default = None
     If your object is nested, it will build hashes of all the objects it contains too.
 
 
+.. note::
+    DeepHash output is not like conventional hash functions. It is a dictionary of object IDs to their hashes. This happens because DeepHash calculates the hash of the object and any other objects found within the object in a recursive manner. If you only need the hash of the object you are passing, all you need to do is to do:
+
+    >>> DeepHash(obj)[obj]
+
+
 **Examples**
 
 Let's say you have a dictionary object.

docs/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 
-DeepDiff 5.8.0 documentation!
+DeepDiff 5.8.1 documentation!
 =============================
 
 *****************
@@ -31,6 +31,19 @@ The DeepDiff library includes the following modules:
 What is New
 ***********
 
+New In DeepDiff 5-8-1
+---------------------
+
+DeepDiff 5-8-1 includes bug fixes: - Fixed test suite for 32bit systems
+(https://github.com/seperman/deepdiff/issues/302) by `Louis-Philippe
+Véronneau`_ - Fixed the issue when using ``ignore_order=True`` and
+``group_by`` simultaneously - Added the support for diffing object
+properties (``@property``)
+(https://github.com/seperman/deepdiff/issues/312) - Better support of
+diffing private variables
+
+.. _Louis-Philippe Véronneau: https://github.com/baldurmen
+
 New In DeepDiff 5-8-0
 ---------------------
 
@@ -45,13 +58,6 @@ DeepDiff 5-8-0 includes bug fixes and improvements:
 - Fixed TypeError is thrown when comparing bool and str
 
 
-New In DeepDiff 5-7-0
----------------------
-
-- https://github.com/seperman/deepdiff/pull/284 Bug-Fix: TypeError in _get_numbers_distance() when ignore_order = True by @Dhanvantari
-- https://github.com/seperman/deepdiff/pull/280 Add support for UUIDs by @havardthom
-- Major bug in delta when it comes to iterable items added or removed is investigated by @uwefladrich and resolved by @seperman
-
 *********
 Tutorials
 *********

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 5.8.0
+current_version = 5.8.1
 commit = True
 tag = True
 tag_name = {new_version}

setup.py

@@ -10,7 +10,7 @@
 if os.environ.get('USER', '') == 'vagrant':
     del os.link
 
-version = '5.8.0'
+version = '5.8.1'
 
 
 def get_reqs(filename):

tests/test_delta.py

@@ -2,6 +2,7 @@
 import os
 import io
 import json
+import sys
 from decimal import Decimal
 from unittest import mock
 from deepdiff import Delta, DeepDiff
@@ -1054,7 +1055,7 @@ def test_ignore_order_delta_cases(
                 'root[5]': 10
             },
             '_numpy_paths': {
-                'root': 'int64'
+                'root': np.where((sys.maxsize > 2**32), 'int64', 'int32')
             }
         },
         'expected_result': 't2'

tests/test_diff_text.py

@@ -3,6 +3,7 @@
 import pytest
 import logging
 import uuid
+import numpy as np
 from decimal import Decimal
 from deepdiff import DeepDiff
 from deepdiff.helper import pypy3
@@ -569,7 +570,15 @@ class MyEnum(Enum):
                 'root._value_': {
                     'old_value': 1,
                     'new_value': 2
-                }
+                },
+                'root.name': {
+                    'old_value': 'A',
+                    'new_value': 'B'
+                },
+                'root.value': {
+                    'old_value': 1,
+                    'new_value': 2
+                },
             }
         }
         assert ddiff == result
@@ -1594,3 +1603,57 @@ def test_datetime_in_key(self):
         expected = {'values_changed': {f'root[{repr(now)}]': {'new_value': 2, 'old_value': 1}}}
 
         assert expected == diff
+
+    def test_property_values(self):
+
+        class A:
+            _thing = 0
+
+            def __init__(self, a):
+                self.a = a
+
+            @property
+            def thing(self):
+                A._thing += 1
+                return A._thing
+
+            @property
+            def __thing2(self):
+                A._thing += 1
+                return A._thing
+
+        diff = DeepDiff(A(1), A(1))
+        expected = {
+            'values_changed': {
+                'root._thing': {
+                    'new_value': 1,
+                    'old_value': 0
+                },
+                'root.thing': {
+                    'new_value': 2,
+                    'old_value': 1
+                }
+            }
+        }
+
+        assert expected == diff
+
+        diff2 = DeepDiff(A(1), A(1), ignore_private_variables=False)
+        expected2 = {
+            'values_changed': {
+                'root._A__thing2': {
+                    'new_value': 5,
+                    'old_value': 3
+                },
+                'root._thing': {
+                    'new_value': 5,
+                    'old_value': 3
+                },
+                'root.thing': {
+                    'new_value': 6,
+                    'old_value': 4
+                }
+            }
+        }
+
+        assert expected2 == diff2