PySerials 0.1.0__tar.gz → 0.1.2__tar.gz

{pyserials-0.1.0 → pyserials-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PySerials
-Version: 0.1.0
+Version: 0.1.2
 Requires-Python: >=3.10
 Requires-Dist: jsonschema<5,>=4.21.0
 Requires-Dist: referencing>=0.35.1

{pyserials-0.1.0 → pyserials-0.1.2}/pyproject.toml

@@ -17,7 +17,7 @@ namespaces = true
 # ----------------------------------------- Project Metadata -------------------------------------
 #
 [project]
-version = "0.1.0"
+version = "0.1.2"
 name = "PySerials"
 dependencies = [
     "jsonschema >= 4.21.0, < 5",

{pyserials-0.1.0 → pyserials-0.1.2}/src/PySerials.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PySerials
-Version: 0.1.0
+Version: 0.1.2
 Requires-Python: >=3.10
 Requires-Dist: jsonschema<5,>=4.21.0
 Requires-Dist: referencing>=0.35.1

{pyserials-0.1.0 → pyserials-0.1.2}/src/PySerials.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ src/PySerials.egg-info/requires.txt
 src/PySerials.egg-info/top_level.txt
 src/pyserials/__init__.py
 src/pyserials/compare.py
+src/pyserials/flatten.py
 src/pyserials/format.py
 src/pyserials/nested_dict.py
 src/pyserials/property_dict.py

{pyserials-0.1.0 → pyserials-0.1.2}/src/pyserials/__init__.py

@@ -3,3 +3,4 @@
 from pyserials import exception, update, validate, read, write, format, compare
 from pyserials.nested_dict import NestedDict
 from pyserials.property_dict import PropertyDict
+from pyserials.flatten import flatten

pyserials-0.1.2/src/pyserials/flatten.py

@@ -0,0 +1,51 @@
+def flatten(data: dict | list[dict]) -> dict | list[dict]:
+    """Flatten a nested dictionary into a single-level dictionary.
+
+    Parameters
+    ----------
+    data
+        A dictionary or a list of dictionaries to flatten.
+
+    Returns
+    -------
+    If `data` is a dictionary, returns a flattened dictionary.
+    If `data` is a list of dictionaries, returns a list of flattened dictionaries.
+    """
+    if isinstance(data, dict):
+        return _flatten(data)
+    if isinstance(data, list):
+        if not data:
+            return []
+        if not all(isinstance(item, dict) for item in data):
+            raise ValueError("All items in the list must be dictionaries.")
+        return [_flatten(item) for item in data]
+    raise ValueError("Input must be a dictionary or a list of dictionaries.")
+
+
+def _flatten(data, output: dict | None = None, path: str | None = None):
+    output = output if output is not None else {}
+    if isinstance(data, str | int | float | bool | None):
+        output[path] = data
+        return output
+    if isinstance(data, dict):
+        for key, value in data.items():
+            new_path = _flatten_key(path, key)
+            _flatten(data=value, output=output, path=new_path)
+        return output
+    if isinstance(data, list):
+        if len(data) == 0:
+            output[path] = None
+            return output
+        if all(isinstance(val, str | int | float | bool | None) for val in data):
+            output[path] = data[0] if len(data) == 1 else data
+            return output
+        if len(data) != 1:
+            raise ValueError(f"Data at {path} is a list with more than one non-primitive element: {data}")
+        return _flatten(data=data[0], output=output, path=path)
+    raise ValueError(f"Unknown data type {type(data)} at {path}")
+
+
+def _flatten_key(path: str | None, key: str):
+    if path:
+        return f"{path}.{key}"
+    return key

{pyserials-0.1.0 → pyserials-0.1.2}/src/pyserials/write.py

@@ -27,7 +27,7 @@ def to_string(
         return to_json_string(data, sort_keys=sort_keys, indent=indent, default=default, end_of_file_newline=end_of_file_newline)
     if data_type == "yaml":
         return to_yaml_string(
-            data, 
+            data,
             end_of_file_newline=end_of_file_newline,
             indent_mapping=indent_mapping,
             indent_sequence=indent_sequence,
@@ -80,6 +80,29 @@ def to_json_string(
     return f"{string.rstrip("\n")}\n" if end_of_file_newline else string
 
 
+def to_json_file(
+    data: dict | list | str | int | float | bool | _yaml.CommentedMap | _yaml.CommentedSeq,
+    path: str | _Path,
+    sort_keys: bool = False,
+    indent: int | None = None,
+    default: Callable[[Any], Any] | None = None,
+    end_of_file_newline: bool = True,
+    make_dirs: bool = True,
+) -> None:
+    json_string = to_json_string(
+        data,
+        sort_keys=sort_keys,
+        indent=indent,
+        default=default,
+        end_of_file_newline=end_of_file_newline,
+    )
+    path = _Path(path).resolve()
+    if make_dirs:
+        path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(json_string)
+    return
+
+
 def to_yaml_file(
     data: dict | list | str | int | float | bool | _yaml.CommentedMap | _yaml.CommentedSeq,
     path: str | _Path,