Skip to main content

a toolset to deeply merge python dictionaries.

Project description

A tools to handle merging of nested data structures in python.

example

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"])
    ],
    # 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"}

Strategies are passed as a list, and the merge runs through each strategy sequentially, and raises an exception if none are able to resolve the merge.

You can also pass in your own merge functions, instead of a string. Your function should take the arguments of (merger, path, base_value, value_to_merge_in).

A default merge does not exist, due to the numerous choices that have to be made for every merger. However, some very generic mergers are supplied:

  • always_merger: will never raise a merge exception, and will merge when possible.
  • merge_or_raise: will merge when possible, raise an exception when there is a conflict.

The best resource for now is the unit tests.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
deepmerge-0.0.4-py2.py3-none-any.whl (9.0 kB) Copy SHA256 hash SHA256 Wheel 3.6 Apr 24, 2017
deepmerge-0.0.4.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None Apr 24, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page