DeepDiff 6.6.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 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

DeepDiff 6-5-0

• parse_path

DeepDiff 6-4-0

• Add Ignore List Order Option to DeepHash by Bobby Morck

• pyyaml to 6.0.1 to fix cython build problems by Robert Bo Davis

• Precompiled regex simple diff by cohml

• New flag: zip_ordered_iterables for forcing iterable items to be compared one by one.

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
  • Numbers
    • Significant Digits
    • Number Format Notation
    • Number To String Function
    • Ignore Numeric Type Changes
    • Ignore Nan Inequality
    • Math Epsilon
    • 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
  • Other Parameters
    • Encodings
    • Ignore Encoding Errors
  • Serialization
    • To Dict
    • To Json
    • To Json Pickle
    • From Json Pickle
    • Delta Serialize To 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
  • 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
• 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: 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