# deepmerge

> A toolset for deeply merging Python dictionaries.

- **URL**: https://www.freshcrate.ai/projects/deepmerge
- **Author**: pypi
- **Category**: Developer Tools
- **Latest version**: `2.0` (2026-04-21)
- **License**: MIT Licence
- **Source**: https://github.com/toumorokoshi/deepmerge
- **Homepage**: https://pypi.org/project/deepmerge/
- **Language**: Python
- **GitHub**: 209 stars, 39 forks
- **Registry**: pypi (`deepmerge`)
- **Tags**: `pypi`

## Description

=========
deepmerge
=========

.. image:: https://img.shields.io/pypi/v/deepmerge.svg
   :target: https://pypi.org/project/deepmerge/

.. image:: https://img.shields.io/pypi/status/deepmerge.svg
   :target: https://pypi.org/project/deepmerge/

.. image:: https://img.shields.io/pypi/pyversions/pillar.svg
   :target: https://github.com/toumorokoshi/deepmerge

.. image:: https://img.shields.io/github/license/toumorokoshi/deepmerge.svg
   :target: https://github.com/toumorokoshi/deepmerge

.. image:: https://github.com/toumorokoshi/deepmerge/actions/workflows/python-package.yaml/badge.svg
    :target: https://github.com/toumorokoshi/deepmerge/actions/workflows/python-package.yaml

A tool to handle merging of nested data structures in Python.

------------
Installation
------------

deepmerge is available on `pypi <https://pypi.org/project/deepmerge/>`_:

.. code-block:: bash

   pip install deepmerge

-------
Example
-------

**Generic Strategy**

.. code-block:: python

    from deepmerge import always_merger

    base = {"foo": ["bar"]}
    next = {"foo": ["baz"]}

    expected_result = {'foo': ['bar', 'baz']}
    result = always_merger.merge(base, next)

    assert expected_result == result


**Custom Strategy**

.. code-block:: python

    from deepmerge import Merger

    my_merger = Merger(
        # pass in a list of tuple, with the
        # strategies you are looking to apply
        # to each type.
        [
            (list, ["append"]),
            (dict, ["merge"]),
            (set, ["union"])
        ],
        # next, choose the fallback strategies,
        # applied to all other types:
        ["override"],
        # finally, choose the strategies in
        # the case where the types conflict:
        ["override"]
    )
    base = {"foo": ["bar"]}
    next = {"bar": "baz"}
    my_merger.merge(base, next)
    assert base == {"foo": ["bar"], "bar": "baz"}


You can also pass in your own merge functions, instead of a string.

For more information, see the `docs <https://deepmerge.readthedocs.io/en/latest/>`_

------------------
Supported Versions
------------------

deepmerge is supported on Python 3.8+.

For older Python versions the last supported version of deepmerge is listed
below:

- 3.7 : 1.1.1

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `2.0` | 2026-04-21 | Low | Imported from PyPI (2.0) |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |
| `v2.0` | 2024-08-30 | Low | ## Breaking Changes  * Add typing / drop Python < 3.8 support by @nhairs in https://github.com/toumorokoshi/deepmerge/pull/30  ## What's Changed  * feat: add typing for `merge` and `value_strategy` functions by @Atry in https://github.com/toumorokoshi/deepmerge/pull/33 * fix: Different hash for same dictionaries problem by @alexeykomp in https://github.com/toumorokoshi/deepmerge/pull/32  ## New Contributors  * @icy made their first contribution in https://github.com/toumorokoshi/deepm |

## Citation

- HTML: https://www.freshcrate.ai/projects/deepmerge
- Markdown: https://www.freshcrate.ai/projects/deepmerge.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/deepmerge/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._