v1.3.3 - refine types and docstrings

Author: clarketm

Makefile

@@ -20,10 +20,11 @@ test-setup:
 	@pyenv install -s 3.6.10
 	@pyenv install -s 3.7.7
 	@pyenv install -s 3.8.2
+	@pyenv install -s 3.9.1
 
 .PHONY: test
 test: test-setup
-	@pyenv local 3.6.10 3.7.7 3.8.2
+	@pyenv local 3.6.10 3.7.7 3.8.2 3.9.1
 	@$(PYTHON) -m tox
 
 .PHONY: clean

README.md

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

docs/source/index.md

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

mergedeep/__init__.py

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

mergedeep/mergedeep.py

@@ -3,7 +3,7 @@
 from copy import deepcopy
 from enum import Enum
 from functools import reduce, partial
-from typing import Dict
+from typing import MutableMapping
 
 
 class Strategy(Enum):
@@ -65,17 +65,13 @@ def _handle_merge_typesafe(destination, source, key, strategy):
 }
 
 
-def _is_recursive_merge(a, b) -> bool:
+def _is_recursive_merge(a, b):
     both_mapping = isinstance(a, Mapping) and isinstance(b, Mapping)
     both_counter = isinstance(a, Counter) and isinstance(b, Counter)
     return both_mapping and not both_counter
 
 
-def _deepmerge(dst: Dict, src: Dict, strategy: Strategy = Strategy.REPLACE):
-    """
-    :param dst: Dict:
-    :param src: Dict:
-    """
+def _deepmerge(dst, src, strategy=Strategy.REPLACE):
     for key in src:
         if key in dst:
             if _is_recursive_merge(dst[key], src[key]):
@@ -92,12 +88,13 @@ def _deepmerge(dst: Dict, src: Dict, strategy: Strategy = Strategy.REPLACE):
     return dst
 
 
-def merge(destination: Dict, *sources: Dict, strategy: Strategy = Strategy.REPLACE) -> Dict:
+def merge(destination: MutableMapping, *sources: Mapping, strategy: Strategy = Strategy.REPLACE) -> MutableMapping:
     """
     A deep merge function for 🐍.
 
-    :param destination: Dict:
-    :param *sources: Dict:
-    :param strategy: Strategy (Default: Strategy.REPLACE):
+    :param destination: The destination mapping.
+    :param sources: The source mappings.
+    :param strategy: The merge strategy.
+    :return:
     """
     return reduce(partial(_deepmerge, strategy=strategy), sources, destination)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36,py37,py38
+envlist = py36,py37,py38,py39
 
 [testenv]
 deps = pytest