test: add tests for falsy value handling in list utils

Signed-off-by: Rishi Jat <rishijat098@gmail.com>

Author: rishi-jat

tests/trestle/utils/list_utils_test.py

@@ -146,3 +146,49 @@ def test_deep_update() -> None:
         list_utils.deep_update(d, [], {'x': 'y'})
     list_utils.deep_update(d, ['foo'], {'x': 'y'})
     assert d['foo'] == {'bar': {'a': 'b', 'c': 'd'}, 'x': 'y'}
+
+
+def test_deep_set_falsy_values() -> None:
+    """Test deep_set preserves falsy values that are not None."""
+    d: dict = {}
+    list_utils.deep_set(d, ['count'], 0)
+    assert d['count'] == 0
+
+    list_utils.deep_set(d, ['enabled'], False)
+    assert d['enabled'] is False
+
+    list_utils.deep_set(d, ['name'], '')
+    assert d['name'] == ''
+
+    list_utils.deep_set(d, ['items'], [])
+    assert d['items'] == []
+
+    list_utils.deep_set(d, ['meta'], {})
+    assert d['meta'] == {}
+
+    # None should still pop the key
+    list_utils.deep_set(d, ['count'], None)
+    assert 'count' not in d
+
+
+def test_set_or_pop_falsy_values() -> None:
+    """Test set_or_pop preserves falsy values that are not None."""
+    d: dict = {}
+
+    list_utils.set_or_pop(d, 'enabled', False)
+    assert d['enabled'] is False
+
+    list_utils.set_or_pop(d, 'name', '')
+    assert d['name'] == ''
+
+    list_utils.set_or_pop(d, 'count', 0)
+    assert d['count'] == 0
+
+    list_utils.set_or_pop(d, 'items', [])
+    assert d['items'] == []
+
+    # None should still remove the key
+    list_utils.set_or_pop(d, 'key', 'value')
+    assert d['key'] == 'value'
+    list_utils.set_or_pop(d, 'key', None)
+    assert 'key' not in d

trestle/common/list_utils.py

@@ -144,10 +144,10 @@ def deep_set(dic: Dict[str, Any], path: List[str], value: Any, pop_if_none: bool
     for node in path[:-1]:
         dic[node] = dic.get(node, {})
         dic = dic[node]
-    if value is not None or not pop_if_none:
-        dic[path[-1]] = value
+    if pop_if_none:
+        set_or_pop(dic, path[-1], value)
     else:
-        dic.pop(path[-1], None)
+        dic[path[-1]] = value
 
 
 def deep_get(dic: Dict[str, Any], path: List[str], default: Any = None) -> Any:
@@ -184,8 +184,13 @@ def deep_append(dic: Dict[str, Any], path: List[str], value: Any) -> None:
 
 
 def set_or_pop(dic: Dict[str, Any], key: str, value: Any) -> None:
-    """Set if value is non-empty list or not None otherwise remove."""
-    if value is not None:
-        dic[key] = value
-    else:
+    """Set value unless it is None or an empty container."""
+    if value is None:
         dic.pop(key, None)
+        return
+
+    if isinstance(value, (list, dict, set)) and not value:
+        dic.pop(key, None)
+        return
+
+    dic[key] = value