Python中高效的json对比库deepdiff详解

1. 什么是deepdiff

deepdiff是一个Python库，用于比较Python数据结构（例如字典、列表、JSON等）之间的差异。它不仅可以比较简单的Python数据类型，还可以比较任意深度或复杂度的数据结构。

在Python中，我们经常需要比较两个JSON对象的异同。例如在测试中，我们需要比较预期输出和实际输出是否相同。而在开发中，我们也需要比较两个JSON对象的差异以便维护。

使用deepdiff库，可以轻松地处理这些场景。

2. 安装deepdiff

在安装deepdiff之前，请确保你的Python版本为3.6及以上。 然后，可以通过以下命令安装deepdiff：

pip install deepdiff

如果你想使用更快的比较引擎，可以使用Cython版本：

pip install deepdiff[c]

3. 使用deepdiff

深入了解deepdiff之前，让我们从一个简单的示例开始。 假设我们有两个JSON对象：

a = {"foo": 1, "bar": 2}
b = {"foo": 1, "baz": 3}

现在，我们想确定对象a和对象b之间的差异。 我们可以使用deepdiff包中的DeepDiff类：

from deepdiff import DeepDiff

diff = DeepDiff(a, b)
print(diff)

输出如下：

{'dictionary_item_added': {'root.b.baz': 3}, 'dictionary_item_removed': {'root.a.bar': 2}}

我们可以看到，输出显示了b对比a改变的部分。 在这种情况下，我们可以看到，b对象中添加了一个新的项baz，而a对象中的一个键值对bar从中删除了。

4. 深度定制

deepdiff还提供了许多选项和选项，以允许针对你需要的目标定制比较。 比如，可以为不同的类型设置比较器。

让我们通过一个示例来演示这一点。 在这个例子中，我们有两个对象：

a = {"foo": {"bar": 123, "baz": 456}}
b = {"foo": {"bar": 321, "qux": 789}}

现在，我们想比较这两个JSON对象，并将只关注键bar的不同之处，而忽略键baz和qux。

为了做到这一点，我们需要为键foo指定一个特殊的比较器，该比较器只关注键bar：

def dict_item_similar_by_name_and_value(name1, name2, value1, value2):
    if name1 == "bar" and name2 == "bar":
        return "values.diff", (value1, value2)
    return None

custom_config = {"top_level_keys_to_ignore": ["baz", "qux"], "custom_type_to_diff":
                 {dict: {"compare": "keys", "name": "dict_item_similar_by_name_and_value"}}}

diff = DeepDiff(a, b, **custom_config)
print(diff)

输出如下：

{'values_changed': {'root.foo.bar': {'new_value': 321, 'old_value': 123}}}

可以看到，定义的比较器只关注键bar，并给出了该键的不同之处。

5. 总结

在开发和测试中，处理JSON对象的比较是必不可少的。 使用deepdiff库，我们可以轻松地比较Python数据结构，包括任何深度和最多复杂度的数据结构。 这种方法是高效的，使用简单，而且可以通过自定义配置充分定制。