Add prek + pytest-cov (#873)

scripts/generate_env_docs.py

@@ -17,16 +17,15 @@ The generated documentation includes:
 
 import argparse
 import sys
-from datetime import datetime
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Any
 
 # Add project root to path
 project_root = Path(__file__).resolve().parent.parent
 sys.path.insert(0, str(project_root))
 
 
-def get_field_type_name(field) -> str:
+def get_field_type_name(field: Any) -> str:
     """Get a human-readable type name for a field."""
     from shelfmark.core.settings_registry import (
         CheckboxField,
@@ -40,49 +39,47 @@ def get_field_type_name(field) -> str:
 
     if isinstance(field, CheckboxField):
         return "boolean"
-    elif isinstance(field, NumberField):
+    if isinstance(field, NumberField):
         return "number"
-    elif isinstance(field, SelectField):
+    if isinstance(field, SelectField):
         return "string (choice)"
-    elif isinstance(field, MultiSelectField):
+    if isinstance(field, MultiSelectField):
         return "string (comma-separated)"
-    elif isinstance(field, OrderableListField):
+    if isinstance(field, OrderableListField):
         return "JSON array"
-    elif isinstance(field, PasswordField):
+    if isinstance(field, PasswordField):
         return "string (secret)"
-    elif isinstance(field, TextField):
-        return "string"
-    else:
+    if isinstance(field, TextField):
         return "string"
+    return "string"
 
 
-def format_default_value(field) -> str:
+def format_default_value(field: Any) -> str:
     """Format the default value for display."""
     default = field.default
 
     if default is None:
         return "_none_"
-    elif isinstance(default, bool):
+    if isinstance(default, bool):
         return f"`{str(default).lower()}`"
-    elif isinstance(default, (int, float)):
+    if isinstance(default, (int, float)):
         return f"`{default}`"
-    elif isinstance(default, str):
+    if isinstance(default, str):
         if default == "":
             return "_empty string_"
         return f"`{default}`"
-    elif isinstance(default, list):
+    if isinstance(default, list):
         if not default:
             return "_empty list_"
         # For simple lists, show comma-separated values
         if all(isinstance(item, str) for item in default):
             return f"`{','.join(default)}`"
         # For complex lists (e.g., OrderableListField defaults), summarize
-        return f"_see UI for defaults_"
-    else:
-        return f"`{default}`"
+        return "_see UI for defaults_"
+    return f"`{default}`"
 
 
-def get_select_options(field) -> Optional[List[str]]:
+def get_select_options(field: Any) -> list[str] | None:
     """Get the available options for a SelectField.
 
     Returns options formatted as 'value (label)' or just 'value' if they match,
@@ -119,7 +116,7 @@ def get_select_options(field) -> Optional[List[str]]:
     return result
 
 
-def _generate_bootstrap_env_docs() -> List[str]:
+def _generate_bootstrap_env_docs() -> list[str]:
     """Generate documentation for bootstrap environment variables from env.py."""
     # These are environment variables defined in env.py that are used before
     # the settings registry is available
@@ -195,8 +192,10 @@ def _generate_bootstrap_env_docs() -> List[str]:
         "|----------|-------------|------|---------|",
     ]
 
-    for var in bootstrap_vars:
-        lines.append(f"| `{var['name']}` | {var['description']} | {var['type']} | `{var['default']}` |")
+    lines.extend(
+        f"| `{var['name']}` | {var['description']} | {var['type']} | `{var['default']}` |"
+        for var in bootstrap_vars
+    )
 
     lines.append("")
     lines.append("<details>")
@@ -221,17 +220,14 @@ def _generate_bootstrap_env_docs() -> List[str]:
 def generate_env_docs() -> str:
     """Generate markdown documentation for all environment variables."""
     # Import settings modules to ensure all settings are registered
-    import shelfmark.config.settings  # noqa: F401
-    import shelfmark.config.security  # noqa: F401
-    import shelfmark.release_sources.irc.settings  # noqa: F401
+    import shelfmark.config.security
+    import shelfmark.config.settings
+    import shelfmark.metadata_providers.googlebooks
+    import shelfmark.metadata_providers.hardcover
+    import shelfmark.metadata_providers.openlibrary
+    import shelfmark.release_sources.irc.settings
     import shelfmark.release_sources.prowlarr.settings  # noqa: F401
-    import shelfmark.metadata_providers.hardcover  # noqa: F401
-    import shelfmark.metadata_providers.openlibrary  # noqa: F401
-    import shelfmark.metadata_providers.googlebooks  # noqa: F401
-
     from shelfmark.core.settings_registry import (
-        ActionButton,
-        HeadingField,
         get_all_groups,
         get_all_settings_tabs,
     )
@@ -240,7 +236,7 @@ def generate_env_docs() -> str:
     groups = {g.name: g for g in get_all_groups()}
 
     # Organize tabs by group
-    grouped_tabs: Dict[Optional[str], List] = {None: []}
+    grouped_tabs: dict[str | None, list] = {None: []}
     for group_name in groups:
         grouped_tabs[group_name] = []
 
@@ -309,7 +305,7 @@ def generate_env_docs() -> str:
     return "\n".join(lines)
 
 
-def _generate_tab_docs(tab, group_prefix: Optional[str] = None) -> List[str]:
+def _generate_tab_docs(tab: Any, group_prefix: str | None = None) -> list[str]:
     """Generate documentation for a single settings tab."""
     from shelfmark.core.settings_registry import ActionButton, CustomComponentField, HeadingField
 
@@ -318,7 +314,6 @@ def _generate_tab_docs(tab, group_prefix: Optional[str] = None) -> List[str]:
     # Section header
     if group_prefix:
         lines.append(f"### {group_prefix}: {tab.display_name}")
-        anchor_id = f"{group_prefix}-{tab.display_name}".lower().replace(" ", "-")
     else:
         lines.append(f"## {tab.display_name}")
 
@@ -391,6 +386,7 @@ def _generate_tab_docs(tab, group_prefix: Optional[str] = None) -> List[str]:
 
         # Show constraints for NumberField
         from shelfmark.core.settings_registry import NumberField
+
         if isinstance(field, NumberField):
             constraints = []
             if field.min_value is not None:
@@ -408,7 +404,7 @@ def _generate_tab_docs(tab, group_prefix: Optional[str] = None) -> List[str]:
     return lines
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser(
         description="Generate markdown documentation for environment variables"
     )

scripts/test_clients.py

@@ -51,7 +51,8 @@ First-Time Setup:
 
 import sys
 import time
-from xmlrpc import client
+from pathlib import Path
+from typing import Any
 
 # Test configuration - matches docker-compose.test-clients.yml
 CONFIG = {
@@ -89,7 +90,7 @@ CONFIG = {
 TEST_MAGNET = "magnet:?xt=urn:btih:3b245504cf5f11bbdbe1201cea6a6bf45aee1bc0&dn=ubuntu-22.04.3-live-server-amd64.iso"
 
 
-def test_nzbget():
+def test_nzbget() -> bool:
     """Test NZBGet connection."""
     import requests
 
@@ -138,7 +139,7 @@ def test_nzbget():
         return False
 
 
-def test_sabnzbd():
+def test_sabnzbd() -> bool:
     """Test SABnzbd connection."""
     import requests
 
@@ -152,10 +153,9 @@ def test_sabnzbd():
     # Try to get API key from config if not set
     if not api_key:
         try:
-            import os
-            ini_path = ".local/test-clients/sabnzbd/config/sabnzbd.ini"
-            if os.path.exists(ini_path):
-                with open(ini_path) as f:
+            ini_path = Path(".local/test-clients/sabnzbd/config/sabnzbd.ini")
+            if ini_path.exists():
+                with ini_path.open() as f:
                     for line in f:
                         if line.startswith("api_key"):
                             api_key = line.split("=")[1].strip()
@@ -204,7 +204,7 @@ def test_sabnzbd():
         return False
 
 
-def test_qbittorrent():
+def test_qbittorrent() -> bool:
     """Test qBittorrent connection."""
     print("\n" + "=" * 50)
     print("Testing qBittorrent")
@@ -219,6 +219,7 @@ def test_qbittorrent():
 
         # Parse URL for host/port
         from urllib.parse import urlparse
+
         parsed = urlparse(url)
 
         client = qbittorrentapi.Client(
@@ -271,16 +272,17 @@ def test_qbittorrent():
         return False
 
 
-def test_transmission():
+def test_transmission() -> bool:
     """Test Transmission connection."""
     print("\n" + "=" * 50)
     print("Testing Transmission")
     print("=" * 50)
 
     try:
-        from transmission_rpc import Client
         from urllib.parse import urlparse
 
+        from transmission_rpc import Client
+
         url = CONFIG["transmission"]["url"]
         parsed = urlparse(url)
 
@@ -324,7 +326,7 @@ def test_transmission():
         return False
 
 
-def test_deluge():
+def test_deluge() -> bool:
     """Test Deluge Web UI (JSON-RPC) connection."""
     import requests
 
@@ -336,7 +338,7 @@ def test_deluge():
     password = CONFIG["deluge"]["password"]
     rpc_url = f"{base_url}/json"
 
-    def rpc_call(session: requests.Session, rpc_id: int, method: str, *params):
+    def rpc_call(session: requests.Session, rpc_id: int, method: str, *params: Any) -> Any:
         payload = {"id": rpc_id, "method": method, "params": list(params)}
         resp = session.post(rpc_url, json=payload, timeout=10)
         resp.raise_for_status()
@@ -366,7 +368,11 @@ def test_deluge():
 
             host_id = hosts[0][0]
             for entry in hosts:
-                if isinstance(entry, list) and len(entry) >= 2 and entry[1] in {"127.0.0.1", "localhost"}:
+                if (
+                    isinstance(entry, list)
+                    and len(entry) >= 2
+                    and entry[1] in {"127.0.0.1", "localhost"}
+                ):
                     host_id = entry[0]
                     break
 
@@ -386,13 +392,18 @@ def test_deluge():
 
         # Test adding a torrent (then remove it)
         print("  Testing add/remove torrent...")
-        torrent_id = rpc_call(session, 8, "core.add_torrent_magnet", TEST_MAGNET, {"add_paused": True})
+        torrent_id = rpc_call(
+            session, 8, "core.add_torrent_magnet", TEST_MAGNET, {"add_paused": True}
+        )
 
         if torrent_id:
             torrent_id = str(torrent_id)
             print(f"  Added test torrent: {torrent_id[:20]}...")
 
-            status = rpc_call(session, 9, "core.get_torrent_status", torrent_id, ["state", "progress"]) or {}
+            status = (
+                rpc_call(session, 9, "core.get_torrent_status", torrent_id, ["state", "progress"])
+                or {}
+            )
             state = status.get("state", "unknown") if isinstance(status, dict) else "unknown"
             progress = status.get("progress", 0) if isinstance(status, dict) else 0
             print(f"  Status: {state} ({progress:.1f}%)")
@@ -418,7 +429,8 @@ def test_deluge():
             print("  Check Deluge Web UI password (default: deluge)")
         return False
 
-def test_rtorrent():
+
+def test_rtorrent() -> bool:
     """Test rTorrent connection."""
     print("\n" + "=" * 50)
     print("Testing rTorrent")
@@ -457,19 +469,18 @@ def test_rtorrent():
 
         # rtorrent is weird in that it doesn't return the torrent ID/hash on add
         client.load.start("", TEST_MAGNET, ";".join(commands))
-        
+
         # but we know that it is 3b245504cf5f11bbdbe1201cea6a6bf45aee1bc0 from the magnet link
-        torrent_id = "3B245504CF5F11BBDBE1201CEA6A6BF45AEE1BC0" # rtorrent uses uppercase hashes
+        torrent_id = "3B245504CF5F11BBDBE1201CEA6A6BF45AEE1BC0"  # rtorrent uses uppercase hashes
         print(f"  Added test torrent: {torrent_id}")
 
         torrents = client.download_list()
-        print(f"  Active torrents: {len(torrents)}")        
+        print(f"  Active torrents: {len(torrents)}")
 
         torrent_list = client.d.multicall.filtered(
             "",
             "default",
-            f"equal={{d.hash=,cat={torrent_id}}}"
-            "d.hash=",
+            f"equal={{d.hash=,cat={torrent_id}}}d.hash=",
             "d.state=",
             "d.completed_bytes=",
             "d.size_bytes=",
@@ -483,7 +494,7 @@ def test_rtorrent():
         if not torrent:
             print("  ERROR: Could not find added torrent in list")
             return False
-        
+
         # let's test the base path call
         details = client.d.multicall.filtered(
             "",
@@ -511,7 +522,7 @@ def test_rtorrent():
         return False
 
 
-def main():
+def main() -> int:
     print("Download Client Test Suite")
     print("=" * 50)
     print("Make sure containers are running:")