fix: updating params with kwargs (#145)

* fix updating params with kwargs

* whitespace

* changelog

* lint/format

* small optimization to not needlessly do shallow copies

Author: nilsnolde

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Fixed type hint on `Matrix.distances` and `Matrix.durations` ([#132](https://github.com/mthh/routingpy/pull/132))
 - Added missing support for `kwargs` to Valhalla's `matrix` creation function ([#135](https://github.com/mthh/routingpy/pull/135))
 - Fixed Valhalla's `expansion` method to follow the latest Valhalla API changes ([#142](https://github.com/mthh/routingpy/pull/142))
+- Updating params with `kwargs` [#145](https://github.com/mthh/routingpy/pull/145)
 
 ### Removed
 

routingpy/routers/graphhopper.py

@@ -353,7 +353,7 @@ def directions(  # noqa: C901
                 if alternative_route_max_share_factor:
                     params["alternative_route_max_share_factor"] = alternative_route_max_share_factor
 
-        params.update(direction_kwargs)
+        params = utils.deep_merge_dicts(params, direction_kwargs)
 
         return self.parse_directions_json(
             self.client._request("/route", get_params=get_params, post_params=params, dry_run=dry_run),

routingpy/routers/heremaps.py

@@ -18,7 +18,7 @@
 from operator import itemgetter
 from typing import List, Optional, Tuple, Union
 
-from .. import convert
+from .. import convert, utils
 from ..client_base import DEFAULT
 from ..client_default import Client
 from ..direction import Direction, Directions
@@ -770,7 +770,7 @@ def directions(  # noqa: C901
         if speed_profile is not None:
             params["speedProfile"] = speed_profile
 
-        params.update(directions_kwargs)
+        params = utils.deep_merge_dicts(params, directions_kwargs)
 
         return self.parse_direction_json(
             self.client._request(
@@ -1073,7 +1073,7 @@ def isochrones(  # noqa: C901
         if speed_profile is not None:
             params["speedProfile"] = speed_profile
 
-        params.update(isochrones_kwargs)
+        params = utils.deep_merge_dicts(params, isochrones_kwargs)
 
         return self.parse_isochrone_json(
             self.client._request(
@@ -1370,7 +1370,7 @@ def matrix(  # noqa: C901
         if speed_profile is not None:
             params["speedProfile"] = speed_profile
 
-        params.update(matrix_kwargs)
+        params = utils.deep_merge_dicts(params, matrix_kwargs)
 
         return self.parse_matrix_json(
             self.client._request(

routingpy/routers/osrm.py

@@ -240,7 +240,7 @@ def get_direction_params(
         if overview is not None:
             params["overview"] = convert.convert_bool(overview)
 
-        params.update(directions_kwargs)
+        params = utils.deep_merge_dicts(params, directions_kwargs)
 
         return params
 
@@ -406,7 +406,7 @@ def get_matrix_params(
         if annotations:
             params["annotations"] = convert.delimit_list(annotations)
 
-        params.update(matrix_kwargs)
+        params = utils.deep_merge_dicts(params, matrix_kwargs)
 
         return params
 

routingpy/routers/valhalla.py

@@ -252,7 +252,7 @@ def get_direction_params(
             params["id"] = id
 
         # update with kw args
-        params.update(kwargs)
+        params = utils.deep_merge_dicts(params, kwargs)
 
         return params
 
@@ -460,7 +460,7 @@ def get_isochrone_params(  # noqa: C901
         if id:
             params["id"] = id
 
-        params.update(kwargs)
+        params = utils.deep_merge_dicts(params, kwargs)
 
         return params
 
@@ -623,7 +623,7 @@ def get_matrix_params(
         if id:
             params["id"] = id
 
-        params.update(kwargs)
+        params = utils.deep_merge_dicts(params, kwargs)
 
         return params
 
@@ -743,7 +743,7 @@ def get_expansion_params(
         if expansion_properties:
             params["expansion_properties"] = expansion_properties
 
-        params.update(kwargs)
+        params = utils.deep_merge_dicts(params, kwargs)
 
         return params
 
@@ -846,7 +846,7 @@ def get_trace_attributes_params(
             if options:
                 params["costing_options"][profile] = options
 
-        params.update(kwargs)
+        params = utils.deep_merge_dicts(params, kwargs)
 
         return params
 

routingpy/utils.py

@@ -125,6 +125,25 @@ def get_ordinal(number):
         return "th"
 
 
+def deep_merge_dicts(d1: dict, d2: dict) -> dict:
+    """
+    Recursively deep merges two dictionaries.
+    Values from d2 will overwrite or be merged into d1.
+    """
+    if not d2:
+        return d1
+
+    result = d1.copy()  # Start with a shallow copy of dict1
+    for key, value in d2.items():
+        if key in result and isinstance(result[key], dict) and isinstance(value, dict):
+            # Both values are dicts: recurse
+            result[key] = deep_merge_dicts(result[key], value)
+        else:
+            # Otherwise, override or add
+            result[key] = value
+    return result
+
+
 def _get_coords(lat, lng, factor, order="lnglat"):
     """Determines coordinate order."""
     if order not in ("lnglat", "latlng"):

tests/test_utils.py

@@ -52,3 +52,23 @@ def test_get_ordinal(self):
         self.assertEqual(utils.get_ordinal(1), "st")
         self.assertEqual(utils.get_ordinal(2), "nd")
         self.assertEqual(utils.get_ordinal(3), "rd")
+
+    def test_deep_merge_dicts(self):
+        d = {}
+        d = utils.deep_merge_dicts(d, {"k": "v"})
+        self.assertEqual(d, {"k": "v"})
+        d = utils.deep_merge_dicts(d, {"k": {"k1": 1, "k2": 2}})
+        self.assertEqual(d, {"k": {"k1": 1, "k2": 2}})
+        d = utils.deep_merge_dicts(
+            d,
+            {
+                "k": {
+                    "k1": 0,
+                }
+            },
+        )
+        self.assertEqual(d, {"k": {"k1": 0, "k2": 2}})
+        d = utils.deep_merge_dicts(d, {"l": []})
+        self.assertEqual(d, {"k": {"k1": 0, "k2": 2}, "l": []})
+        d = utils.deep_merge_dicts(d, {"l": [1]})
+        self.assertEqual(d, {"k": {"k1": 0, "k2": 2}, "l": [1]})