chore: replace isort and black with ruff

docs/conf.py

@@ -32,9 +32,7 @@
 # Replace |version| in the docs with the actual version string.
 rst_epilog = """
 .. |version| replace:: {version}
-""".format(
-    version=version
-)
+""".format(version=version)
 
 # -- General configuration ---------------------------------------------------
 

gapic/cli/generate.py

@@ -39,7 +39,7 @@
     "--output",
     type=click.File("wb"),
     default=sys.stdout.buffer,
-    help="Where to output the `CodeGeneratorResponse`. " "Defaults to stdout.",
+    help="Where to output the `CodeGeneratorResponse`. Defaults to stdout.",
 )
 def generate(request: typing.BinaryIO, output: typing.BinaryIO) -> None:
     """Generate a full API client description."""

gapic/generator/generator.py

@@ -131,9 +131,7 @@ def get_response(self, api_schema: api.API, opts: Options) -> CodeGeneratorRespo
             )
 
         # Return the CodeGeneratorResponse output.
-        res = CodeGeneratorResponse(
-            file=[i for i in output_files.values()]
-        )  # type: ignore
+        res = CodeGeneratorResponse(file=[i for i in output_files.values()])  # type: ignore
         res.supported_features |= CodeGeneratorResponse.Feature.FEATURE_PROTO3_OPTIONAL  # type: ignore
         return res
 

gapic/samplegen_utils/snippet_index.py

@@ -117,7 +117,9 @@ def __init__(self, api_schema: api.API):
         self.metadata_index.client_library.name = (
             api_schema.naming.warehouse_package_name
         )
-        self.metadata_index.client_library.language = snippet_metadata_pb2.Language.PYTHON  # type: ignore
+        self.metadata_index.client_library.language = (
+            snippet_metadata_pb2.Language.PYTHON  # type: ignore
+        )
 
         self.metadata_index.client_library.version = api_schema.gapic_version
 

gapic/samplegen_utils/yaml.py

@@ -116,7 +116,9 @@ def get(self, key, default=None):
         return next(
             iter(
                 [
-                    e.val for e in self.elements if e.key == key  # type: ignore
+                    e.val
+                    for e in self.elements
+                    if e.key == key  # type: ignore
                 ]  # type: ignore
             ),
             default,

gapic/schema/api.py

@@ -941,11 +941,7 @@ def enforce_valid_library_settings(
             selective_gapic_errors = {}
             # TODO(https://github.com/googleapis/gapic-generator-python/issues/2446):
             # Workaround issue in Python 3.14 related to code coverage by adding `# pragma: no branch`
-            for (
-                method_name
-            ) in (
-                library_settings.python_settings.common.selective_gapic_generation.methods
-            ):  # pragma: no branch
+            for method_name in library_settings.python_settings.common.selective_gapic_generation.methods:  # pragma: no branch
                 if method_name not in self.all_methods:
                     selective_gapic_errors[method_name] = "Method does not exist."
                 elif not method_name.startswith(library_settings.version):
@@ -1180,8 +1176,7 @@ def __init__(
                 object.__setattr__(field, "enum", maybe_enum_type)
             else:
                 raise TypeError(
-                    f"Unknown type referenced in "
-                    f"{self.file_descriptor.name}: '{key}'"
+                    f"Unknown type referenced in {self.file_descriptor.name}: '{key}'"
                 )
 
         # Only generate the service if this is a target file to be generated.

gapic/schema/metadata.py

@@ -357,7 +357,7 @@ def resolve(self, selector: str) -> str:
             str: An absolute selector.
         """
         if "." not in selector:
-            return f'{".".join(self.package)}.{selector}'
+            return f"{'.'.join(self.package)}.{selector}"
         return selector
 
     @cached_proto_context

gapic/schema/naming.py

@@ -86,7 +86,7 @@ def build(
                 "The protos provided do not share a common root package. "
                 "Ensure that all explicitly-specified protos are for a "
                 "single API. "
-                f'The packages we got are: {", ".join(proto_packages)}'
+                f"The packages we got are: {', '.join(proto_packages)}"
             )
 
         # Define the valid regex to split the package.

gapic/schema/wrappers.py

@@ -799,7 +799,7 @@ def get_field(
         # Quick check: If this cursor has no message, there is a problem.
         if not cursor.message:
             raise KeyError(
-                f'Field {".".join(field_path)} could not be resolved from '
+                f"Field {'.'.join(field_path)} could not be resolved from "
                 f"{cursor.name}.",
             )
 

gapic/templates/noxfile.py.j2

@@ -12,8 +12,7 @@ import warnings
 
 import nox
 
-BLACK_VERSION = "black[jupyter]==23.7.0"
-ISORT_VERSION = "isort==5.11.0"
+RUFF_VERSION = "ruff==0.14.14"
 
 {% if api.naming.module_namespace %}
 LINT_PATHS = ["docs", "{{ api.naming.module_namespace[0] }}", "tests", "noxfile.py", "setup.py"]
@@ -147,13 +146,18 @@ def lint(session):
     Returns a failure if the linters find linting errors or sufficiently
     serious code quality issues.
     """
-    session.install("flake8", BLACK_VERSION)
+    session.install("flake8", RUFF_VERSION)
+
+    # 2. Check formatting
     session.run(
-        "black",
+        "ruff", "format",
         "--check",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88", 
         *LINT_PATHS,
     )
 
+
 {% if api.naming.module_namespace %}
     session.run("flake8", "{{ api.naming.module_namespace[0] }}", "tests")
 {% else %}
@@ -163,30 +167,44 @@ def lint(session):
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def blacken(session):
-    """Run black. Format code to uniform standard."""
-    session.install(BLACK_VERSION)
+    """(Deprecated) Legacy session. Please use 'nox -s format'."""
+    session.log("WARNING: The 'blacken' session is deprecated and will be removed in a future release. Please use 'nox -s format' in the future.")
+
+    # Just run the ruff formatter (keeping legacy behavior of only formatting, not sorting imports)
+    session.install(RUFF_VERSION)
     session.run(
-        "black",
+        "ruff", "format",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",
         *LINT_PATHS,
     )
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def format(session):
     """
-    Run isort to sort imports. Then run black
-    to format code to uniform standard.
+    Run ruff to sort imports and format code.
     """
-    session.install(BLACK_VERSION, ISORT_VERSION)
-    # Use the --fss option to sort imports using strict alphabetical order.
-    # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections
+    # 1. Install ruff (skipped automatically if you run with --no-venv)
+    session.install(RUFF_VERSION)
+
+    # 2. Run Ruff to fix imports
+    # check --select I: Enables strict import sorting
+    # --fix: Applies the changes automatically
     session.run(
-        "isort",
-        "--fss",
+        "ruff", "check",
+        "--select", "I",
+        "--fix",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",  # Standard Black line length
         *LINT_PATHS,
     )
+
+    # 3. Run Ruff to format code
     session.run(
-        "black",
+        "ruff", "format",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",  # Standard Black line length
         *LINT_PATHS,
     )
 

gapic/utils/cache.py

@@ -101,7 +101,6 @@ def cached_proto_context(func):
 
     @functools.wraps(func)
     def wrapper(self, *, collisions, **kwargs):
-
         # 1. Check for active cache (returns None if context is not active)
         context_cache = getattr(
             _proto_collisions_cache_state, "resolved_collisions", None

noxfile.py

@@ -31,10 +31,12 @@
 
 showcase_version = os.environ.get("SHOWCASE_VERSION", "0.35.0")
 ADS_TEMPLATES = path.join(path.dirname(__file__), "gapic", "ads-templates")
-BLACK_VERSION = "black==25.1.0"
-BLACK_PATHS = ["docs", "gapic", "tests", "test_utils", "noxfile.py", "setup.py"]
-# exclude golden files and generated protobuf code
-BLACK_EXCLUDES = "|".join([".*golden.*", ".*pb2.py"])
+RUFF_VERSION = "ruff==0.14.14"
+LINT_PATHS = ["docs", "gapic", "tests", "test_utils", "noxfile.py", "setup.py"]
+# Ruff uses globs for excludes (different from Black's regex)
+# .*golden.* -> *golden*
+# .*pb2.py -> *pb2.py
+RUFF_EXCLUDES = "*golden*,*pb2.py,*pb2.pyi"
 
 ALL_PYTHON = (
     "3.7",
@@ -755,14 +757,19 @@ def lint(session):
     Returns a failure if the linters find linting errors or sufficiently
     serious code quality issues.
     """
-    session.install("flake8", BLACK_VERSION)
+    session.install("flake8", RUFF_VERSION)
+
+    # 2. Check formatting
     session.run(
-        "black",
+        "ruff",
+        "format",
         "--check",
-        *BLACK_PATHS,
-        "--extend-exclude",
-        BLACK_EXCLUDES,
+        *LINT_PATHS,
+        "--exclude",
+        RUFF_EXCLUDES,
     )
+
+    # 3. Run Flake8
     session.run(
         "flake8",
         "gapic",
@@ -772,11 +779,54 @@ def lint(session):
 
 @nox.session(python="3.10")
 def blacken(session):
-    """Run black. Format code to uniform standard."""
-    session.install(BLACK_VERSION)
+    """Run ruff format.
+
+    DEPRECATED: This session now uses Ruff instead of Black.
+    It formats code style only (indentation, quotes, etc).
+    """
+    session.log(
+        "WARNING: The 'blacken' session is deprecated and will be removed in the next release. Please use 'nox -s format' in the future."
+    )
+
+    session.install(RUFF_VERSION)
+
+    # 1. Format Code (Replaces black)
+    # We do NOT run 'ruff check --select I' here, preserving strict parity.
+    session.run(
+        "ruff",
+        "format",
+        "--line-length=88",  # Standard Black line length
+        *LINT_PATHS,
+        "--exclude",
+        RUFF_EXCLUDES,
+    )
+
+
+@nox.session(python=NEWEST_PYTHON)
+def format(session):
+    """
+    Run ruff to sort imports and format code.
+    """
+    # 1. Install ruff (skipped automatically if you run with --no-venv)
+    session.install(RUFF_VERSION)
+
+    # 2. Run Ruff to fix imports
+    # check --select I: Enables strict import sorting
+    # --fix: Applies the changes automatically
+    session.run(
+        "ruff",
+        "check",
+        "--select",
+        "I",
+        "--fix",
+        "--line-length=88",  # Standard Black line length
+        *LINT_PATHS,
+    )
+
+    # 3. Run Ruff to format code
     session.run(
-        "black",
-        *BLACK_PATHS,
-        "--extend-exclude",
-        BLACK_EXCLUDES,
+        "ruff",
+        "format",
+        "--line-length=88",  # Standard Black line length
+        *LINT_PATHS,
     )

tests/integration/goldens/asset/noxfile.py

@@ -23,8 +23,7 @@
 
 import nox
 
-BLACK_VERSION = "black[jupyter]==23.7.0"
-ISORT_VERSION = "isort==5.11.0"
+RUFF_VERSION = "ruff==0.14.14"
 
 LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]
 
@@ -150,10 +149,14 @@ def lint(session):
     Returns a failure if the linters find linting errors or sufficiently
     serious code quality issues.
     """
-    session.install("flake8", BLACK_VERSION)
+    session.install("flake8", RUFF_VERSION)
+
+    # 2. Check formatting
     session.run(
-        "black",
+        "ruff", "format",
         "--check",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",
         *LINT_PATHS,
     )
 
@@ -162,30 +165,44 @@ def lint(session):
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def blacken(session):
-    """Run black. Format code to uniform standard."""
-    session.install(BLACK_VERSION)
+    """(Deprecated) Legacy session. Please use 'nox -s format'."""
+    session.log("WARNING: The 'blacken' session is deprecated and will be removed in a future release. Please use 'nox -s format' in the future.")
+
+    # Just run the ruff formatter (keeping legacy behavior of only formatting, not sorting imports)
+    session.install(RUFF_VERSION)
     session.run(
-        "black",
+        "ruff", "format",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",
         *LINT_PATHS,
     )
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def format(session):
     """
-    Run isort to sort imports. Then run black
-    to format code to uniform standard.
+    Run ruff to sort imports and format code.
     """
-    session.install(BLACK_VERSION, ISORT_VERSION)
-    # Use the --fss option to sort imports using strict alphabetical order.
-    # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections
+    # 1. Install ruff (skipped automatically if you run with --no-venv)
+    session.install(RUFF_VERSION)
+
+    # 2. Run Ruff to fix imports
+    # check --select I: Enables strict import sorting
+    # --fix: Applies the changes automatically
     session.run(
-        "isort",
-        "--fss",
+        "ruff", "check",
+        "--select", "I",
+        "--fix",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",  # Standard Black line length
         *LINT_PATHS,
     )
+
+    # 3. Run Ruff to format code
     session.run(
-        "black",
+        "ruff", "format",
+        f"--target-version=py{ALL_PYTHON[0].replace('.', '')}",
+        "--line-length=88",  # Standard Black line length
         *LINT_PATHS,
     )