Refactor: DRY save_json

Author: hugovk

needs_backport.py

@@ -10,7 +10,7 @@
 """
 
 # /// script
-# requires-python = ">=3.9"
+# requires-python = ">=3.10"
 # dependencies = [
 #     "ghapi",
 #     "rich",
@@ -26,10 +26,11 @@
 from functools import cache
 from typing import Any, TypeAlias
 
+from fastcore.xtras import obj2dict
 from ghapi.all import GhApi, paged  # pip install ghapi
 from rich import print  # pip install rich
 
-from potential_closeable_issues import sort_by_to_sort_and_direction
+from potential_closeable_issues import save_json, sort_by_to_sort_and_direction
 
 PR: TypeAlias = dict[str, Any]
 
@@ -131,7 +132,11 @@ def main() -> None:
         "-s", "--start", default=1, type=int, help="start at this PR number"
     )
     parser.add_argument(
-        "-n", "--number", default=100, type=int, help="number of PRs to check"
+        "-n",
+        "--number",
+        default=100,
+        type=int,
+        help="number of PRs to check per branch",
     )
     parser.add_argument(
         "--sort",
@@ -146,6 +151,7 @@ def main() -> None:
         ),
         help="Sort by",
     )
+    parser.add_argument("-j", "--json", action="store_true", help="output to JSON file")
     parser.add_argument(
         "-o", "--open-prs", action="store_true", help="open PRs in browser"
     )
@@ -190,6 +196,17 @@ def report(prs: list[PR]):
         total = len({pr["number"] for pr in prs})
         print(f"* Found {total} {reason}")
 
+    if args.json:
+        data = {
+            "reasons": [
+                {reason: [obj2dict(pr) for pr in prs]}
+                for reason, prs in total_candidates.items()
+            ],
+        }
+        # Use same name as this .py but with .json
+        filename = os.path.splitext(__file__)[0] + ".json"
+        save_json(data, filename)
+
 
 if __name__ == "__main__":
     main()

orphaned_backports.py

@@ -16,8 +16,6 @@
 from __future__ import annotations
 
 import argparse
-import datetime as dt
-import json
 import os
 import urllib
 from typing import Any, TypeAlias
@@ -27,7 +25,7 @@
 from ghapi.all import GhApi, paged  # pip install ghapi
 from rich import print  # pip install rich
 
-from potential_closeable_issues import sort_by_to_sort_and_direction
+from potential_closeable_issues import save_json, sort_by_to_sort_and_direction
 
 PR: TypeAlias = dict[str, Any]
 
@@ -164,19 +162,10 @@ def main() -> None:
             os.system(cmd)
 
     if args.json:
+        data = {"candidates": [obj2dict(c) for c in candidates]}
         # Use same name as this .py but with .json
         filename = os.path.splitext(__file__)[0] + ".json"
-        now = dt.datetime.now(dt.UTC).isoformat()
-        with open(filename, "w", encoding="utf-8") as f:
-            json.dump(
-                {
-                    "last_update": now,
-                    "candidates": [obj2dict(c) for c in candidates],
-                },
-                f,
-                indent=2,
-            )
-            print(f"Saved candidates to {filename}")
+        save_json(data, filename)
 
 
 if __name__ == "__main__":

potential_closeable_issues.py

@@ -170,6 +170,14 @@ def check_issues(
     return candidates
 
 
+def save_json(data: Any, filename: str) -> None:
+    # Put last_update at the start
+    data = {"last_update": dt.datetime.now(dt.UTC).isoformat(), **data}
+    with open(filename, "w", encoding="utf-8") as f:
+        json.dump(data, f, indent=2)
+        print(f"Saved candidates to {filename}")
+
+
 def main() -> None:
     parser = argparse.ArgumentParser(
         description=__doc__,
@@ -219,19 +227,10 @@ def main() -> None:
             os.system(cmd)
 
     if args.json:
+        data = {"candidates": [obj2dict(c) for c in candidates]}
         # Use same name as this .py but with .json
         filename = os.path.splitext(__file__)[0] + ".json"
-        now = dt.datetime.now(dt.UTC).isoformat()
-        with open(filename, "w", encoding="utf-8") as f:
-            json.dump(
-                {
-                    "last_update": now,
-                    "candidates": [obj2dict(c) for c in candidates],
-                },
-                f,
-                indent=2,
-            )
-            print(f"Saved candidates to {filename}")
+        save_json(data, filename)
 
 
 if __name__ == "__main__":