https://github.com/toumorokoshi/deepmerge

A deep merging tool for Python core data structures
https://github.com/toumorokoshi/deepmerge

Last synced: 4 days ago
JSON representation

A deep merging tool for Python core data structures

• Host: GitHub
• URL: https://github.com/toumorokoshi/deepmerge
• Owner: toumorokoshi
• License: mit
• Created: 2016-11-05T19:09:31.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-30T05:30:58.000Z (4 months ago)
• Last Synced: 2024-10-30T02:31:37.538Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 168
• Watchers: 9
• Forks: 34
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
=========

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 `_:

.. 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 `_

------------------

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