Implement --in-place for compact-json#36

Author: masaccio

README.md

@@ -26,7 +26,7 @@ The [FracturedJson Wiki](https://github.com/j-brooke/FracturedJson/wiki) provide
 The package installs a command-line script `fractured-json` which can compact one or more JSON files according to command-line switches.
 
 ``` text
-usage: fractured-json [-h] [-V] [--output OUTPUT]
+usage: fractured-json [-h] [-V] [--in-place] [--output OUTPUT]
                       [--allow-trailing-commas] [--always-expand-depth N]
                       [--colon-before-prop-name-padding] [--colon-padding]
                       [--comma-padding] [--comment-padding]
@@ -55,8 +55,9 @@ positional arguments:
   json                  JSON file(s) to parse (or stdin with "-")
 
 options:
-  -h, --help            show this help message and exit
-  -V, --version
+  -h, --help            Show this help message and exit
+  -V, --version         Output the script version and exit
+  --in-place            Save any edits back to the input file
   --output, -o OUTPUT   The output file name(s). The number of output file
                         names must match the number of input files.
   --allow-trailing-commas

pyproject.toml

@@ -16,7 +16,7 @@ license = "MIT"
 name = "fractured-json"
 readme = "README.md"
 requires-python = ">=3.11, <3.14"
-version = "5.0.0post3"
+version = "5.0.0post4"
 
 [[project.authors]]
 email = "python@figsandfudge.com"

src/fractured_json/_fractured_json.py

@@ -11,9 +11,35 @@
 def command_line_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         description="Format JSON into compact, human readable form",
+        add_help=False,
     )
-    parser.add_argument("-V", "--version", action="store_true")
 
+    parser.add_argument(
+        "-h",
+        "--help",
+        default=False,
+        action="store_true",
+        help="Show this help message and exit",
+    )
+    parser.add_argument(
+        "-?",
+        dest="dos_help",
+        default=False,
+        action="store_true",
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "-V",
+        "--version",
+        action="store_true",
+        help="Output the script version and exit",
+    )
+    parser.add_argument(
+        "--in-place",
+        action="store_true",
+        default=False,
+        help="Save any edits back to the input file",
+    )
     parser.add_argument(
         "--output",
         "-o",
@@ -59,7 +85,6 @@ def command_line_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "json",
         nargs="*",
-        type=argparse.FileType("r"),
         help='JSON file(s) to parse (or stdin with "-")',
     )
     parser.add_argument(
@@ -68,7 +93,6 @@ def command_line_parser() -> argparse.ArgumentParser:
         action="store_true",
         help="Treat strings as unicode East Asian characters",
     )
-    parser.add_argument("-?", dest="dos_help", action="store_true", help=argparse.SUPPRESS)
 
     return parser
 
@@ -83,7 +107,7 @@ def die(message: str) -> None:
     args = parser.parse_args()
     if args.version:
         print(fractured_json_version)
-    elif len(args.json) == 0 or args.dos_help:
+    elif len(args.json) == 0 or args.help or args.dos_help:
         parser.print_help()
     else:
         options = FracturedJsonOptions()
@@ -94,23 +118,31 @@ def die(message: str) -> None:
             formatter.string_length_func = lambda s: wcswidth(s)
 
         in_files = args.json
-        out_files = args.output
-
-        if out_files is None:
-            for fh in args.json:
-                json_input = fh.read()
-                output_json = formatter.reformat(json_input)
-                print(output_json, end="")
-            return
-
-        if len(in_files) != len(out_files):
-            die("the numbers of input and output file names do not match")
-
-        for fh_in, fn_out in zip(args.json, args.output, strict=True):
-            json_input = fh_in.read()
-            output_json = formatter.reformat(json_input)
-            with open(fn_out, "w", newline="") as fh_out:
-                fh_out.write(output_json)
+
+        if args.in_place:
+            out_files = args.json
+        elif args.output is None:
+            out_files = [None] * len(in_files)
+        else:
+            if len(in_files) != len(args.output):
+                die("the numbers of input and output file names do not match")
+            out_files = args.output
+
+        for fn_in, fn_out in zip(in_files, out_files, strict=True):
+            if fn_in == "-":
+                in_json_string = sys.stdin.read()
+            else:
+                try:
+                    in_json_string = open(fn_in).read()
+                except FileNotFoundError as e:
+                    die(str(e))
+
+            out_json_string = formatter.reformat(in_json_string)
+
+            if fn_out is None:
+                sys.stdout.write(out_json_string)
+            elif not args.in_place or in_json_string != out_json_string:
+                open(fn_out, "w").write(out_json_string)
 
 
 if __name__ == "__main__":  # pragma: no cover

src/fractured_json/_version.py

@@ -1,3 +1,3 @@
 # Auto-generated during build. Do not edit.
 
-__version__ = "5.0.0post3"
+__version__ = "5.0.0post4"

tests/test_console_script.py

@@ -108,7 +108,7 @@ def test_main(script_runner):
     ret = script_runner.run(["python3", "-m", "fractured_json", "--help"])
     assert ret.stderr == ""
     assert ret.success
-    assert "[-h] [-V] [--output" in ret.stdout
+    assert "[-h] [-V] [--in-place] [--output OUTPUT]" in ret.stdout
 
 
 @pytest.mark.script_launch_mode("subprocess")