DeepDiff 8.0.1 documentation!

Modules

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

DeepDiff 8-0-1

• Bugfix. Numpy should be optional.

DeepDiff 8-0-0

• With the introduction of threshold_to_diff_deeper, the values returned are different than in previous versions of DeepDiff. You can still get the older values by setting threshold_to_diff_deeper=0. However to signify that enough has changed in this release that the users need to update the parameters passed to DeepDiff, we will be doing a major version update.

• use_enum_value=True makes it so when diffing enum, we use the enum’s value. It makes it so comparing an enum to a string or any other value is not reported as a type change.

• threshold_to_diff_deeper=float is a number between 0 and 1. When comparing dictionaries that have a small intersection of keys, we will report the dictionary as a new_value instead of reporting individual keys changed. If you set it to zero, you get the same results as DeepDiff 7.0.1 and earlier, which means this feature is disabled. The new default is 0.33 which means if less that one third of keys between dictionaries intersect, report it as a new object.

• Deprecated ordered-set and switched to orderly-set. The ordered-set package was not being maintained anymore and starting Python 3.6, there were better options for sets that ordered. I forked one of the new implementations, modified it, and published it as orderly-set.

• Added use_log_scale:bool and log_scale_similarity_threshold:float. They can be used to ignore small changes in numbers by comparing their differences in logarithmic space. This is different than ignoring the difference based on significant digits.

• json serialization of reversed lists.

• Fix for iterable moved items when iterable_compare_func is used.

• Pandas and Polars support

DeepDiff 7-0-0

• DeepDiff 7 comes with an improved delta object. Delta to flat dictionaries have undergone a major change. We have also introduced Delta serialize to flat rows.

• Subtracting delta objects have dramatically improved at the cost of holding more metadata about the original objects.

• When verbose=2, and the “path” of an item has changed in a report between t1 and t2, we include it as new_path.

• path(use_t2=True) returns the correct path to t2 in any reported change in the tree view

• Python 3.7 support is dropped and Python 3.12 is officially supported.

DeepDiff 6-7-1

• Support for subtracting delta objects when iterable_compare_func is used.

• Better handling of force adding a delta to an object.

• Fix for Can’t compare dicts with both single and double quotes in keys

• Updated docs for Inconsistent Behavior with math_epsilon and ignore_order = True

DeepDiff 6-7-0

• Delta can be subtracted from other objects now.

• verify_symmetry is deprecated. Use bidirectional instead.

• Always Include Values flag in Delta can be enabled to include values in the delta for every change.

• Fix for Delta.__add__ breaks with esoteric dict keys.

• Delta Load From Flat Dictionaries can be used to load a delta from the list of flat dictionaries.

DeepDiff 6-6-1

• Fix for DeepDiff raises decimal exception when using significant digits

• Introducing group_by_sort_key

• Adding group_by 2D. For example group_by=['last_name', 'zip_code']

DeepDiff 6-6-0

• Delta Serialize To Flat Dictionaries can be used to serialize delta objects into a flat list of dictionaries.

• NumPy 2.0 compatibility by William Jamieson

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]"

If you want to improve the performance of DeepDiff with certain processes such as json serialization:

pip install "deepdiff[optimize]"

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!

References

• DeepDiff
  • DeepDiff
    • DeepDiff.affected_paths
    • DeepDiff.affected_root_keys
    • DeepDiff.custom_report_result()
    • DeepDiff.get_stats()
  • Basics
    • Group By
    • Group By - Sort Key
  • Customized Diff
    • Iterable Compare Func
    • Custom Operators
      • PrefixOrSuffixOperator
    • Define A Custom Operator
  • Deep Distance
    • Get Deep Distance
    • Distance And Diff Granularity
  • Exclude Paths
  • Include Paths
    • Exclude Regex Paths
  • Ignore Order
    • Ignore Order
    • Dynamic Ignore Order
    • Reporting Repetitions
    • Max Passes
    • Cutoff Distance For Pairs
    • Cutoff Intersection For Pairs
    • Iterable Compare Func
  • Ignore Types Or Values
    • Exclude Types
    • Ignore String Type Changes
    • Ignore Numeric Type Changes
    • Ignore Type In Groups
    • Ignore Type Subclasses
    • Ignore String Case
    • Ignore Nan Inequality
    • Ignore Private Variables
    • Exclude Obj Callback
    • Exclude Obj Callback Strict
    • Include Obj Callback
    • Include Obj Callback Strict
    • Truncate Datetime
    • Use Enum Value
  • Numbers
    • Significant Digits
    • Number Format Notation
    • Number To String Function
    • Ignore Numeric Type Changes
    • Ignore Nan Inequality
    • Math Epsilon
    • Use Log Scale
    • Log Scale Similarity Threshold
    • Performance Improvement of Numbers diffing
  • Optimizations
    • Optimized Libraries
    • Max Passes
    • Max Diffs
    • Cache Size
      • Cache Examples
    • Cache Tuning Sample Size
    • Optimizations for Diffing Numbers
    • Pypy
    • Cutoff Intersection For Pairs
    • Cache Purge Level
    • Zip Ordered Iterables
    • Threshold To Diff Deeper
  • Other Parameters
    • Encodings
    • Ignore Encoding Errors
  • Serialization
    • To Dict
    • To Json
    • To Json Pickle
    • From Json Pickle
    • Delta Serialize To Flat Rows
    • Delta Serialize To Flat Dictionaries
    • Delta Load From Flat Dictionaries
  • Stats and Logging
    • Log Frequency In Sec
    • Progress Logger
    • Get Stats
  • Troubleshoot
    • Murmur3 Installation
  • View
    • Text View
    • Tree View
    • pretty() method
    • Text view vs. Tree view vs. vs. pretty() method
• DeepSearch
  • grep
  • DeepSearch
• DeepHash
  • DeepHash
    • DeepHash.get()
    • DeepHash.get_key()
    • DeepHash.sha1hex()
    • DeepHash.sha256hex()
• Delta
  • Diff to load in Delta
  • Delta Path parameter
  • Delta File parameter
  • Flat Dict List
  • Flat Rows List
  • Delta Deserializer
    • Json Deserializer for Delta
  • Delta Serializer
  • Delta Serialize To Flat Dictionaries
  • Delta Dump Safety
  • Delta Mutate parameter
  • Delta and Numpy
  • Delta Raise Errors parameter
  • Delta Safe To Import parameter
  • Delta Verify Symmetry parameter
  • Delta Force
  • Always Include Values
• Extract
  • extract()
• Command Line
  • deep diff command
  • deep grep command
  • deep extract command
  • deep patch command
• Changelog
• Authors
• F.A.Q
  • Q: DeepDiff report is not precise when ignore_order=True
  • Q: The report of changes in a nested dictionary is too granular
  • Q: TypeError: Object of type type is not JSON serializable
  • Q: How do I parse DeepDiff result paths?
• Support

Indices and tables

• Index

• Module Index

• Search Page