jsonreflow 0.4.0__py3-none-any.whl

jsonreflow/__init__.py

@@ -0,0 +1,5 @@
+from jsonreflow.reflow import dumps, reflow, reflow_iter
+
+__version__ = "0.4.0"
+
+__all__ = ["reflow_iter", "reflow", "dumps", "__version__"]

jsonreflow/cli.py

@@ -0,0 +1,46 @@
+import argparse
+import json
+
+from jsonreflow.reflow import MAX_WIDTH_DEFAULT, dumps, reflow_iter
+
+
+def main():
+    cli = argparse.ArgumentParser(description="Reflow JSON to fit within a given width")
+    cli.add_argument(
+        "input",
+        nargs="?",
+        type=argparse.FileType("r", encoding="utf-8"),
+        default="-",
+        help="Input JSON file (defaults to stdin)",
+    )
+    cli.add_argument(
+        "--assume-formatted",
+        action="store_true",
+        help="""
+            Assume the input is already properly formatted as multiline, indented JSON.
+            Allows to reflow without parsing the JSON, which is more efficient,
+            and avoids subtle re-encoding issues.
+        """,
+    )
+    cli.add_argument(
+        "-w",
+        "--max-width",
+        type=int,
+        default=MAX_WIDTH_DEFAULT,
+        help=f"Maximum line width to reflow for (default: {MAX_WIDTH_DEFAULT})",
+    )
+
+    args = cli.parse_args()
+    if args.assume_formatted:
+        for line in reflow_iter(
+            (s.rstrip() for s in args.input.readlines()), max_width=args.max_width
+        ):
+            print(line)
+    else:
+        data = json.load(args.input)
+        # TODO: integrate with streaming JSON encoding
+        print(dumps(data, max_width=args.max_width))
+
+
+if __name__ == "__main__":
+    main()

jsonreflow/reflow.py

@@ -0,0 +1,59 @@
+import json
+from typing import Iterable, Iterator, List
+
+MAX_WIDTH_DEFAULT = 80
+
+
+def reflow_iter(
+    lines: Iterable[str], max_width: int = MAX_WIDTH_DEFAULT
+) -> Iterator[str]:
+    # Stack of buffers of possibly foldable levels.
+    # Note that only the currently deepest levels are tracked,
+    # levels more towards the top that are already collapsed
+    # are not represented here anymore.
+    buffer_stack: List[List[str]] = []
+
+    for line in lines:
+        stripped = line.strip()
+
+        if stripped.endswith("{") or stripped.endswith("["):
+            # Start a new level on the stack
+            buffer_stack.append([])
+
+        # Depending on whether we are at a possibly foldable level:
+        # yield (collapse) or try folding
+        if not buffer_stack:
+            yield line
+        else:
+            buffer_stack[-1].append(line)
+
+            if stripped in {"}", "},", "]", "],"}:
+                # Close current level: time to see if we can fold to one-liner
+                # or have to collapse to multi-line
+                closed = buffer_stack.pop()
+                folded = (
+                    closed[0]
+                    + " ".join(s.strip() for s in closed[1:-1])
+                    + closed[-1].strip()
+                )
+
+                if len(folded) > max_width:
+                    # Current level doesn't fit: collapse all levels we've been tracking
+                    for level in buffer_stack:
+                        yield from level
+                    buffer_stack = []
+                    yield from closed
+                else:
+                    # Move folded result up one level (unless it's collapsed already)
+                    if buffer_stack:
+                        buffer_stack[-1].append(folded)
+                    else:
+                        yield folded
+
+
+def reflow(encoded: str, max_width: int = MAX_WIDTH_DEFAULT) -> str:
+    return "\n".join(reflow_iter(encoded.split("\n"), max_width=max_width))
+
+
+def dumps(obj, max_width: int = MAX_WIDTH_DEFAULT) -> str:
+    return reflow(json.dumps(obj=obj, indent=2), max_width=max_width)

jsonreflow-0.4.0.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: jsonreflow
+Version: 0.4.0
+Summary: Indented JSON, but with one-line arrays or objects if they fit a desired line length.
+Project-URL: Repository, https://github.com/soxofaan/jsonreflow
+Project-URL: Changelog, https://github.com/soxofaan/jsonreflow/blob/main/CHANGELOG.md
+Author-email: Stefaan Lippens <soxofaan@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: JSON,serialization
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: File Formats :: JSON
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+
+# JSON Reflow
+
+Python library and CLI tool to reflow JSON files and streams,
+to allow a better compromise between
+
+- compactness:
+  try to fit short arrays and objects on a single line,
+  within a given line length limit
+- human readability:
+  indented JSON for larger constructs otherwise.
+
+
+
+## The problem
+
+Standard JSON serialization tools typically only support two extremes:
+
+- put everything on a single line:
+  the most compact, but very poor for human readability
+
+- spread out each and every array item and object property on its own line
+  with appropriate indentation to visualize the structure.
+  This is easier for humans to parse visually
+  (which is why it is often referred to as "prettifying" or "beautifying"),
+  but for larger documents, this easily becomes unwieldy, "too vertical"
+  and very space-inefficient because of all the repeated indentation.
+
+JSON Reflow allows to find a better compromise:
+only serialize arrays or objects over multiple lines
+if the single-line approach would exceed a given line length.

jsonreflow-0.4.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+jsonreflow/__init__.py,sha256=rAFqZy-dSA1mf2i6hPJ6QmXGPAZR3RmKUcosAn-OWbs,141
+jsonreflow/cli.py,sha256=SvIl8EDZw6cQB-Cni-ZEFlfbceYOiEy0-MDPPENDG6c,1331
+jsonreflow/reflow.py,sha256=-MUHZ020Oy3fSZs8UXpsVQDCznY-dRaZmSiYyuf_pYc,2100
+jsonreflow-0.4.0.dist-info/METADATA,sha256=Fam8xuoT61dBVPtC1FDguwoZFZCS1OoIa8PBip7amYg,1813
+jsonreflow-0.4.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+jsonreflow-0.4.0.dist-info/entry_points.txt,sha256=UbNM5UCPSrn70prnh3AeirzkshMhys1Bv3XwQ1ueNhI,51
+jsonreflow-0.4.0.dist-info/licenses/LICENSE.txt,sha256=dVpx0cdQf9FvNaZj3OkAvWy98QknX9DXGnnPjNsphyQ,1072
+jsonreflow-0.4.0.dist-info/RECORD,,

jsonreflow-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

jsonreflow-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+jsonreflow = jsonreflow.cli:main

jsonreflow-0.4.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stefaan Lippens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.