chore: use ruff based code formatting

Author: ohmayr

.generator/cli.py

@@ -23,6 +23,7 @@
 import subprocess
 import sys
 import tempfile
+import time
 import yaml
 from datetime import date, datetime
 from functools import lru_cache
@@ -31,6 +32,40 @@
 import build.util
 import parse_googleapis_content
 
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+import functools
+
+PERF_LOGGING_ENABLED = os.environ.get("ENABLE_PERF_LOGS") == "1"
+
+if PERF_LOGGING_ENABLED:
+    perf_logger = logging.getLogger("performance_metrics")
+    perf_logger.setLevel(logging.INFO)
+    perf_handler = logging.FileHandler("/tmp/performance_metrics.log", mode='w')
+    perf_formatter = logging.Formatter('%(asctime)s | %(message)s', datefmt='%H:%M:%S')
+    perf_handler.setFormatter(perf_formatter)
+    perf_logger.addHandler(perf_handler)
+    perf_logger.propagate = False
+
+def track_time(func):
+    """
+    Decorator. Usage: @track_time
+    If logging is OFF, it returns the original function (Zero Overhead).
+    If logging is ON, it wraps the function to measure execution time.
+    """
+    if not PERF_LOGGING_ENABLED:
+        return func
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        start_time = time.perf_counter()
+        try:
+            return func(*args, **kwargs)
+        finally:
+            duration = time.perf_counter() - start_time
+            perf_logger.info(f"{func.__name__:<30} | {duration:.4f} seconds")
+            
+    return wrapper
 
 try:
     import synthtool
@@ -323,8 +358,9 @@ def _get_library_id(request_data: Dict) -> str:
     return library_id
 
 
+@track_time
 def _run_post_processor(output: str, library_id: str, is_mono_repo: bool):
-    """Runs the synthtool post-processor on the output directory.
+    """Runs the synthtool post-processor (templates) and Ruff formatter (lint/format).
 
     Args:
         output(str): Path to the directory in the container where code
@@ -334,25 +370,58 @@ def _run_post_processor(output: str, library_id: str, is_mono_repo: bool):
     """
     os.chdir(output)
     path_to_library = f"packages/{library_id}" if is_mono_repo else "."
-    logger.info("Running Python post-processor...")
+    
+    # 1. Run Synthtool (Templates & Fixers only)
+    # Note: This relies on 'nox' being disabled in your environment (via run_fast.sh shim)
+    # to avoid the slow formatting step inside owlbot.
+    logger.info("Running Python post-processor (Templates & Fixers)...")
     if SYNTHTOOL_INSTALLED:
-        if is_mono_repo:
-            python_mono_repo.owlbot_main(path_to_library)
-        else:
-            # Some repositories have customizations in `librarian.py`.
-            # If this file exists, run those customizations instead of `owlbot_main`
-            if Path(f"{output}/librarian.py").exists():
-                subprocess.run(["python3.14", f"{output}/librarian.py"])
+        try:
+            if is_mono_repo:
+                python_mono_repo.owlbot_main(path_to_library)
             else:
-                python.owlbot_main()
-    else:
-        raise SYNTHTOOL_IMPORT_ERROR  # pragma: NO COVER
+                # Handle custom librarian scripts if present
+                if Path(f"{output}/librarian.py").exists():
+                    subprocess.run(["python3.14", f"{output}/librarian.py"])
+                else:
+                    python.owlbot_main()
+        except Exception as e:
+            logger.warning(f"Synthtool warning (non-fatal): {e}")
+
+    # 2. Run RUFF (Fast Formatter & Import Sorter)
+    # This replaces both 'isort' and 'black' and runs in < 1 second.
+    # We hardcode flags here to match Black defaults so you don't need config files.
+    # logger.info("🚀 Running Ruff (Fast Formatter)...")
+    try:
+        # STEP A: Fix Imports (like isort)
+        subprocess.run(
+            [
+                "ruff", "check", 
+                "--select", "I",               # Only run Import sorting rules
+                "--fix",                       # Auto-fix them
+                "--line-length=88",            # Match Black default
+                "--known-first-party=google",  # Prevent 'google' moving to 3rd party block
+                output
+            ],
+            check=False, 
+            stdout=subprocess.DEVNULL, 
+            stderr=subprocess.DEVNULL
+        )
 
-    # If there is no noxfile, run `isort`` and `black` on the output.
-    # This is required for proto-only libraries which are not GAPIC.
-    if not Path(f"{output}/{path_to_library}/noxfile.py").exists():
-        subprocess.run(["isort", output])
-        subprocess.run(["black", output])
+        # STEP B: Format Code (like black)
+        subprocess.run(
+            [
+                "ruff", "format", 
+                "--line-length=88",            # Match Black default
+                output
+            ],
+            check=False, 
+            stdout=subprocess.DEVNULL, 
+            stderr=subprocess.DEVNULL
+        )
+    except FileNotFoundError:
+        logger.warning("⚠️ Ruff binary not found. Code will be unformatted.")
+        logger.warning("   Please run: pip install ruff")
 
     logger.info("Python post-processor ran successfully.")
 
@@ -392,6 +461,7 @@ def _add_header_to_files(directory: str) -> None:
                 f.writelines(lines)
 
 
+@track_time
 def _copy_files_needed_for_post_processing(
     output: str, input: str, library_id: str, is_mono_repo: bool
 ):
@@ -444,6 +514,7 @@ def _copy_files_needed_for_post_processing(
                 )
 
 
+@track_time
 def _clean_up_files_after_post_processing(
     output: str, library_id: str, is_mono_repo: bool
 ):
@@ -590,6 +661,7 @@ def _get_repo_name_from_repo_metadata(base: str, library_id: str, is_mono_repo:
     return repo_name
 
 
+@track_time
 def _generate_repo_metadata_file(
     output: str, library_id: str, source: str, apis: List[Dict], is_mono_repo: bool
 ):
@@ -631,6 +703,7 @@ def _generate_repo_metadata_file(
     _write_json_file(output_repo_metadata, metadata_content)
 
 
+@track_time
 def _copy_readme_to_docs(output: str, library_id: str, is_mono_repo: bool):
     """Copies the README.rst file for a generated library to docs/README.rst.
 
@@ -672,6 +745,7 @@ def _copy_readme_to_docs(output: str, library_id: str, is_mono_repo: bool):
         f.write(content)
 
 
+@track_time
 def handle_generate(
     librarian: str = LIBRARIAN_DIR,
     source: str = SOURCE_DIR,
@@ -933,6 +1007,7 @@ def _stage_gapic_library(tmp_dir: str, staging_dir: str) -> None:
     shutil.copytree(tmp_dir, staging_dir, dirs_exist_ok=True)
 
 
+@track_time
 def _generate_api(
     api_path: str,
     library_id: str,
@@ -1748,6 +1823,7 @@ def handle_release_stage(
             output=args.output,
             input=args.input,
         )
+
     elif args.command == "build":
         args.func(librarian=args.librarian, repo=args.repo)
     elif args.command == "release-stage":

.generator/requirements.in

@@ -3,5 +3,4 @@ gapic-generator==1.30.3 # Fix mypy checks https://github.com/googleapis/gapic-ge
 nox
 starlark-pyo3>=2025.1
 build
-black==23.7.0
-isort==5.11.0
+ruff

.librarian/generate-request.json

@@ -0,0 +1,40 @@
+{
+  "id": "google-cloud-vision",
+  "version": "3.12.0",
+  "apis": [
+    {
+      "path": "google/cloud/vision/v1p3beta1",
+      "service_config": "vision_v1p3beta1.yaml"
+    },
+    {
+      "path": "google/cloud/vision/v1",
+      "service_config": "vision_v1.yaml"
+    },
+    {
+      "path": "google/cloud/vision/v1p1beta1",
+      "service_config": "vision_v1p1beta1.yaml"
+    },
+    {
+      "path": "google/cloud/vision/v1p2beta1",
+      "service_config": "vision_v1p2beta1.yaml"
+    },
+    {
+      "path": "google/cloud/vision/v1p4beta1",
+      "service_config": "vision_v1p4beta1.yaml"
+    }
+  ],
+  "source_roots": [
+    "packages/google-cloud-vision"
+  ],
+  "preserve_regex": [
+    "packages/google-cloud-vision/CHANGELOG.md",
+    "docs/CHANGELOG.md",
+    "samples/README.txt",
+    "samples/snippets/README.rst",
+    "tests/system"
+  ],
+  "remove_regex": [
+    "packages/google-cloud-vision/"
+  ],
+  "tag_format": "{id}-v{version}"
+}

packages/google-cloud-vision/docs/conf.py

@@ -25,9 +25,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sys
 import os
 import shlex
-import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -81,9 +81,9 @@
 root_doc = "index"
 
 # General information about the project.
-project = "google-cloud-vision"
-copyright = "2025, Google, LLC"
-author = "Google APIs"
+project = u"google-cloud-vision"
+copyright = u"2025, Google, LLC"
+author = u"Google APIs"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -283,7 +283,7 @@
     (
         root_doc,
         "google-cloud-vision.tex",
-        "google-cloud-vision Documentation",
+        u"google-cloud-vision Documentation",
         author,
         "manual",
     )