Merge branch 'main' into releases/v0.3.1

Author: connorferster

pyproject.toml

@@ -9,6 +9,7 @@ requires-python = ">=3.10"
 dependencies = [
     "deepmerge",
     "openpyxl"
+    "safer"
 ]
 
 [project.scripts]

src/jsonchain/__init__.py

@@ -2,7 +2,7 @@
 A small package to aid in the use of the chaining techniques taught by Structural Python
 """
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 
 from .io import (load_json, dump_json)

src/jsonchain/envelope.py

@@ -3,20 +3,27 @@
 
 PYMAX = max
 PYMIN = min
+PYABS = abs
 
-def envelope_tree(tree: dict | list, levels: list[Hashable | None], leaf: Hashable | None, agg_func: callable, with_trace: bool = True) -> dict:
+def envelope_tree(
+        tree: dict | list, 
+        levels: list[Hashable | None], 
+        leaf: Hashable | None, 
+        agg_func: callable, 
+        with_trace: bool = True
+    ) -> dict:
     """
-    Envelopes the tree at the leaf node with 'agg_func'.
+    Returns a new dict tree
     """
     env_acc = {}
     # If we are at the last branch...
     if not levels:
         if isinstance(tree, list):
             tree = {idx: leaf for idx, leaf in enumerate(tree)}
         leaf_acc = {}
-        for k, leaves in tree.items():
-            if leaf is not None:
-                leaf_acc.update({k: leaves[leaf]})
+        for leaf_key, leaf_value in tree.items():
+            if leaf is not None and leaf_key == leaf:
+                leaf_acc.update({leaf_key: leaf_value})
             else:
                 leaf_acc = tree
         # ...create a dict of the enveloped value and the key
@@ -85,4 +92,13 @@ def min(x: list[float | int | None]) -> float | int | None:
     Returns the max value in 'x' while ignoring "None".
     If all values in 'x' are None, then None is returned.
     """
-    return PYMIN([y for y in x if y is not None])
+    return PYMIN([y for y in x if y is not None])
+
+
+def abs(x: float | int | None) -> float | int | None:
+    """
+    Performs abs but passes None through if x is None.
+    """
+    if x is None:
+        return x
+    return abs(x)

src/jsonchain/io.py

@@ -1,12 +1,13 @@
 import json
 import pathlib
+import safer
 from typing import Any, Optional
 
 def load_json(filepath: str | pathlib.Path) -> dict | list:
     """
     Loads the JSON data at 'filepath' into a Python object.
     """
-    with open(filepath, 'r') as file:
+    with safer.open(filepath, 'r') as file:
         return json.load(file)
 
 
@@ -15,5 +16,5 @@ def dump_json(object: list | dict, filepath: str | pathlib.Path, indent=2) -> No
     Dumps the 'object' (which must be JSON-serializable) into a JSON
     file at 'filepath'.
     """
-    with open(filepath, 'w') as file:
+    with safer.open(filepath, 'w') as file:
         json.dump(object, file, indent=indent)

src/jsonchain/tree.py

@@ -106,7 +106,8 @@ def retrieve_leaves(
     leaf: list[Hashable] | Hashable | None,
 ) -> dict:
     """
-    Envelopes the tree at the leaf node with 'agg_func'.
+    Retrieves the leaf nodes at levels -> leaf and puts the leaf nodes
+    under the top-level keys.
     """
     env_acc = {}
     key_error_msg = (
@@ -195,6 +196,7 @@ def filter_keys(
     tree: dict,
     include_keys: Optional[list[str]] = None,
     exclude_keys: Optional[list[str]] = None,
+    include_startswith: Optional[str | list[str]] = None,
     include_keys_startswith: Optional[str | list[str]] = None
     ) -> dict:
     """