155 lines
4.2 KiB
Plaintext
155 lines
4.2 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: mergedeep
|
||
|
|
Version: 1.3.4
|
||
|
|
Summary: A deep merge function for 🐍.
|
||
|
|
Home-page: https://github.com/clarketm/mergedeep
|
||
|
|
Author: Travis Clarke
|
||
|
|
Author-email: travis.m.clarke@gmail.com
|
||
|
|
License: UNKNOWN
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3.9
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Requires-Python: >=3.6
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
|
||
|
|
# [mergedeep](https://mergedeep.readthedocs.io/en/latest/)
|
||
|
|
|
||
|
|
[](https://pypi.org/project/mergedeep/)
|
||
|
|
[](https://pypi.org/project/mergedeep/)
|
||
|
|
[](https://pepy.tech/project/mergedeep)
|
||
|
|
[](https://anaconda.org/conda-forge/mergedeep)
|
||
|
|
[](https://anaconda.org/conda-forge/mergedeep)
|
||
|
|
[](https://mergedeep.readthedocs.io/en/latest/?badge=latest)
|
||
|
|
|
||
|
|
A deep merge function for 🐍.
|
||
|
|
|
||
|
|
[Check out the mergedeep docs](https://mergedeep.readthedocs.io/en/latest/)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ pip install mergedeep
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```text
|
||
|
|
merge(destination: MutableMapping, *sources: Mapping, strategy: Strategy = Strategy.REPLACE) -> MutableMapping
|
||
|
|
```
|
||
|
|
|
||
|
|
Deep merge without mutating the source dicts.
|
||
|
|
|
||
|
|
```python3
|
||
|
|
from mergedeep import merge
|
||
|
|
|
||
|
|
a = {"keyA": 1}
|
||
|
|
b = {"keyB": {"sub1": 10}}
|
||
|
|
c = {"keyB": {"sub2": 20}}
|
||
|
|
|
||
|
|
merged = merge({}, a, b, c)
|
||
|
|
|
||
|
|
print(merged)
|
||
|
|
# {"keyA": 1, "keyB": {"sub1": 10, "sub2": 20}}
|
||
|
|
```
|
||
|
|
|
||
|
|
Deep merge into an existing dict.
|
||
|
|
```python3
|
||
|
|
from mergedeep import merge
|
||
|
|
|
||
|
|
a = {"keyA": 1}
|
||
|
|
b = {"keyB": {"sub1": 10}}
|
||
|
|
c = {"keyB": {"sub2": 20}}
|
||
|
|
|
||
|
|
merge(a, b, c)
|
||
|
|
|
||
|
|
print(a)
|
||
|
|
# {"keyA": 1, "keyB": {"sub1": 10, "sub2": 20}}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Merge strategies:
|
||
|
|
|
||
|
|
1. Replace (*default*)
|
||
|
|
|
||
|
|
> `Strategy.REPLACE`
|
||
|
|
|
||
|
|
```python3
|
||
|
|
# When `destination` and `source` keys are the same, replace the `destination` value with one from `source` (default).
|
||
|
|
|
||
|
|
# Note: with multiple sources, the `last` (i.e. rightmost) source value will be what appears in the merged result.
|
||
|
|
|
||
|
|
from mergedeep import merge, Strategy
|
||
|
|
|
||
|
|
dst = {"key": [1, 2]}
|
||
|
|
src = {"key": [3, 4]}
|
||
|
|
|
||
|
|
merge(dst, src, strategy=Strategy.REPLACE)
|
||
|
|
# same as: merge(dst, src)
|
||
|
|
|
||
|
|
print(dst)
|
||
|
|
# {"key": [3, 4]}
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Additive
|
||
|
|
|
||
|
|
> `Strategy.ADDITIVE`
|
||
|
|
|
||
|
|
```python3
|
||
|
|
# When `destination` and `source` values are both the same additive collection type, extend `destination` by adding values from `source`.
|
||
|
|
# Additive collection types include: `list`, `tuple`, `set`, and `Counter`
|
||
|
|
|
||
|
|
# Note: if the values are not additive collections of the same type, then fallback to a `REPLACE` merge.
|
||
|
|
|
||
|
|
from mergedeep import merge, Strategy
|
||
|
|
|
||
|
|
dst = {"key": [1, 2], "count": Counter({"a": 1, "b": 1})}
|
||
|
|
src = {"key": [3, 4], "count": Counter({"a": 1, "c": 1})}
|
||
|
|
|
||
|
|
merge(dst, src, strategy=Strategy.ADDITIVE)
|
||
|
|
|
||
|
|
print(dst)
|
||
|
|
# {"key": [1, 2, 3, 4], "count": Counter({"a": 2, "b": 1, "c": 1})}
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Typesafe replace
|
||
|
|
|
||
|
|
> `Strategy.TYPESAFE_REPLACE` or `Strategy.TYPESAFE`
|
||
|
|
|
||
|
|
```python3
|
||
|
|
# When `destination` and `source` values are of different types, raise `TypeError`. Otherwise, perform a `REPLACE` merge.
|
||
|
|
|
||
|
|
from mergedeep import merge, Strategy
|
||
|
|
|
||
|
|
dst = {"key": [1, 2]}
|
||
|
|
src = {"key": {3, 4}}
|
||
|
|
|
||
|
|
merge(dst, src, strategy=Strategy.TYPESAFE_REPLACE) # same as: `Strategy.TYPESAFE`
|
||
|
|
# TypeError: destination type: <class 'list'> differs from source type: <class 'set'> for key: "key"
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Typesafe additive
|
||
|
|
|
||
|
|
> `Strategy.TYPESAFE_ADDITIVE`
|
||
|
|
|
||
|
|
```python3
|
||
|
|
# When `destination` and `source` values are of different types, raise `TypeError`. Otherwise, perform a `ADDITIVE` merge.
|
||
|
|
|
||
|
|
from mergedeep import merge, Strategy
|
||
|
|
|
||
|
|
dst = {"key": [1, 2]}
|
||
|
|
src = {"key": {3, 4}}
|
||
|
|
|
||
|
|
merge(dst, src, strategy=Strategy.TYPESAFE_ADDITIVE)
|
||
|
|
# TypeError: destination type: <class 'list'> differs from source type: <class 'set'> for key: "key"
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [**Travis Clarke**](https://blog.travismclarke.com/)
|
||
|
|
|
||
|
|
|