DeepDiff 5.7.0 documentation!¶
DeepDiff Overview¶
The DeepDiff library includes the following modules:
DeepDiff For Deep Difference of 2 objects. DeepDiff
It return the deep Difference of python objects. It can also be used to take the distance between objects. Deep Distance
DeepSearch Search for objects within other objects. DeepSearch
DeepHash Hash any object based on their content even if they are not “hashable” in Python’s eyes. DeepHash
Delta Delta of objects that can be applied to other objects. Imagine git commits but for structured data. Delta
Extract For extracting a path from an object Extract
Commandline Most of the above functionality is also available via the commandline module Command Line
What is New¶
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
New In DeepDiff 5-6-0¶
Create custom operators!
>>> from deepdiff import DeepDiff
>>> from deepdiff.operator import BaseOperator
>>> class CustomClass:
... def __init__(self, d: dict, l: list):
... self.dict = d
... self.dict['list'] = l
...
>>>
>>> custom1 = CustomClass(d=dict(a=1, b=2), l=[1, 2, 3])
>>> custom2 = CustomClass(d=dict(c=3, d=4), l=[1, 2, 3, 2])
>>> custom3 = CustomClass(d=dict(a=1, b=2), l=[1, 2, 3, 4])
>>>
>>>
>>> class ListMatchOperator(BaseOperator):
... def give_up_diffing(self, level, diff_instance):
... if set(level.t1.dict['list']) == set(level.t2.dict['list']):
... return True
...
>>>
>>> DeepDiff(custom1, custom2, custom_operators=[
... ListMatchOperator(types=[CustomClass])
... ])
{}
>>>
>>>
>>> DeepDiff(custom2, custom3, custom_operators=[
... ListMatchOperator(types=[CustomClass])
... ])
{'dictionary_item_added': [root.dict['a'], root.dict['b']], 'dictionary_item_removed': [root.dict['c'], root.dict['d']], 'values_changed': {"root.dict['list'][3]": {'new_value': 4, 'old_value': 2}}}
>>>
Dynamic ignore order function
Ignoring order when certain word in the path
>>> from deepdiff import DeepDiff
>>> t1 = {'a': [1, 2], 'b': [3, 4]}
>>> t2 = {'a': [2, 1], 'b': [4, 3]}
>>> DeepDiff(t1, t2, ignore_order=True)
{}
>>> def ignore_order_func(level):
... return 'a' in level.path()
...
>>> DeepDiff(t1, t2, ignore_order=True, ignore_order_func=ignore_order_func)
{'values_changed': {"root['b'][0]": {'new_value': 4, 'old_value': 3}, "root['b'][1]": {'new_value': 3, 'old_value': 4}}}
Tutorials¶
Tutorials can be found on Zepworks blog
Installation¶
Install from PyPi:
pip install deepdiff
If you want to use DeepDiff from commandline:
pip install "deepdiff[cli]"
Read about DeepDiff optimizations at Optimizations
>>> from deepdiff import DeepDiff # For Deep Difference of 2 objects
>>> from deepdiff import grep, DeepSearch # For finding if item exists in an object
>>> from deepdiff import DeepHash # For hashing objects based on their contents
>>> from deepdiff import Delta # For creating delta of objects that can be applied later to other objects.
>>> from deepdiff import extract # For extracting a path from an object
- Note: if you want to use DeepDiff via commandline, make sure to run::
pip install “deepdiff[cli]”
Then you can access the commands via:
DeepDiff
$ deep diff --help
Delta
$ deep patch --help
grep
$ deep grep --help
extract
$ deep extract --help
int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple, Numpy, custom objects and more!
Pycon¶
Pycon 2016 Talk A talk was given about the basics of how DeepDiff does what it does at Pycon 2016. Diff it to Dig it Pycon 2016 video
You can find more information about the contents of that Pycon talk here: http://zepworks.com/blog/diff-it-to-digg-it/