switch to safe_load; create load_yaml helper function

Author: stevebachmeier

src/layered_config_tree/__init__.py

@@ -14,4 +14,4 @@
     DuplicatedConfigurationError,
     ImproperAccessError,
 )
-from layered_config_tree.main import ConfigNode, LayeredConfigTree
+from layered_config_tree.main import ConfigNode, LayeredConfigTree, load_yaml

src/layered_config_tree/main.py

@@ -464,17 +464,17 @@ def _coerce(
         elif (isinstance(data, str) and data.endswith((".yaml", ".yml"))) or isinstance(
             data, Path
         ):
+            # 'data' is a filepath to a yaml file
             source = source if source else str(data)
-            with open(data) as f:
-                data_file = f.read()
-            coerced_data = yaml.full_load(data_file)
+            coerced_data = load_yaml(data)
             if not isinstance(coerced_data, dict):
                 raise ValueError(
                     f"Loaded yaml file {coerced_data} should be a dictionary but is type {type(coerced_data)}"
                 )
             return coerced_data, source
         elif isinstance(data, str):
-            data = yaml.full_load(data)
+            # 'data' is a yaml string
+            data = load_yaml(data)
             if not isinstance(data, dict):
                 raise ValueError(
                     f"Loaded yaml file {data} should be a dictionary but is type {type(data)}"
@@ -671,3 +671,39 @@ def __str__(self) -> str:
 
     def __eq__(self, other: object) -> bool:
         raise NotImplementedError
+
+
+# class UniqueKeyHandler(SafeLoader):
+#     ...
+
+
+def load_yaml(data: str | Path) -> dict[str, Any]:
+    """Loads a YAML filepath or string into a dictionary.
+
+    Parameters
+    ----------
+    data
+        The YAML content to load. This can be a file path to a YAML file or a string
+        containing YAML-formatted text.
+
+    Returns
+    -------
+        A dictionary representation of the loaded YAML content.
+
+    Notes
+    -----
+    If `data` is a Path object or a string that ends with ".yaml" or ".yml", it is
+    treated as a filepath and this function loads the file. Otherwise, `data` is a
+    string that does _not_ end in ".yaml" or ".yml" and it is treated as YAML-formatted
+    text which is loaded directly into a dictionary.
+    """
+
+    if (isinstance(data, str) and data.endswith((".yaml", ".yml"))) or isinstance(data, Path):
+        # 'data' is a filepath to a yaml file
+        with open(data) as f:
+            data_file = f.read()
+        data_dict = yaml.safe_load(data_file)
+    else:
+        # 'data' is a yaml string
+        data_dict = yaml.safe_load(data)
+    return data_dict

tests/test_basic_functionality.py

@@ -14,6 +14,7 @@
     DuplicatedConfigurationError,
     ImproperAccessError,
     LayeredConfigTree,
+    load_yaml,
 )
 
 
@@ -500,8 +501,7 @@ def test_to_dict_dict() -> None:
 
 def test_to_dict_yaml(test_spec: Path) -> None:
     lct = LayeredConfigTree(str(test_spec))
-    with test_spec.open() as f:
-        yaml_config = yaml.full_load(f)
+    yaml_config = load_yaml(test_spec)
     assert yaml_config == lct.to_dict()
 
 

tests/test_ingestion.py

@@ -1,5 +1,7 @@
 from pathlib import Path
 
+import pytest
+
 from layered_config_tree import LayeredConfigTree
 
 TEST_YAML_ONE = """
@@ -21,12 +23,14 @@ def test_load_yaml_string() -> None:
     assert lct.test_section2.test_key == "test_value3"
 
 
-def test_load_yaml_file(tmp_path: Path) -> None:
+@pytest.mark.parametrize("path_type", [str, Path])
+def test_load_yaml_file(tmp_path: Path, path_type: type[str | Path]) -> None:
     tmp_file = tmp_path / "test_file.yaml"
     tmp_file.write_text(TEST_YAML_ONE)
 
     lct = LayeredConfigTree()
-    lct.update(str(tmp_file))
+    filepath_to_test = str(tmp_file) if path_type is str else tmp_file
+    lct.update(filepath_to_test)
 
     assert lct.test_section.test_key == "test_value"
     assert lct.test_section.test_key2 == "test_value2"