v1.3.2 - add py.typed and update typings, close #2

Author: clarketm

README.md

@@ -20,7 +20,7 @@ $ pip install mergedeep
 ## Usage
 
 ```text
-merge(destination: Map[KT, VT], *sources: Map[KT, VT], strategy: Strategy = Strategy.REPLACE) -> Map[KT, VT]
+merge(destination: Dict, *sources: Dict, strategy: Strategy = Strategy.REPLACE) -> Dict
 ```
 
 Deep merge without mutating the source dicts.

docs/source/index.md

@@ -32,7 +32,7 @@ $ pip install mergedeep
 ## Usage
 
 ```text
-merge(destination: Map[KT, VT], *sources: Map[KT, VT], strategy: Strategy = Strategy.REPLACE) -> Map[KT, VT]
+merge(destination: Dict, *sources: Dict, strategy: Strategy = Strategy.REPLACE) -> Dict
 ```
 
 Deep merge without mutating the source dicts.

example.py

@@ -0,0 +1,10 @@
+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}}

mergedeep/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.1"
+__version__ = "1.3.2"
 
 from mergedeep.mergedeep import merge, Strategy
 

mergedeep/mergedeep.py

@@ -3,10 +3,7 @@
 from copy import deepcopy
 from enum import Enum
 from functools import reduce, partial
-from typing import TypeVar, MutableMapping as Map
-
-KT = TypeVar("KT")
-VT = TypeVar("VT")
+from typing import Dict
 
 
 class Strategy(Enum):
@@ -74,10 +71,10 @@ def _is_recursive_merge(a, b) -> bool:
     return both_mapping and not both_counter
 
 
-def _deepmerge(dst: Map[KT, VT], src: Map[KT, VT], strategy: Strategy = Strategy.REPLACE):
+def _deepmerge(dst: Dict, src: Dict, strategy: Strategy = Strategy.REPLACE):
     """
-    :param dst: Map[KT, VT]:
-    :param src: Map[KT, VT]:
+    :param dst: Dict:
+    :param src: Dict:
     """
     for key in src:
         if key in dst:
@@ -95,12 +92,12 @@ def _deepmerge(dst: Map[KT, VT], src: Map[KT, VT], strategy: Strategy = Strategy
     return dst
 
 
-def merge(destination: Map[KT, VT], *sources: Map[KT, VT], strategy: Strategy = Strategy.REPLACE) -> Map[KT, VT]:
+def merge(destination: Dict, *sources: Dict, strategy: Strategy = Strategy.REPLACE) -> Dict:
     """
     A deep merge function for 🐍.
 
-    :param destination: Map[KT, VT]:
-    :param *sources: Map[KT, VT]:
+    :param destination: Dict:
+    :param *sources: Dict:
     :param strategy: Strategy (Default: Strategy.REPLACE):
     """
     return reduce(partial(_deepmerge, strategy=strategy), sources, destination)

py.typed

@@ -19,6 +19,7 @@ def open_local(paths, mode="r", encoding="utf8"):
     url="https://github.com/clarketm/mergedeep",
     python_requires=">=3.6",
     packages=setuptools.find_packages(),
+    package_data={"mergedeep": ["py.typed"]},
     classifiers=(
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",