Merge pull request #2 from jpbruinsslot/add-type-hints

Add type-hinting

Author: annejan

alert2issue.py

@@ -7,7 +7,8 @@
 from pathlib import Path
 
 
-def run_gh_command(cmd, capture_json=True):
+def run_gh_command(cmd: str, capture_json: bool = True) -> str | dict | None:
+    """Run a GitHub CLI command and return the output as JSON or plain text."""
     try:
         result = subprocess.run(shlex.split(cmd), capture_output=True, check=True, text=True)
         return json.loads(result.stdout) if capture_json else result.stdout.strip()
@@ -18,12 +19,32 @@ def run_gh_command(cmd, capture_json=True):
         return None
 
 
-def check_rate_limit(min_remaining=100):
+def run_gh_command_json(cmd: str) -> dict | None:
+    """Run a GitHub CLI command and return the output as JSON."""
+    output = run_gh_command(cmd, capture_json=True)
+    if output is None:
+        return None
+
+    return output if isinstance(output, dict) else json.loads(output)
+
+
+def run_gh_command_text(cmd: str) -> str | None:
+    """Run a GitHub CLI command and return the output as plain text."""
+    output = run_gh_command(cmd, capture_json=False)
+    if output is None:
+        return None
+
+    return output if isinstance(output, str) else json.dumps(output, indent=2)
+
+
+def check_rate_limit(min_remaining: int = 100) -> bool:
+    """Check GitHub API rate limit and return True if sufficient calls remaining."""
     print("⏳ Checking GitHub API rate limit...")
-    remaining = run_gh_command('gh api rate_limit --jq ".rate.remaining"', capture_json=False)
+    remaining = run_gh_command_text('gh api rate_limit --jq ".rate.remaining"')
     if remaining is None:
         print("⚠️ Could not determine API rate limit. Proceeding with caution.")
         return True
+
     try:
         remaining_int = int(remaining)
         print(f"🔢 API calls remaining: {remaining_int}")
@@ -36,13 +57,17 @@ def check_rate_limit(min_remaining=100):
         return True
 
 
-def ensure_label(repo, label, color, description, dry_run=False):
-    existing = run_gh_command(f"gh label list --repo {repo} --limit 100", capture_json=False)
+def ensure_label(
+    repo: str, label: str, color: str, description: str, dry_run: bool = False
+) -> None:
+    """Ensure a label exists in the specified repository."""
+    existing = run_gh_command_text(f"gh label list --repo {repo} --limit 100")
     if not existing or not any(line.startswith(label) for line in existing.splitlines()):
         action = "Would create" if dry_run else "Creating"
         print(f"🛠️ {action} label: {label} in {repo}")
         if dry_run:
             return
+
         try:
             subprocess.run(
                 [
@@ -63,7 +88,10 @@ def ensure_label(repo, label, color, description, dry_run=False):
             print(f"⚠️  Failed to create label: {label} in {repo}")
 
 
-def create_issue(repo, title, body, dry_run=False, labels=None):
+def create_issue(
+    repo: str, title: str, body: str, dry_run: bool = False, labels: list[str] | None = None
+) -> None:
+    """Create a new issue in the specified repository."""
     labels = labels or ["security", "dependabot"]
 
     if dry_run:
@@ -83,22 +111,22 @@ def create_issue(repo, title, body, dry_run=False, labels=None):
         print(f"❌ Failed to create issue in {repo}: {title}")
 
 
-def get_open_issue_titles(repo):
+def get_open_issue_titles(repo: str) -> set[str]:
+    """Get titles of all open issues in the specified repository."""
     # Get all open issue titles for repo in one go (up to 100)
-    output = run_gh_command(
-        f"gh issue list --repo {repo} --state open --json title", capture_json=True
-    )
+    output = run_gh_command_json(f"gh issue list --repo {repo} --state open --json title")
     if output is None:
         return set()
+
     return set(issue["title"] for issue in output)
 
 
-def process_repo(repo, dry_run=False):
+def process_repo(repo: str, dry_run: bool = False) -> None:
+    """Process a single repository to check for Dependabot alerts and create issues."""
     print(f"🔍 Checking alerts for: {repo}")
 
-    alerts = run_gh_command(
+    alerts = run_gh_command_json(
         f'gh api -X GET "/repos/{repo}/dependabot/alerts?per_page=100" --paginate',
-        capture_json=True,
     )
     if not alerts:
         print(f"✅ No open dependabot alerts found for {repo}.")
@@ -145,19 +173,37 @@ def process_repo(repo, dry_run=False):
             print(f"⚠️  Issue already exists in {repo}: '{title}'. Skipping...")
             continue
 
-        ensure_label(repo, "security", "d73a4a", "Security-related issues", dry_run)
-        ensure_label(repo, "dependabot", "0366d6", "Dependabot alerts", dry_run)
+        labels = [
+            {
+                "name": "security",
+                "color": "d73a4a",
+                "description": "Security-related issues",
+            },
+            {
+                "name": "dependabot",
+                "color": "0366d6",
+                "description": "Dependabot alerts",
+            },
+        ]
 
-        labels = ["security", "dependabot"]
         if fpv is None:
-            ensure_label(repo, "no-patch", "ededed", "No patched version available", dry_run)
-            labels.append("no-patch")
+            labels.append(
+                {
+                    "name": "no-patch",
+                    "color": "ededed",
+                    "description": "No patched version available",
+                }
+            )
+
+        for label in labels:
+            ensure_label(repo, label["name"], label["color"], label["description"], dry_run)
 
-        create_issue(repo, title, body, dry_run=dry_run, labels=labels)
+        create_issue(repo, title, body, dry_run=dry_run, labels=[label["name"] for label in labels])
 
 
-def load_repos(path):
-    with open(path) as f:
+def load_repos(path: Path) -> list[str]:
+    """Load repository names from a file, ignoring comments and empty lines."""
+    with open(path, "r", encoding="utf-8") as f:
         return [
             line.split("#")[0].strip()
             for line in f

test_alert2issue.py

@@ -65,7 +65,7 @@ def test_run_gh_command_failure(self, mock_run, mock_print):
         result = alert2issue.run_gh_command("gh test")
         self.assertIsNone(result)
 
-    @patch("alert2issue.run_gh_command")
+    @patch("alert2issue.run_gh_command_json")
     def test_process_repo_no_alerts(self, mock_run, mock_print):
         mock_run.side_effect = [[], None]  # Empty alert list
         alert2issue.process_repo("user/repo")
@@ -75,7 +75,7 @@ def test_process_repo_no_alerts(self, mock_run, mock_print):
             "Expected 'No open dependabot alerts' in printed output.",
         )
 
-    @patch("alert2issue.run_gh_command")
+    @patch("alert2issue.run_gh_command_json")
     @patch("alert2issue.ensure_label")
     @patch("alert2issue.create_issue")
     def test_process_repo_with_alert(self, mock_create, mock_label, mock_run, mock_print):
@@ -104,7 +104,7 @@ def test_process_repo_with_alert(self, mock_create, mock_label, mock_run, mock_p
             "user/repo", "security", "d73a4a", "Security-related issues", True
         )
 
-    @patch("alert2issue.run_gh_command")
+    @patch("alert2issue.run_gh_command_json")
     @patch("alert2issue.ensure_label")
     @patch("alert2issue.create_issue")
     def test_process_repo_no_patch(self, mock_create, mock_label, mock_run, mock_print):