fix dict cleaning & added tests

Author: Kraysent

hyperleda/client.py

@@ -6,24 +6,7 @@
 import pandas
 import requests
 
-from hyperleda import config, error, model
-
-
-def _clean_dict(d):
-    """
-    Recursively remove keys with None values from the dictionary.
-    """
-    clean = {}
-    for k, v in d.items():
-        if isinstance(v, dict):
-            nested = _clean_dict(v)
-            if nested:  # Only add non-empty nested dictionaries
-                clean[k] = nested
-        elif isinstance(v, list):
-            clean[k] = [_clean_dict(item) for item in v]
-        elif v is not None:
-            clean[k] = v
-    return clean
+from hyperleda import config, error, model, utils
 
 
 def _marshaller(obj):
@@ -53,7 +36,7 @@ def _request(
         kwargs = {}
 
         if body is not None:
-            body = _clean_dict(body) if body is not None else None
+            body = utils.clean_dict(body) if body is not None else None
             data = json.dumps(body, default=_marshaller)
             kwargs["data"] = data
 

hyperleda/utils.py

@@ -0,0 +1,23 @@
+from typing import Any
+
+
+def clean_dict(d: Any) -> Any:
+    """
+    Recursively remove keys with None values from the dictionary.
+    """
+    if isinstance(d, list):
+        return [clean_dict(item) for item in d]
+
+    if isinstance(d, dict):
+        clean = {}
+        for k, v in d.items():
+            if isinstance(v, dict):
+                nested = clean_dict(v)
+
+                if nested:  # Only add non-empty nested dictionaries
+                    clean[k] = nested
+            elif v is not None:
+                clean[k] = clean_dict(v)
+        return clean
+
+    return d

pyproject.toml

@@ -20,6 +20,7 @@ dependencies = [
     "build>=1.2.2.post1",
     "datamodel-code-generator>=0.26.5",
     "pandas>=2.2.3",
+    "parameterized>=0.9.0",
     "requests>=2.32.3",
     "ruff>=0.9.4",
     "setuptools>=75.8.0",

requirements.txt

@@ -0,0 +1,49 @@
+import unittest
+
+from parameterized import param, parameterized
+
+from hyperleda import utils
+
+
+class DictCleaningTest(unittest.TestCase):
+    @parameterized.expand(
+        [
+            param(
+                "no cleaning",
+                {"a": 1, "b": 2},
+                {"a": 1, "b": 2},
+            ),
+            param(
+                "first level",
+                {"a": 1, "b": None},
+                {"a": 1},
+            ),
+            param(
+                "third level",
+                {"a": 1, "b": {"c": {"d": None}}},
+                {"a": 1},
+            ),
+            param(
+                "list",
+                [{"a": 1, "b": None}, {"a": 2, "b": 3}],
+                [{"a": 1}, {"a": 2, "b": 3}],
+            ),
+            param(
+                "list in dict",
+                {"a": 1, "b": {"c": [{"d": None}, {"e": 2}]}},
+                {"a": 1, "b": {"c": [{}, {"e": 2}]}},
+            ),
+            param(
+                "list in list",
+                [[{"c": 2}], [{"a": 1, "b": None}]],
+                [[{"c": 2}], [{"a": 1}]],
+            ),
+            param(
+                "list of primitives",
+                [1, None, 3],
+                [1, None, 3],
+            ),
+        ]
+    )
+    def test_table(self, name, data, expected):
+        self.assertEqual(utils.clean_dict(data), expected)