Decentralized module loading and argument definitions

Author: dbennett-sentry

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: v3.12.0
     hooks:
       - id: reorder-python-imports
-        args: [--py311-plus, --add-import, "from __future__ import annotations"]
+        args: [--py310-plus, --add-import, "from __future__ import annotations"]
   - repo: https://github.com/psf/black
     rev: 23.10.0
     hooks:

devenv/commands/__init__.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-import argparse
 import os
 import shutil
 from collections.abc import Sequence
+from typing import cast
 
 from devenv.constants import CI
 from devenv.constants import EXTERNAL_CONTRIBUTOR
@@ -14,25 +14,33 @@
 from devenv.lib.config import Config
 from devenv.lib.config import initialize_config
 from devenv.lib.context import Context
-from devenv.lib.modules import DevModuleInfo
+from devenv.lib.modules import argument_fn
+from devenv.lib.modules import command
 from devenv.lib.modules import ExitCode
-
-
-def main(context: Context, argv: Sequence[str] | None = None) -> ExitCode:
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-d",
-        "--default-config",
-        action="append",
-        help="Provide a default config value. e.g., -d coderoot:path/to/root",
+from devenv.lib.modules import ModuleDef
+from devenv.lib.modules import ParserFn
+
+
+@command("bootstrap", "Bootstraps the development environment.")
+@argument_fn(
+    cast(
+        ParserFn,
+        lambda x: x.add_argument(
+            "-d",
+            "--default-config",
+            metavar="config:value",
+            required=False,
+            action="append",
+            help="Provide a default config value. e.g., -d coderoot:path/to/root",
+        ),
     )
-
-    args = parser.parse_args(argv)
+)
+def main(context: Context, argv: Sequence[str] | None = None) -> ExitCode:
+    args = context["args"]
 
     configs = {
         k: v for k, v in [i.split(":", 1) for i in args.default_config or []]
     }
-
     if "coderoot" not in configs and "code_root" in context:
         configs["coderoot"] = context["code_root"]
 
@@ -103,9 +111,8 @@ def main(context: Context, argv: Sequence[str] | None = None) -> ExitCode:
     return 0
 
 
-module_info = DevModuleInfo(
-    action=main,
-    name=__name__,
-    command="bootstrap",
+module_info = ModuleDef(
+    module_name=__name__,
+    name="bootstrap",
     help="Bootstraps the development environment.",
 )

devenv/bootstrap.py renamed to devenv/commands/bootstrap.py

@@ -14,7 +14,8 @@
 from typing import List
 
 from devenv.lib.context import Context
-from devenv.lib.modules import DevModuleInfo
+from devenv.lib.modules import command
+from devenv.lib.modules import ModuleDef
 from devenv.lib.modules import require_repo
 from devenv.lib.repository import Repository
 from devenv.lib_check.types import checker
@@ -161,6 +162,7 @@ def attempt_fix(check: Check, executor: ThreadPoolExecutor) -> tuple[bool, str]:
         return False, f"Fix threw a runtime exception: {e}"
 
 
+@command("doctor", "Diagnose common issues, and optionally try to fix them.")
 @require_repo
 def main(context: Context, argv: Sequence[str] | None = None) -> int:
     parser = argparse.ArgumentParser()
@@ -232,9 +234,4 @@ def main(context: Context, argv: Sequence[str] | None = None) -> int:
     return 1
 
 
-module_info = DevModuleInfo(
-    action=main,
-    name=__name__,
-    command="doctor",
-    help="Diagnose common issues, and optionally try to fix them.",
-)
+module_info = ModuleDef(module_name=__name__, name="doctor", help="Diagnose common issues, and optionally try to fix them")

devenv/doctor.py renamed to devenv/commands/doctor.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import argparse
 import os
 import sys
 from collections.abc import Sequence
@@ -11,18 +10,16 @@
 from devenv.constants import homebrew_bin
 from devenv.lib import proc
 from devenv.lib.context import Context
-from devenv.lib.modules import DevModuleInfo
+from devenv.lib.modules import argument
+from devenv.lib.modules import command
 from devenv.lib.modules import ExitCode
+from devenv.lib.modules import ModuleDef
 
 
+@command("fetch", "Fetches a repository")
+@argument("repo", help="the repository to fetch")
 def main(context: Context, argv: Sequence[str] | None = None) -> ExitCode:
-    parser = argparse.ArgumentParser()
-
-    parser.add_argument(
-        "repo", type=str, help="the repository to fetch e.g., getsentry/sentry"
-    )
-
-    args = parser.parse_args(argv)
+    args = context["args"]
     code_root = context["code_root"]
 
     if args.repo in ["ops", "getsentry/ops"]:
@@ -78,17 +75,20 @@ def main(context: Context, argv: Sequence[str] | None = None) -> ExitCode:
         )
 
     else:
+        if "/" not in args.repo:
+            print("Repository names must be in the form of <owner>/<repo>")
+            return 1
         fetch(code_root, args.repo)
 
     return 0
 
 
 def fetch(
-    coderoot: str, repo: str, auth: bool = True, sync: bool = True
+    code_root: str, repo: str, auth: bool = True, sync: bool = True
 ) -> None:
     org, slug = repo.split("/")
 
-    codepath = f"{coderoot}/{slug}"
+    codepath = f"{code_root}/{slug}"
 
     if os.path.exists(codepath):
         print(f"{codepath} already exists")
@@ -112,7 +112,7 @@ def fetch(
         (
             "git",
             "-C",
-            coderoot,
+            code_root,
             "clone",
             "--filter=blob:none",
             *additional_args,
@@ -124,6 +124,4 @@ def fetch(
         proc.run((sys.executable, "-P", "-m", "devenv", "sync"), cwd=codepath)
 
 
-module_info = DevModuleInfo(
-    action=main, name=__name__, command="fetch", help="Fetches a respository"
-)
+module_info = ModuleDef(module_name=__name__, name="fetch", help="Fetches a repository")

devenv/fetch.py renamed to devenv/commands/fetch.py

@@ -7,7 +7,8 @@
 from functools import lru_cache
 
 from devenv.lib.context import Context
-from devenv.lib.modules import DevModuleInfo
+from devenv.lib.modules import command
+from devenv.lib.modules import ModuleDef
 
 
 @lru_cache(maxsize=None)
@@ -38,6 +39,7 @@ def extract_repo(action: str) -> str:
     return f"{parts[0]}/{parts[1]}"
 
 
+@command("pin-gha", "Pins github actions.")
 def main(context: Context, argv: Sequence[str] | None = None) -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -70,6 +72,4 @@ def main(context: Context, argv: Sequence[str] | None = None) -> int:
     return 0
 
 
-module_info = DevModuleInfo(
-    action=main, name=__name__, command="pin_gha", help="Pins github actions."
-)
+module_info = ModuleDef(module_name=__name__, name="pin_gha", help="Pins github actions")

devenv/pin_gha.py renamed to devenv/commands/pin_gha.py

@@ -5,10 +5,12 @@
 from collections.abc import Sequence
 
 from devenv.lib.context import Context
-from devenv.lib.modules import DevModuleInfo
+from devenv.lib.modules import command
+from devenv.lib.modules import ModuleDef
 from devenv.lib.modules import require_repo
 
 
+@command("sync", "Resyncs the current project")
 @require_repo
 def main(context: Context, argv: Sequence[str] | None = None) -> int:
     repo = context["repo"]
@@ -33,6 +35,4 @@ def main(context: Context, argv: Sequence[str] | None = None) -> int:
     return module.main(context_compat)  # type: ignore
 
 
-module_info = DevModuleInfo(
-    action=main, name=__name__, command="sync", help="Resyncs the environment."
-)
+module_info = ModuleDef(module_name=__name__, name="sync", help="Resyncs the current project")

devenv/sync.py renamed to devenv/commands/sync.py

@@ -60,13 +60,9 @@ def initialize_config(config_path: str, defaults: Config) -> None:
                 else _val,
             )
 
-            if not CI:
+            if not CI and opts:
                 try:
-                    if opts:
-                        print(opts.prompt)
-                    else:
-                        print(f"{var}?")
-
+                    print(opts.prompt)
                     val = input(f" [{val}]: ") or val
                 except EOFError:
                     # noninterative, use the defaults

devenv/lib/config.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from argparse import Namespace
 from typing import TypedDict
 
 from devenv.lib.repository import Repository
@@ -9,3 +10,4 @@ class Context(TypedDict):
     config_path: str
     code_root: str
     repo: Repository | None
+    args: Namespace