Check format on changes to azure-sdk-tools (#42912)

* code format eng/tools/azure-sdk-tools, add black enforcement to the package to prevent regression

Author: scbedd

.github/workflows/azure-sdk-tools.yml

@@ -31,6 +31,28 @@ jobs:
         shell: bash
         working-directory: eng/tools/azure-sdk-tools
 
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.13
+
+      - name: Install azure-sdk-tools
+        run: |
+          python -m pip install -e eng/tools/azure-sdk-tools[build,ghtools,conda]
+          python -m pip install black==24.4.0
+          python -m pip freeze
+        shell: bash
+
+      - name: Run black
+        run: |
+          black --check --config eng/black-pyproject.toml eng/tools/azure-sdk-tools --exclude 'templates'
+        shell: bash
+
   dev-setup-and-import:
     runs-on: ubuntu-latest
     steps:

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

@@ -120,23 +120,21 @@ def install_dev_reqs(self, executable: str, args: argparse.Namespace, package_di
         if os.path.exists(dev_requirements):
             requirements += ["-r", dev_requirements]
         else:
-            logger.warning(f"No dev_requirements.txt found for {package_dir}, skipping installation of dev requirements.")
+            logger.warning(
+                f"No dev_requirements.txt found for {package_dir}, skipping installation of dev requirements."
+            )
             return
 
         temp_req_file = None
         if not getattr(args, "isolate", False):
             # don't install azure-sdk-tools when not isolated
             with open(dev_requirements, "r") as f:
-                filtered_req_lines = [
-                    line.strip()
-                    for line in f 
-                    if "eng/tools/azure-sdk-tools" not in line
-                ]
+                filtered_req_lines = [line.strip() for line in f if "eng/tools/azure-sdk-tools" not in line]
             with tempfile.NamedTemporaryFile(mode="w", delete=False) as temp_req_file:
                 temp_req_file.write("\n".join(filtered_req_lines))
             if temp_req_file.name:
                 requirements = ["-r", temp_req_file.name]
-        try: 
+        try:
             logger.info(f"Installing dev requirements for {package_dir}")
             install_into_venv(executable, requirements, package_dir)
         except CalledProcessError as e:

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

@@ -3,7 +3,7 @@
 import sys
 import tempfile
 
-from typing import Optional,List
+from typing import Optional, List
 from subprocess import check_call
 
 from .Check import Check
@@ -17,16 +17,20 @@
 excluded_packages = [
     "azure",
     "azure-mgmt",
-    ]
+]
+
 
 def should_run_import_all(package_name: str) -> bool:
     return not (package_name in excluded_packages or "nspkg" in package_name)
 
+
 class import_all(Check):
     def __init__(self) -> None:
         super().__init__()
 
-    def register(self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None) -> None:
+    def register(
+        self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None
+    ) -> None:
         """Register the `import_all` check. The import_all check checks dependencies of a package
         by installing just the package + its dependencies, then attempts to import * from the base namespace.
 
@@ -66,22 +70,14 @@ def run(self, args: argparse.Namespace) -> int:
                 force_create=False,
                 package_type="wheel",
                 pre_download_disabled=False,
-                python_executable=executable
+                python_executable=executable,
             )
 
             if should_run_import_all(parsed.name):
                 # import all modules from current package
-                logger.info(
-                    "Importing all modules from namespace [{0}] to verify dependency".format(
-                        parsed.namespace
-                    )
-                )
+                logger.info("Importing all modules from namespace [{0}] to verify dependency".format(parsed.namespace))
                 import_script_all = "from {0} import *".format(parsed.namespace)
-                commands = [
-                    executable,
-                    "-c",
-                    import_script_all
-                ]
+                commands = [executable, "-c", import_script_all]
 
                 outcomes.append(check_call(commands))
                 logger.info("Verified module dependency, no issues found")

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

@@ -31,49 +31,38 @@
 __all__ = ["main", "build_parser"]
 __version__ = "0.0.0"
 
+
 def build_parser() -> argparse.ArgumentParser:
     """Create and return the top-level ArgumentParser for the CLI."""
-    parser = argparse.ArgumentParser(
-        prog="azpysdk", description="Azure SDK Python tools (minimal CLI)"
-    )
+    parser = argparse.ArgumentParser(prog="azpysdk", description="Azure SDK Python tools (minimal CLI)")
     parser.add_argument("-V", "--version", action="version", version=__version__)
     # global flag: allow --isolate to appear before the subcommand as well
-    parser.add_argument("--isolate", action="store_true", default=False,
-                        help="If set, run in an isolated virtual environment.")
+    parser.add_argument(
+        "--isolate", action="store_true", default=False, help="If set, run in an isolated virtual environment."
+    )
 
     # mutually exclusive logging options
     log_group = parser.add_mutually_exclusive_group()
     log_group.add_argument(
-        "--quiet",
-        action="store_true",
-        default=False,
-        help="Enable quiet mode (only shows ERROR logs)"
+        "--quiet", action="store_true", default=False, help="Enable quiet mode (only shows ERROR logs)"
     )
     log_group.add_argument(
-        "--verbose",
-        action="store_true",
-        default=False,
-        help="Enable verbose mode (shows DEBUG logs)"
+        "--verbose", action="store_true", default=False, help="Enable verbose mode (shows DEBUG logs)"
     )
     log_group.add_argument(
-        "--log-level",
-        choices=["DEBUG", "INFO", "WARN", "ERROR", "FATAL"],
-        help="Set the logging level."
+        "--log-level", choices=["DEBUG", "INFO", "WARN", "ERROR", "FATAL"], help="Set the logging level."
     )
 
     common = argparse.ArgumentParser(add_help=False)
     common.add_argument(
         "target",
         nargs="?",
         default="**",
-        help="Glob pattern for packages. Defaults to '**', but will match patterns below CWD if a value is provided."
+        help="Glob pattern for packages. Defaults to '**', but will match patterns below CWD if a value is provided.",
     )
     # allow --isolate to be specified after the subcommand as well
     common.add_argument(
-        "--isolate",
-        action="store_true",
-        default=False,
-        help="If set, run in an isolated virtual environment."
+        "--isolate", action="store_true", default=False, help="If set, run in an isolated virtual environment."
     )
 
     subparsers = parser.add_subparsers(title="commands", dest="command")
@@ -92,9 +81,10 @@ def build_parser() -> argparse.ArgumentParser:
     next_pyright().register(subparsers, [common])
     ruff().register(subparsers, [common])
     verifytypes().register(subparsers, [common])
-    
+
     return parser
 
+
 def main(argv: Optional[Sequence[str]] = None) -> int:
     """CLI entrypoint.
 
@@ -123,5 +113,6 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
         logger.error(f"Error: {exc}")
         return 2
 
+
 if __name__ == "__main__":
     raise SystemExit(main())

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

@@ -17,13 +17,14 @@
 PYTHON_VERSION = "3.9"
 MYPY_VERSION = "1.14.1"
 ADDITIONAL_LOCKED_DEPENDENCIES = [
-  "types-chardet==5.0.4.6",
-  "types-requests==2.31.0.6",
-  "types-six==1.16.21.9",
-  "types-redis==4.6.0.7",
-  "PyGitHub>=1.59.0"
+    "types-chardet==5.0.4.6",
+    "types-requests==2.31.0.6",
+    "types-six==1.16.21.9",
+    "types-redis==4.6.0.7",
+    "PyGitHub>=1.59.0",
 ]
 
+
 class mypy(Check):
     def __init__(self) -> None:
         super().__init__()

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

@@ -4,13 +4,15 @@
 
 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.
-        """
+    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)
@@ -19,4 +21,3 @@ 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

@@ -4,19 +4,22 @@
 
 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.
-        """
+    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 = 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_pyright.py

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

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

@@ -4,22 +4,24 @@
 
 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.
-        """
+    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 = 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)
-