mergedeep


Namemergedeep JSON
Version 1.3.4 PyPI version JSON
download
home_pagehttps://github.com/clarketm/mergedeep
SummaryA deep merge function for 🐍.
upload_time2021-02-05 18:55:30
maintainer
docs_urlNone
authorTravis Clarke
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # [mergedeep](https://mergedeep.readthedocs.io/en/latest/)

[![PyPi release](https://img.shields.io/pypi/v/mergedeep.svg)](https://pypi.org/project/mergedeep/)
[![PyPi versions](https://img.shields.io/pypi/pyversions/mergedeep.svg)](https://pypi.org/project/mergedeep/)
[![Downloads](https://pepy.tech/badge/mergedeep)](https://pepy.tech/project/mergedeep)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/mergedeep.svg)](https://anaconda.org/conda-forge/mergedeep)
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/mergedeep.svg)](https://anaconda.org/conda-forge/mergedeep)
[![Documentation Status](https://readthedocs.org/projects/mergedeep/badge/?version=latest)](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 &copy; [**Travis Clarke**](https://blog.travismclarke.com/)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clarketm/mergedeep",
    "name": "mergedeep",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Travis Clarke",
    "author_email": "travis.m.clarke@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz",
    "platform": "",
    "description": "# [mergedeep](https://mergedeep.readthedocs.io/en/latest/)\n\n[![PyPi release](https://img.shields.io/pypi/v/mergedeep.svg)](https://pypi.org/project/mergedeep/)\n[![PyPi versions](https://img.shields.io/pypi/pyversions/mergedeep.svg)](https://pypi.org/project/mergedeep/)\n[![Downloads](https://pepy.tech/badge/mergedeep)](https://pepy.tech/project/mergedeep)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/mergedeep.svg)](https://anaconda.org/conda-forge/mergedeep)\n[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/mergedeep.svg)](https://anaconda.org/conda-forge/mergedeep)\n[![Documentation Status](https://readthedocs.org/projects/mergedeep/badge/?version=latest)](https://mergedeep.readthedocs.io/en/latest/?badge=latest)\n\nA deep merge function for \ud83d\udc0d.\n\n[Check out the mergedeep docs](https://mergedeep.readthedocs.io/en/latest/)\n\n## Installation\n\n```bash\n$ pip install mergedeep\n```\n\n## Usage\n\n```text\nmerge(destination: MutableMapping, *sources: Mapping, strategy: Strategy = Strategy.REPLACE) -> MutableMapping\n```\n\nDeep merge without mutating the source dicts.\n\n```python3\nfrom mergedeep import merge\n\na = {\"keyA\": 1}\nb = {\"keyB\": {\"sub1\": 10}}\nc = {\"keyB\": {\"sub2\": 20}}\n\nmerged = merge({}, a, b, c) \n\nprint(merged)\n# {\"keyA\": 1, \"keyB\": {\"sub1\": 10, \"sub2\": 20}}\n```\n\nDeep merge into an existing dict.\n```python3\nfrom mergedeep import merge\n\na = {\"keyA\": 1}\nb = {\"keyB\": {\"sub1\": 10}}\nc = {\"keyB\": {\"sub2\": 20}}\n\nmerge(a, b, c) \n\nprint(a)\n# {\"keyA\": 1, \"keyB\": {\"sub1\": 10, \"sub2\": 20}}\n```\n\n### Merge strategies:\n\n1. Replace (*default*)\n\n> `Strategy.REPLACE`\n\n```python3\n# When `destination` and `source` keys are the same, replace the `destination` value with one from `source` (default).\n\n# Note: with multiple sources, the `last` (i.e. rightmost) source value will be what appears in the merged result. \n\nfrom mergedeep import merge, Strategy\n\ndst = {\"key\": [1, 2]}\nsrc = {\"key\": [3, 4]}\n\nmerge(dst, src, strategy=Strategy.REPLACE) \n# same as: merge(dst, src)\n\nprint(dst)\n# {\"key\": [3, 4]}\n```\n\n2. Additive\n\n> `Strategy.ADDITIVE`\n\n```python3\n# When `destination` and `source` values are both the same additive collection type, extend `destination` by adding values from `source`.\n# Additive collection types include: `list`, `tuple`, `set`, and `Counter`\n\n# Note: if the values are not additive collections of the same type, then fallback to a `REPLACE` merge.\n\nfrom mergedeep import merge, Strategy\n\ndst = {\"key\": [1, 2], \"count\": Counter({\"a\": 1, \"b\": 1})}\nsrc = {\"key\": [3, 4], \"count\": Counter({\"a\": 1, \"c\": 1})}\n\nmerge(dst, src, strategy=Strategy.ADDITIVE) \n\nprint(dst)\n# {\"key\": [1, 2, 3, 4], \"count\": Counter({\"a\": 2, \"b\": 1, \"c\": 1})}\n```\n\n3. Typesafe replace\n\n> `Strategy.TYPESAFE_REPLACE` or `Strategy.TYPESAFE`\n\n```python3\n# When `destination` and `source` values are of different types, raise `TypeError`. Otherwise, perform a `REPLACE` merge.\n\nfrom mergedeep import merge, Strategy\n\ndst = {\"key\": [1, 2]}\nsrc = {\"key\": {3, 4}}\n\nmerge(dst, src, strategy=Strategy.TYPESAFE_REPLACE) # same as: `Strategy.TYPESAFE`  \n# TypeError: destination type: <class 'list'> differs from source type: <class 'set'> for key: \"key\"\n```\n\n4. Typesafe additive\n\n> `Strategy.TYPESAFE_ADDITIVE`\n\n```python3\n# When `destination` and `source` values are of different types, raise `TypeError`. Otherwise, perform a `ADDITIVE` merge.\n\nfrom mergedeep import merge, Strategy\n\ndst = {\"key\": [1, 2]}\nsrc = {\"key\": {3, 4}}\n\nmerge(dst, src, strategy=Strategy.TYPESAFE_ADDITIVE) \n# TypeError: destination type: <class 'list'> differs from source type: <class 'set'> for key: \"key\"\n```\n\n## License\n\nMIT &copy; [**Travis Clarke**](https://blog.travismclarke.com/)\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A deep merge function for \ud83d\udc0d.",
    "version": "1.3.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fcb7aadbcac6370b73c72dd3cdc748cb",
                "sha256": "70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"
            },
            "downloads": -1,
            "filename": "mergedeep-1.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fcb7aadbcac6370b73c72dd3cdc748cb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 6354,
            "upload_time": "2021-02-05T18:55:29",
            "upload_time_iso_8601": "2021-02-05T18:55:29.583731Z",
            "url": "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "51a3e922eb1f515c2dc6542e0dbb8784",
                "sha256": "0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"
            },
            "downloads": -1,
            "filename": "mergedeep-1.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "51a3e922eb1f515c2dc6542e0dbb8784",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4661,
            "upload_time": "2021-02-05T18:55:30",
            "upload_time_iso_8601": "2021-02-05T18:55:30.623988Z",
            "url": "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-05 18:55:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "clarketm",
    "github_project": "mergedeep",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "tox": true,
    "lcname": "mergedeep"
}
        
Elapsed time: 0.04784s