Feature/SOF-7781 Update: add filter out Nones

src/py/mat3ra/utils/object.py

@@ -1,6 +1,6 @@
 import copy
 import json
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 import numpy as np
 from mat3ra.utils.mixins import RoundNumericValuesMixin
@@ -32,6 +32,28 @@ def get(config: Dict, path: str = "", separator: str = "/") -> Any:
     return config
 
 
+def filter_out_none_values(data: Dict[str, Any], keep_as_none: Optional[List[str]] = None) -> Dict[str, Any]:
+    keep_as_none_set = set(keep_as_none) if keep_as_none else set()
+    return _filter_out_none_values_recursive(data, keep_as_none_set)
+
+
+def _filter_out_none_values_recursive(obj: Any, keep_as_none_set: set) -> Any:
+    if isinstance(obj, dict):
+        return {
+            k: _filter_out_none_values_recursive(v, keep_as_none_set)
+            for k, v in obj.items()
+            if v is not None or k in keep_as_none_set
+        }
+    elif isinstance(obj, list):
+        return [
+            _filter_out_none_values_recursive(item, keep_as_none_set)
+            for item in obj
+            if item is not None
+        ]
+    else:
+        return obj
+
+
 class AttributeDict(dict):
     """
     Subclass of dict that allows read-only attribute-like access to dictionary key/values

tests/py/unit/test_object.py

@@ -10,6 +10,25 @@
 REFERENCE_OBJECT_2_CLONE_SHALLOW = {"key2": {"nested_key1": "nested_value1"}}
 REFERENCE_OBJECT_2_CLONE_DEEP = {"key2": {"nested_key1": "nested_value1"}}
 REFERENCE_OBJECT_2_GET = {"key2": {"nested_key1": "nested_value1"}}
+REFERENCE_OBJECT_WITH_NONES = {
+    "key1": "value1",
+    "key2": None,
+    "key3": {
+        "nested_key1": "nested_value1",
+        "nested_key2": None,
+    },
+    "key4": [1, 2, None, 4],
+    "key5": None
+}
+REFERENCE_OBJECT_WITH_SOME_NONES_FILTERED = {
+    "key1": "value1",
+    "key3": {
+        "nested_key1": "nested_value1",
+        "nested_key2": None,
+    },
+    "key4": [1, 2, 4],
+    "key5": None
+}
 
 
 def test_omit():
@@ -42,6 +61,12 @@ def test_get():
     assert nested_value1 == utils.get(REFERENCE_OBJECT_2_GET, "key2.nested_key1", ".")
 
 
+def test_filter_out_none_values():
+    filtered_object = utils.filter_out_none_values(REFERENCE_OBJECT_WITH_NONES, keep_as_none=["key5", "nested_key2"])
+
+    assert filtered_object == REFERENCE_OBJECT_WITH_SOME_NONES_FILTERED
+
+
 def test_attribute_dict():
     attribute_dict = utils.AttributeDict(REFERENCE_OBJECT_1)
     assert attribute_dict.key1 == "value1"