Skip to content

Commit f6f1117

Browse files
committed
updating docs
1 parent 4338b06 commit f6f1117

File tree

5 files changed

+52
-0
lines changed

5 files changed

+52
-0
lines changed

AUTHORS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,11 @@ Authors in order of the timeline of their contributions:
7777
- [Enji Cooper](https://github.com/ngie-eign) for converting legacy setuptools use to pyproject.toml
7878
- [Diogo Correia](https://github.com/diogotcorreia) for reporting security vulnerability in Delta and DeepDiff that could allow remote code execution.
7979
- [am-periphery](https://github.com/am-periphery) for reporting CVE-2026-33155: denial-of-service via crafted pickle payloads triggering massive memory allocation.
80+
- [echan5](https://github.com/echan5) for adding callable `group_by` support.
81+
- [yannrouillard](https://github.com/yannrouillard) for fixing colored view display when all list items are removed.
82+
- [tpvasconcelos](https://github.com/tpvasconcelos) for fixing `__slots__` handling for objects with `__getattr__`.
83+
- [devin13cox](https://github.com/devin13cox) for always using t1 path for reporting.
84+
- [vitalis89](https://github.com/vitalis89) for fixing `ignore_keys` issue in `detailed__dict__`.
85+
- [ljames8](https://github.com/ljames8) for fixing logarithmic similarity type hint.
86+
- [srini047](https://github.com/srini047) for fixing README typo.
87+
- [Nagato-Yuzuru](https://github.com/Nagato-Yuzuru) for colored view tests.

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@
55
- `to_dict()` and `to_json()` now accept a `verbose_level` parameter and always return a usable text-view dict. When the original view is `'tree'`, they default to `verbose_level=2` for full detail. The old `view_override` parameter is removed. To get the previous results, you will need to pass the explicit verbose_level to `to_json` and `to_dict` if you are using the tree view.
66
- Dropping support for Python 3.9
77
- Support for python 3.14
8+
- Added support for callable `group_by` thanks to [echan5](https://github.com/echan5)
9+
- Added `FlatDeltaDict` TypedDict for `to_flat_dicts` return type
10+
- Fixed colored view display when all list items are removed thanks to [yannrouillard](https://github.com/yannrouillard)
11+
- Fixed `hasattr()` swallowing `AttributeError` in `__slots__` handling for objects with `__getattr__` thanks to [tpvasconcelos](https://github.com/tpvasconcelos)
12+
- Fixed `ignore_order=True` missing int-vs-float type changes
13+
- Always use t1 path for reporting thanks to [devin13cox](https://github.com/devin13cox)
14+
- Fixed `_convert_oversized_ints` failing on NamedTuples
15+
- Fixed orjson `TypeError` for integers exceeding 64-bit range
16+
- Fixed parameter bug in `to_flat_dicts` where `include_action_in_path` and `report_type_changes` were not being passed through
17+
- Fixed `ignore_keys` issue in `detailed__dict__` thanks to [vitalis89](https://github.com/vitalis89)
18+
- Fixed logarithmic similarity type hint thanks to [ljames8](https://github.com/ljames8)
819
- v8-6-2
920
- Security fix (CVE-2026-33155): Prevent denial-of-service via crafted pickle payloads that trigger massive memory allocation through the REDUCE opcode. Size-sensitive callables like `bytes()` and `bytearray()` are now wrapped to reject allocations exceeding 128 MB.
1021
- v8-6-1

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ DeepDiff 8-7-0
3232
- `to_dict()` and `to_json()` now accept a `verbose_level` parameter and always return a usable text-view dict. When the original view is `'tree'`, they default to `verbose_level=2` for full detail. The old `view_override` parameter is removed. To get the previous results, you will need to pass the explicit verbose_level to `to_json` and `to_dict` if you are using the tree view.
3333
- Dropping support for Python 3.9
3434
- Support for python 3.14
35+
- Added support for callable `group_by` thanks to @echan5
36+
- Added `FlatDeltaDict` TypedDict for `to_flat_dicts` return type
37+
- Fixed colored view display when all list items are removed thanks to @yannrouillard
38+
- Fixed `hasattr()` swallowing `AttributeError` in `__slots__` handling for objects with `__getattr__` thanks to @tpvasconcelos
39+
- Fixed `ignore_order=True` missing int-vs-float type changes
40+
- Always use t1 path for reporting thanks to @devin13cox
41+
- Fixed `_convert_oversized_ints` failing on NamedTuples
42+
- Fixed orjson `TypeError` for integers exceeding 64-bit range
43+
- Fixed parameter bug in `to_flat_dicts` where `include_action_in_path` and `report_type_changes` were not being passed through
44+
- Fixed `ignore_keys` issue in `detailed__dict__` thanks to @vitalis89
45+
- Fixed logarithmic similarity type hint thanks to @ljames8
3546

3647
DeepDiff 8-6-2
3748
- **Security (CVE-2026-33155):** Fixed a memory exhaustion DoS vulnerability in `_RestrictedUnpickler` by limiting the maximum allocation size for `bytes` and `bytearray` during deserialization.

docs/changelog.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ DeepDiff Changelog
1010
- `to_dict()` and `to_json()` now accept a `verbose_level` parameter and always return a usable text-view dict. When the original view is `'tree'`, they default to `verbose_level=2` for full detail. The old `view_override` parameter is removed. To get the previous results, you will need to pass the explicit verbose_level to `to_json` and `to_dict` if you are using the tree view.
1111
- Dropping support for Python 3.9
1212
- Support for python 3.14
13+
- Added support for callable ``group_by`` thanks to `echan5 <https://github.com/echan5>`__
14+
- Added ``FlatDeltaDict`` TypedDict for ``to_flat_dicts`` return type
15+
- Fixed colored view display when all list items are removed thanks to `yannrouillard <https://github.com/yannrouillard>`__
16+
- Fixed ``hasattr()`` swallowing ``AttributeError`` in ``__slots__`` handling for objects with ``__getattr__`` thanks to `tpvasconcelos <https://github.com/tpvasconcelos>`__
17+
- Fixed ``ignore_order=True`` missing int-vs-float type changes
18+
- Always use t1 path for reporting thanks to `devin13cox <https://github.com/devin13cox>`__
19+
- Fixed ``_convert_oversized_ints`` failing on NamedTuples
20+
- Fixed orjson ``TypeError`` for integers exceeding 64-bit range
21+
- Fixed parameter bug in ``to_flat_dicts`` where ``include_action_in_path`` and ``report_type_changes`` were not being passed through
22+
- Fixed ``ignore_keys`` issue in ``detailed__dict__`` thanks to `vitalis89 <https://github.com/vitalis89>`__
23+
- Fixed logarithmic similarity type hint thanks to `ljames8 <https://github.com/ljames8>`__
1324
- v8-6-2
1425
- Security fix (CVE-2026-33155): Prevent denial-of-service via crafted pickle payloads that trigger massive memory allocation through the REDUCE opcode. Size-sensitive callables like ``bytes()`` and ``bytearray()`` are now wrapped to reject allocations exceeding 128 MB.
1526
- v8-6-1

docs/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ DeepDiff 8-7-0
3838
- `to_dict()` and `to_json()` now accept a `verbose_level` parameter and always return a usable text-view dict. When the original view is `'tree'`, they default to `verbose_level=2` for full detail. The old `view_override` parameter is removed. To get the previous results, you will need to pass the explicit verbose_level to `to_json` and `to_dict` if you are using the tree view.
3939
- Dropping support for Python 3.9
4040
- Support for python 3.14
41+
- Added support for callable ``group_by`` thanks to `echan5 <https://github.com/echan5>`__
42+
- Added ``FlatDeltaDict`` TypedDict for ``to_flat_dicts`` return type
43+
- Fixed colored view display when all list items are removed thanks to `yannrouillard <https://github.com/yannrouillard>`__
44+
- Fixed ``hasattr()`` swallowing ``AttributeError`` in ``__slots__`` handling for objects with ``__getattr__`` thanks to `tpvasconcelos <https://github.com/tpvasconcelos>`__
45+
- Fixed ``ignore_order=True`` missing int-vs-float type changes
46+
- Always use t1 path for reporting thanks to `devin13cox <https://github.com/devin13cox>`__
47+
- Fixed ``_convert_oversized_ints`` failing on NamedTuples
48+
- Fixed orjson ``TypeError`` for integers exceeding 64-bit range
49+
- Fixed parameter bug in ``to_flat_dicts`` where ``include_action_in_path`` and ``report_type_changes`` were not being passed through
50+
- Fixed ``ignore_keys`` issue in ``detailed__dict__`` thanks to `vitalis89 <https://github.com/vitalis89>`__
51+
- Fixed logarithmic similarity type hint thanks to `ljames8 <https://github.com/ljames8>`__
4152

4253
DeepDiff 8-6-2
4354
--------------

0 commit comments

Comments
 (0)