Add tests, indent in dump_json

Author: connorferster

src/jsonchain/__init__.py

@@ -1,3 +1,10 @@
+"""
+A small package to aid in the use of the chaining techniques taught by Structural Python
+"""
+
+__version__ = "0.1.0"
+
+
 import json
 import pathlib
 from typing import Any, Optional
@@ -10,13 +17,13 @@ def load_json(filepath: str | pathlib.Path) -> dict | list:
         return json.load(file)
 
 
-def dump_json(object: list | dict, filepath: str | pathlib.Path) -> None:
+def dump_json(object: list | dict, filepath: str | pathlib.Path, indent=2) -> None:
     """
     Dumps the 'object' (which must be JSON-serializable) into a JSON
     file at 'filepath'.
     """
     with open(filepath, 'w') as file:
-        json.dump(object, file)
+        json.dump(object, file, indent=indent)
 
 
 def extract_keys(
@@ -55,6 +62,4 @@ def extract_keys(
         elif include_startswith is None:
             acc.append({key_name: key})
 
-    return acc
-
-
+    return acc

tests/a.json

@@ -0,0 +1,5 @@
+{
+    "aa": 1,
+    "ab": 2,
+    "bc": 3
+}

tests/test_jsonchain.py

@@ -0,0 +1,29 @@
+from jsonchain import load_json, dump_json, extract_keys
+
+
+def test_load_json():
+    a_dict = load_json("a.json")
+    assert a_dict['aa'] == 1
+    assert a_dict['ab'] == 2
+    assert a_dict['bc'] == 3
+
+
+def test_extract_keys():
+    a_dict = load_json("a.json")
+    loks = extract_keys(a_dict, key_name="group")
+    assert loks == [
+        {"group": "aa"},
+        {"group": "ab"},
+        {"group": "bc"}
+    ]
+    loks_a = extract_keys(a_dict, key_name="group", include_startswith="a")
+    assert loks_a == [
+        {"group": "aa"},
+        {"group": "ab"}
+    ]
+    loks_b = extract_keys(a_dict, key_name="group", exclude_startswith="b")
+    assert loks_b == [
+        {"group": "aa"},
+        {"group": "ab"},
+    ]
+