1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
==========
Dictdiffer
==========
.. currentmodule:: dictdiffer
.. image:: https://github.com/inveniosoftware/dictdiffer/workflows/CI/badge.svg
:target: https://github.com/inveniosoftware/dictdiffer/actions
.. image:: https://img.shields.io/coveralls/inveniosoftware/dictdiffer.svg
:target: https://coveralls.io/r/inveniosoftware/dictdiffer
.. image:: https://img.shields.io/github/tag/inveniosoftware/dictdiffer.svg
:target: https://github.com/inveniosoftware/dictdiffer/releases
.. image:: https://img.shields.io/pypi/dm/dictdiffer.svg
:target: https://pypi.python.org/pypi/dictdiffer
.. image:: https://img.shields.io/github/license/inveniosoftware/dictdiffer.svg
:target: https://github.com/inveniosoftware/dictdiffer/blob/master/LICENSE
Dictdiffer is a helper module that helps you to diff and patch
dictionaries.
Installation
============
Dictdiffer is on PyPI so all you need is:
.. code-block:: console
$ pip install dictdiffer
Usage
=====
Let's start with an example on how to find the diff between two
dictionaries using :func:`.diff` method:
.. code-block:: python
from dictdiffer import diff, patch, swap, revert
first = {
"title": "hello",
"fork_count": 20,
"stargazers": ["/users/20", "/users/30"],
"settings": {
"assignees": [100, 101, 201],
}
}
second = {
"title": "hellooo",
"fork_count": 20,
"stargazers": ["/users/20", "/users/30", "/users/40"],
"settings": {
"assignees": [100, 101, 202],
}
}
result = diff(first, second)
assert list(result) == [
('change', ['settings', 'assignees', 2], (201, 202)),
('add', 'stargazers', [(2, '/users/40')]),
('change', 'title', ('hello', 'hellooo'))]
Now we can apply the diff result with :func:`.patch` method:
.. code-block:: python
result = diff(first, second)
patched = patch(result, first)
assert patched == second
Also we can swap the diff result with :func:`.swap` method:
.. code-block:: python
result = diff(first, second)
swapped = swap(result)
assert list(swapped) == [
('change', ['settings', 'assignees', 2], (202, 201)),
('remove', 'stargazers', [(2, '/users/40')]),
('change', 'title', ('hellooo', 'hello'))]
Let's revert the last changes:
.. code-block:: python
result = diff(first, second)
reverted = revert(result, patched)
assert reverted == first
A tolerance can be used to consider closed values as equal.
The tolerance parameter only applies for int and float.
Let's try with a tolerance of 10% with the values 10 and 10.5:
.. code-block:: python
first = {'a': 10.0}
second = {'a': 10.5}
result = diff(first, second, tolerance=0.1)
assert list(result) == []
Now with a tolerance of 1%:
.. code-block:: python
result = diff(first, second, tolerance=0.01)
assert list(result) == ('change', 'a', (10.0, 10.5))
API
===
.. automodule:: dictdiffer
:members:
.. include:: ../CHANGES
.. include:: ../CONTRIBUTING.rst
License
=======
.. include:: ../LICENSE
.. include:: ../AUTHORS
|
