Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions deepdiff/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,12 @@
from .deephash import DeepHash as DeepHash
from .delta import Delta as Delta
from .path import extract as extract, parse_path as parse_path
from .json_diff import (
CollectionStrategy as CollectionStrategy,
CollectionStrategyError as CollectionStrategyError,
DeepJSONDiff as DeepJSONDiff,
DuplicateIdentityError as DuplicateIdentityError,
DuplicateIdentityPolicy as DuplicateIdentityPolicy,
IdentityExtractionError as IdentityExtractionError,
MissingIdentityPolicy as MissingIdentityPolicy,
)
16 changes: 12 additions & 4 deletions deepdiff/docstrings/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ The DeepDiff library includes the following modules:

It returns the deep difference of python objects. It can also be used to take the distance between objects. :doc:`/deep_distance`

- **DeepJSONDiff** For opt-in, path-scoped comparison of JSON collections using identity matching, sorting, filtering, normalization, and explicit duplicate or missing-identity policies. :doc:`/json_collection_strategies`

- **DeepSearch** Search for objects within other objects. :doc:`/dsearch`

- **DeepHash** Hash any object based on their content even if they are not "hashable" in Python's eyes. :doc:`/deephash`
- **DeepHash** Hash any object based on their content even if they are not "hashable" in Python's eyes. :doc:`/deephash`

- **Delta** Delta of objects that can be applied to other objects. Imagine git commits but for structured data. :doc:`/delta`
- **Delta** Delta of objects that can be applied to other objects. Imagine git commits but for structured data. :doc:`/delta`

- **Extract** For extracting a path from an object :doc:`/extract`

Expand All @@ -40,6 +42,11 @@ The DeepDiff library includes the following modules:
What Is New
***********

Unreleased
----------

- Added the opt-in ``DeepJSONDiff`` facade and ``CollectionStrategy`` API for path-scoped JSON collection matching, sorting, filtering, normalization, diagnostics, and explicit missing or duplicate identity policies.

DeepDiff 9-0-0
--------------

Expand All @@ -65,8 +72,7 @@ Tutorials
*********

Tutorials can be found on `Zepworks blog <https://zepworks.com/tags/deepdiff/>`_



************
Installation
************
Expand All @@ -91,6 +97,7 @@ Importing
.. code:: python

>>> from deepdiff import DeepDiff # For Deep Difference of 2 objects
>>> from deepdiff import DeepJSONDiff, CollectionStrategy # For path-scoped JSON collection comparison
>>> 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.
Expand Down Expand Up @@ -142,6 +149,7 @@ References
:maxdepth: 4

diff
json_collection_strategies
dsearch
deephash
delta
Expand Down
Loading
Loading