A lightweight library to perform deep merges of python dictionaries
Project description
DeepMerge
A lightweight python package for performing deep-merges of python dictionaries
Installation
Install this package with pip!
$ pip install pydeepmerge
To install this package from source, clone the repo and run:
$ pip install .
If you would like to develop, remember to install the extras.
# for bash
$ pip install -e .[test,dev]
# for zsh
$ pip install -e .\[test,dev\]
Usage
Usage is simple:
from pydeepmerge import deep_merge
> some_data = {'foo': {'bar': 'baz', 'spam': 'eggs'}, 'ham': 'eggs'}
> more_data = {'spam': {'eggs': 'ham'}, 'foo': {'baz': 'bar', 'bar': 'foo'}}
> deep_merge(some_data, more_data)
{'foo': {'bar': 'foo', 'baz': 'bar', 'spam': 'eggs'}, 'spam': {'eggs': 'ham'}, 'ham': 'eggs'}
pydeepmerge
also allows users to specify their own merge strategy function. By default, it uses the function prefer_right
.
A merge strategy is any function that can accept exactly two inputs. The output of the merge strategy function should be what the merge result between two values should be.
When writing your own merge strategy function, keep in mind that if the key does not exist on the left-hand mapping, the value Key.NoKeyFound
will be passed to the first parameter of the function. This is done deliberately so the user can determine if they want to do special behaviour if it is the first occurrence of the key in the sequence of dictionaries.
An example of a merge strategy function can be found below:
from pydeepmerge import deep_merge
from pydeepmerge.types import Key
from typing import Mapping
def pick_shallower(left_value, right_value):
if left_value is Key.NoKeyFound:
return right_value
if isinstance(right_value, Mapping):
if not isinstance(left_value, Mapping):
return left_value
return deep_merge(left_value, right_value)
return right_value
The deep_merge
function does not mutate any mapping but instead creates a new dictionary.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pydeepmerge-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e570fe4422a4448d21919c086f27d249dc8330684737160c02f5f35ba862ed90 |
|
MD5 | 8a8a7f55b1bf9fb867a4ba5f8cc40c5b |
|
BLAKE2b-256 | 15fdc3c86a5d14cfd17b47e0ba24afb398c61f4519672d22a435ba586fd974a3 |