Add type hints to relenv/common.py and relenv/runtime.py

Author: dwoz

relenv/__init__.py

@@ -1,3 +1,8 @@
 # Copyright 2025 Broadcom.
 # SPDX-License-Identifier: Apache-2
+import sys
+
+if sys.version_info < (3, 10):
+    raise RuntimeError("Relenv requires Python 3.10 or newer.")
+
 from relenv.common import __version__

relenv/__main__.py

@@ -4,13 +4,17 @@
 The entrypoint into relenv.
 """
 
+from __future__ import annotations
+
+import argparse
 from argparse import ArgumentParser
+from types import ModuleType
 
 from . import build, buildenv, check, create, fetch, pyversions, toolchain
 from .common import __version__
 
 
-def setup_cli():
+def setup_cli() -> ArgumentParser:
     """
     Build the argparser with its subparsers.
 
@@ -25,9 +29,11 @@ def setup_cli():
         description="Relenv",
     )
     argparser.add_argument("--version", action="version", version=__version__)
-    subparsers = argparser.add_subparsers()
+    subparsers: argparse._SubParsersAction[
+        argparse.ArgumentParser
+    ] = argparser.add_subparsers()
 
-    modules_to_setup = [
+    modules_to_setup: list[ModuleType] = [
         build,
         toolchain,
         create,
@@ -42,7 +48,7 @@ def setup_cli():
     return argparser
 
 
-def main():
+def main() -> None:
     """
     Run the relenv cli and disbatch to subcommands.
     """

relenv/buildenv.py

@@ -3,8 +3,12 @@
 """
 Helper for building libraries to install into a relenv environment.
 """
+from __future__ import annotations
+
+import argparse
 import json
 import logging
+import os
 import sys
 
 from .common import (
@@ -17,7 +21,9 @@
 log = logging.getLogger()
 
 
-def setup_parser(subparsers):
+def setup_parser(
+    subparsers: argparse._SubParsersAction[argparse.ArgumentParser],
+) -> None:
     """
     Setup the subparser for the ``relenv buildenv`` command.
 
@@ -36,14 +42,16 @@ def setup_parser(subparsers):
     )
 
 
-def is_relenv():
+def is_relenv() -> bool:
     """
     True when we are in a relenv environment.
     """
     return hasattr(sys, "RELENV")
 
 
-def buildenv(relenv_path=None):
+def buildenv(
+    relenv_path: str | os.PathLike[str] | None = None,
+) -> dict[str, str]:
     """
     Relenv build environment variable mapping.
     """
@@ -90,7 +98,7 @@ def buildenv(relenv_path=None):
     return env
 
 
-def main(args):
+def main(args: argparse.Namespace) -> None:
     """
     The entrypoint into the ``relenv buildenv`` command.
 

relenv/check.py

@@ -3,6 +3,9 @@
 """
 Check the integrety of a relenv environment.
 """
+from __future__ import annotations
+
+import argparse
 import logging
 import pathlib
 import sys
@@ -12,7 +15,9 @@
 log = logging.getLogger()
 
 
-def setup_parser(subparsers):
+def setup_parser(
+    subparsers: argparse._SubParsersAction[argparse.ArgumentParser],
+) -> None:
     """
     Setup the subparser for the ``relenv check`` command.
 
@@ -23,7 +28,7 @@ def setup_parser(subparsers):
     subparser.set_defaults(func=main)
 
 
-def main(args):
+def main(args: argparse.Namespace) -> None:
     """
     The entrypoint into the ``relenv check`` command.