Add Next-Pylint, Next-Mypy, and Next-Sphinx Checks (#42923)

* add next-pylint

* add next-pylint

* clean import

* next-mypy

* next-sphinx

* add pygithub dependency

* clean

* newlines

* add dev req installs to all checks

* replace a print

Author: JennyPng

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

@@ -46,6 +46,8 @@ def run(self, args: argparse.Namespace) -> int:
             executable, staging_directory = self.get_executable(args.isolate, args.command, sys.executable, package_dir)
             logger.info(f"Processing {package_name} for black check")
 
+            self.install_dev_reqs(executable, args, package_dir)
+
             # install black
             try:
                 install_into_venv(executable, [f"black=={BLACK_VERSION}"], package_dir)

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

@@ -55,6 +55,8 @@ def run(self, args: argparse.Namespace) -> int:
             pkg = parsed.folder
             executable, staging_directory = self.get_executable(args.isolate, args.command, sys.executable, pkg)
 
+            self.install_dev_reqs(executable, args, pkg)
+
             create_package_and_install(
                 distribution_directory=staging_directory,
                 target_setup=pkg,

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

@@ -15,8 +15,11 @@
 from .whl import whl
 from .import_all import import_all
 from .mypy import mypy
+from .next_mypy import next_mypy
 from .pylint import pylint
+from .next_pylint import next_pylint
 from .sphinx import sphinx
+from .next_sphinx import next_sphinx
 from .black import black
 from .ruff import ruff
 
@@ -76,8 +79,11 @@ def build_parser() -> argparse.ArgumentParser:
     whl().register(subparsers, [common])
     import_all().register(subparsers, [common])
     mypy().register(subparsers, [common])
+    next_mypy().register(subparsers, [common])
     pylint().register(subparsers, [common])
+    next_pylint().register(subparsers, [common])
     sphinx().register(subparsers, [common])
+    next_sphinx().register(subparsers, [common])
     black().register(subparsers, [common])
     ruff().register(subparsers, [common])
 

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

@@ -16,7 +16,6 @@
 
 PYTHON_VERSION = "3.9"
 MYPY_VERSION = "1.14.1"
-
 ADDITIONAL_LOCKED_DEPENDENCIES = [
   "types-chardet==5.0.4.6",
   "types-requests==2.31.0.6",

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

@@ -0,0 +1,22 @@
+import argparse
+
+from typing import Optional, List
+
+from .mypy import mypy
+
+class next_mypy(mypy):
+    def __init__(self):
+        super().__init__()
+
+    def register(self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None) -> None:
+        """Register the next-mypy check. The next-mypy check installs the next version of mypy and runs mypy against the target package.
+        """
+        parents = parent_parsers or []
+        p = subparsers.add_parser("next-mypy", parents=parents, help="Run the mypy check with the next version of mypy")
+        p.set_defaults(func=self.run)
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the next-mypy check command."""
+        args.next = True
+        return super().run(args)
+    

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

@@ -0,0 +1,22 @@
+import argparse
+
+from typing import Optional, List
+
+from .pylint import pylint
+
+class next_pylint(pylint):
+    def __init__(self):
+        super().__init__()
+
+    def register(self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None) -> None:
+        """Register the next-pylint check. The next-pylint check installs the next version of pylint and runs pylint against the target package.
+        """
+        parents = parent_parsers or []
+        p = subparsers.add_parser("next-pylint", parents=parents, help="Run the pylint check with the next version of pylint")
+        p.set_defaults(func=self.run)
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the next-pylint check command."""
+        args.next = True
+        return super().run(args)
+    

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

@@ -0,0 +1,25 @@
+import argparse
+
+from typing import Optional, List
+
+from .sphinx import sphinx
+
+class next_sphinx(sphinx):
+    def __init__(self):
+        super().__init__()
+
+    def register(self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None) -> None:
+        """Register the next-sphinx check. The next-sphinx check installs the next version of sphinx and runs sphinx against the target package.
+        """
+        parents = parent_parsers or []
+        p = subparsers.add_parser("next-sphinx", parents=parents, help="Run the sphinx check with the next version of sphinx")
+        p.set_defaults(func=self.run)
+
+        p.add_argument("--inci", dest="in_ci", action="store_true", default=False)
+
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the next-sphinx check command."""
+        args.next = True
+        return super().run(args)
+    

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

@@ -13,6 +13,7 @@
 
 REPO_ROOT = discover_repo_root()
 PYLINT_VERSION = "3.2.7"
+PYGITHUB_VERSION = "1.59.0"
 
 class pylint(Check):
     def __init__(self) -> None:
@@ -48,6 +49,7 @@ def run(self, args: argparse.Namespace) -> int:
             logger.info(f"Processing {package_name} for pylint check")
 
             # install dependencies
+            self.install_dev_reqs(executable, args, package_dir)
             try:
                 install_into_venv(executable, ["azure-pylint-guidelines-checker==0.5.6", "--index-url=https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"], package_dir)
             except CalledProcessError as e:
@@ -58,7 +60,7 @@ def run(self, args: argparse.Namespace) -> int:
             try:
                 if args.next:
                     # use latest version of pylint
-                    install_into_venv(executable, ["pylint"], package_dir)
+                    install_into_venv(executable, ["pylint", f"PyGithub=={PYGITHUB_VERSION}"], package_dir)
                 else:
                     install_into_venv(executable, [f"pylint=={PYLINT_VERSION}"], package_dir)
             except CalledProcessError as e:

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

@@ -22,6 +22,7 @@
 SPHINX_RTD_THEME_VERSION = "3.0.2"
 MYST_PARSER_VERSION = "4.0.1"
 SPHINX_CONTRIB_JQUERY_VERSION = "4.1"
+PYGITHUB_VERSION = "1.59.0"
 
 RST_EXTENSION_FOR_INDEX = """
 
@@ -264,6 +265,8 @@ def run(self, args: argparse.Namespace) -> int:
                 logger.error("This tool requires Python 3.11 or newer. Please upgrade your Python interpreter.")
                 return 1
 
+            self.install_dev_reqs(executable, args, package_dir)
+
             create_package_and_install(
                 distribution_directory=staging_directory,
                 target_setup=package_dir,
@@ -280,7 +283,7 @@ def run(self, args: argparse.Namespace) -> int:
             try:
                 if args.next:
                     install_into_venv(
-                        executable, ["sphinx", "sphinx_rtd_theme", "myst_parser", "sphinxcontrib-jquery"], package_dir
+                        executable, ["sphinx", "sphinx_rtd_theme", "myst_parser", "sphinxcontrib-jquery", f"PyGithub=={PYGITHUB_VERSION}"], package_dir
                     )
                 else:
                     install_into_venv(

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

@@ -40,14 +40,9 @@ def run(self, args: argparse.Namespace) -> int:
             pkg = parsed.folder
             executable, staging_directory = self.get_executable(args.isolate, args.command, sys.executable, pkg)
 
-            print(f"Invoking check with {executable}")
-            dev_requirements = os.path.join(pkg, "dev_requirements.txt")
+            logger.info(f"Invoking check with {executable}")
 
-            if os.path.exists(dev_requirements):
-                print(f"Installing dev_requirements at {dev_requirements}")
-                install_into_venv(executable, [f"{dev_requirements}"], pkg)
-            else:
-                print("Skipping installing dev_requirements")
+            self.install_dev_reqs(executable, args, pkg)
 
             create_package_and_install(
                 distribution_directory=staging_directory,