Add apistub Check Without Tox

doc/tool_usage_guide.md

@@ -22,6 +22,7 @@ This repo is currently migrating all checks from a slower `tox`-based framework,
 |`black`| Runs `black` checks. | `azpysdk black .` |
 |`verifytypes`| Runs `verifytypes` checks. | `azpysdk verifytypes .` |
 |`ruff`| Runs `ruff` checks. | `azpysdk ruff .` |
+|`apistub`| Generates an api stub for the package. | `azpysdk apistub .` |
 |`bandit`| Runs `bandit` checks, which detect common security issues. | `azpysdk bandit .` |
 |`verifywhl`| Verifies that the root directory in whl is azure, and verifies manifest so that all directories in source are included in sdist. | `azpysdk verifywhl .` |
 |`verifysdist`| Verify directories included in sdist and contents in manifest file. Also ensures that py.typed configuration is correct within the setup.py. | `azpysdk verifysdist .` |

eng/tools/azure-sdk-tools/azpysdk/apistub.py

@@ -0,0 +1,138 @@
+import argparse
+import os
+import sys
+
+from typing import Optional, List
+from subprocess import CalledProcessError
+
+from .Check import Check
+from ci_tools.functions import install_into_venv, find_whl
+from ci_tools.scenario.generation import create_package_and_install
+from ci_tools.variables import discover_repo_root, set_envvar_defaults
+from ci_tools.logging import logger
+from ci_tools.parsing import ParsedSetup
+
+REPO_ROOT = discover_repo_root()
+MAX_PYTHON_VERSION = (3, 11)
+
+
+def get_package_wheel_path(pkg_root: str, out_path: Optional[str]) -> tuple[str, Optional[str]]:
+    # parse setup.py to get package name and version
+    pkg_details = ParsedSetup.from_path(pkg_root)
+
+    # Check if wheel is already built and available for current package
+    prebuilt_dir = os.getenv("PREBUILT_WHEEL_DIR")
+    out_token_path = None
+    if prebuilt_dir:
+        found_whl = find_whl(prebuilt_dir, pkg_details.name, pkg_details.version)
+        pkg_path = os.path.join(prebuilt_dir, found_whl) if found_whl else None
+        if not pkg_path:
+            raise FileNotFoundError(
+                "No prebuilt wheel found for package {} version {} in directory {}".format(
+                    pkg_details.name, pkg_details.version, prebuilt_dir
+                )
+            )
+        # If the package is a wheel and out_path is given, the token file output path should be the parent directory of the wheel
+        if out_path:
+            out_token_path = os.path.join(out_path, os.path.basename(os.path.dirname(pkg_path)))
+        return pkg_path, out_token_path
+
+    # Otherwise, use wheel created in staging directory, or fall back on source directory
+    pkg_path = find_whl(pkg_root, pkg_details.name, pkg_details.version) or pkg_root
+    out_token_path = out_path
+
+    return pkg_path, out_token_path
+
+
+def get_cross_language_mapping_path(pkg_root):
+    mapping_path = os.path.join(pkg_root, "apiview-properties.json")
+    if os.path.exists(mapping_path):
+        return mapping_path
+    return None
+
+
+class apistub(Check):
+    def __init__(self) -> None:
+        super().__init__()
+
+    def register(
+        self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None
+    ) -> None:
+        """Register the apistub check. The apistub check generates an API stub of the target package."""
+        parents = parent_parsers or []
+        p = subparsers.add_parser(
+            "apistub", parents=parents, help="Run the apistub check to generate an API stub for a package"
+        )
+        p.set_defaults(func=self.run)
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the apistub check command."""
+        logger.info("Running apistub check...")
+
+        if sys.version_info > MAX_PYTHON_VERSION:
+            logger.error(
+                f"Python version {sys.version_info.major}.{sys.version_info.minor} is not supported. Maximum supported version is {MAX_PYTHON_VERSION[0]}.{MAX_PYTHON_VERSION[1]}."
+            )
+            return 1
+
+        set_envvar_defaults()
+        targeted = self.get_targeted_directories(args)
+
+        results: List[int] = []
+
+        for parsed in targeted:
+            package_dir = parsed.folder
+            package_name = parsed.name
+            executable, staging_directory = self.get_executable(args.isolate, args.command, sys.executable, package_dir)
+            logger.info(f"Processing {package_name} for apistub check")
+
+            # install dependencies
+            self.install_dev_reqs(executable, args, package_dir)
+
+            try:
+                install_into_venv(
+                    executable,
+                    [
+                        "-r",
+                        os.path.join(REPO_ROOT, "eng", "apiview_reqs.txt"),
+                        "--index-url=https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/",
+                    ],
+                    package_dir,
+                )
+            except CalledProcessError as e:
+                logger.error(f"Failed to install dependencies: {e}")
+                return e.returncode
+
+            create_package_and_install(
+                distribution_directory=staging_directory,
+                target_setup=package_dir,
+                skip_install=True,
+                cache_dir=None,
+                work_dir=staging_directory,
+                force_create=False,
+                package_type="wheel",
+                pre_download_disabled=False,
+                python_executable=executable,
+            )
+
+            self.pip_freeze(executable)
+
+            pkg_path, out_token_path = get_package_wheel_path(package_dir, staging_directory)
+            cross_language_mapping_path = get_cross_language_mapping_path(package_dir)
+
+            cmds = ["-m", "apistub", "--pkg-path", pkg_path]
+
+            if out_token_path:
+                cmds.extend(["--out-path", out_token_path])
+            if cross_language_mapping_path:
+                cmds.extend(["--mapping-path", cross_language_mapping_path])
+
+            logger.info("Running apistub {}.".format(cmds))
+
+            try:
+                self.run_venv_command(executable, cmds, cwd=package_dir, check=True, immediately_dump=True)
+            except CalledProcessError as e:
+                logger.error(f"{package_name} exited with error {e.returncode}")
+                results.append(e.returncode)
+
+        return max(results) if results else 0

eng/tools/azure-sdk-tools/azpysdk/main.py

@@ -24,6 +24,7 @@
 from .next_pyright import next_pyright
 from .ruff import ruff
 from .verifytypes import verifytypes
+from .apistub import apistub
 from .verify_sdist import verify_sdist
 from .whl import whl
 from .verify_whl import verify_whl
@@ -86,6 +87,7 @@ def build_parser() -> argparse.ArgumentParser:
     next_pyright().register(subparsers, [common])
     ruff().register(subparsers, [common])
     verifytypes().register(subparsers, [common])
+    apistub().register(subparsers, [common])
     verify_sdist().register(subparsers, [common])
     whl().register(subparsers, [common])
     verify_whl().register(subparsers, [common])

sdk/template/azure-template/pyproject.toml

@@ -49,3 +49,4 @@ pyright = true
 pylint = true
 black = true
 generate = false
+apistub = false