chore: use ruff to lint and format files and apply fixes (#3779)

There have been a few attempts at doing these, but the efforts are
stale. Since `ruff` is very popular these days and it is only a single
binary and is fast, let's use that.

From now on we will be able to maintain the files better, because we
have a CI step testing the compliance.

Closes #3073

Author: aignas

.agents/skills/buildkite-get-results/scripts/get_buildkite_results.py

@@ -85,7 +85,10 @@ def fetch_buildkite_data(build_url):
                     elif isinstance(jobs_data, dict) and "records" in jobs_data:
                         data["jobs"] = jobs_data["records"]
         except Exception as e:
-            print(f"Warning: Could not fetch detailed jobs from {jobs_url}: {e}", file=sys.stderr)
+            print(
+                f"Warning: Could not fetch detailed jobs from {jobs_url}: {e}",
+                file=sys.stderr,
+            )
 
     return data
 
@@ -165,15 +168,18 @@ def main():
 
     build_state = data.get("state", "Unknown")
     print(f"Build State: {build_state}")
-    
+
     jobs = data.get("jobs", [])
     jobs_count = data.get("statistics", {}).get("jobs_count", 0)
-    
+
     print(f"Total jobs reported: {jobs_count}")
     print(f"Jobs found in data: {len(jobs)}")
-    
+
     if jobs_count != len(jobs):
-        print(f"WARNING: Reported job count ({jobs_count}) does not match jobs found ({len(jobs)}).", file=sys.stderr)
+        print(
+            f"WARNING: Reported job count ({jobs_count}) does not match jobs found ({len(jobs)}).",
+            file=sys.stderr,
+        )
 
     print("-" * 40)
 

.github/workflows/ci.yaml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: read
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the code
+      - uses: actions/checkout@v6
+      - uses: jpetrucciani/mypy-check@master
+        with:
+          path: 'python/runfiles'
+      - uses: jpetrucciani/mypy-check@master
+        with:
+          path: 'tests/runfiles'
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/ruff-action@v4.0.0
+        with:
+          # Keep in sync with .pre-commit-config.yaml
+          version: 0.15.14
+          args: check --extend-exclude testdata
+      - uses: astral-sh/ruff-action@v4.0.0
+        with:
+          version: 0.15.14
+          args: format --check --exclude testdata

.github/workflows/mypy.yaml

@@ -29,18 +29,15 @@ repos:
           - --warnings=all
       - id: buildifier-lint
         args: *args
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Keep in sync with .github/workflows/ruff.yaml
+    rev: v0.15.14
     hooks:
-      - id: isort
-        name: isort (python)
-        args:
-          - --profile
-          - black
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
+      - id: ruff-check
+        args: [--fix]
+        exclude: testdata
+      - id: ruff-format
+        exclude: testdata
   - repo: local
     hooks:
       - id: update-deleted-packages

.pre-commit-config.yaml

@@ -133,11 +133,11 @@
 # --- Extlinks configuration
 extlinks = {
     "gh-issue": (
-        f"https://github.com/bazel-contrib/rules_python/issues/%s",
+        "https://github.com/bazel-contrib/rules_python/issues/%s",
         "#%s issue",
     ),
-    "gh-path": (f"https://github.com/bazel-contrib/rules_python/tree/main/%s", "%s"),
-    "gh-pr": (f"https://github.com/bazel-contrib/rules_python/pull/%s", "#%s PR"),
+    "gh-path": ("https://github.com/bazel-contrib/rules_python/tree/main/%s", "%s"),
+    "gh-pr": ("https://github.com/bazel-contrib/rules_python/pull/%s", "#%s PR"),
 }
 
 # --- MyST configuration

docs/conf.py

@@ -15,7 +15,6 @@
 import os
 import pathlib
 import subprocess
-import tempfile
 import unittest
 
 from python.runfiles import runfiles
@@ -29,9 +28,9 @@ def __init__(self, *args, **kwargs):
 
     def test_pylint_entry_point(self):
         rlocation_path = os.environ.get("ENTRY_POINT")
-        assert (
-            rlocation_path is not None
-        ), "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        assert rlocation_path is not None, (
+            "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        )
 
         entry_point = pathlib.Path(runfiles.Create().Rlocation(rlocation_path))
         self.assertTrue(entry_point.exists(), f"'{entry_point}' does not exist")
@@ -51,20 +50,20 @@ def test_pylint_entry_point(self):
             "",
             proc.stderr.decode("utf-8").strip(),
         )
-        self.assertRegex(proc.stdout.decode("utf-8").strip(), "^pylint 2\.15\.9")
+        self.assertRegex(proc.stdout.decode("utf-8").strip(), r"^pylint 2\.15\.9")
 
     def test_pylint_report_has_expected_warnings(self):
         rlocation_path = os.environ.get("PYLINT_REPORT")
-        assert (
-            rlocation_path is not None
-        ), "expected 'PYLINT_REPORT' env variable to be set to rlocation of the report"
+        assert rlocation_path is not None, (
+            "expected 'PYLINT_REPORT' env variable to be set to rlocation of the report"
+        )
 
         pylint_report = pathlib.Path(runfiles.Create().Rlocation(rlocation_path))
         self.assertTrue(pylint_report.exists(), f"'{pylint_report}' does not exist")
 
         self.assertRegex(
             pylint_report.read_text().strip(),
-            "W8201: Logging should be used instead of the print\(\) function\. \(print-function\)",
+            r"W8201: Logging should be used instead of the print\(\) function\. \(print-function\)",
         )
 
 

examples/bzlmod/entry_points/tests/pylint_deps_test.py

@@ -28,9 +28,9 @@ def __init__(self, *args, **kwargs):
 
     def test_pylint_entry_point(self):
         rlocation_path = os.environ.get("ENTRY_POINT")
-        assert (
-            rlocation_path is not None
-        ), "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        assert rlocation_path is not None, (
+            "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        )
 
         entry_point = pathlib.Path(runfiles.Create().Rlocation(rlocation_path))
         self.assertTrue(entry_point.exists(), f"'{entry_point}' does not exist")
@@ -50,7 +50,7 @@ def test_pylint_entry_point(self):
             "",
             proc.stderr.decode("utf-8").strip(),
         )
-        self.assertRegex(proc.stdout.decode("utf-8").strip(), "^pylint 2\.15\.9")
+        self.assertRegex(proc.stdout.decode("utf-8").strip(), r"^pylint 2\.15\.9")
 
 
 if __name__ == "__main__":

examples/bzlmod/entry_points/tests/pylint_test.py

@@ -28,9 +28,9 @@ def __init__(self, *args, **kwargs):
 
     def test_yamllint_entry_point(self):
         rlocation_path = os.environ.get("ENTRY_POINT")
-        assert (
-            rlocation_path is not None
-        ), "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        assert rlocation_path is not None, (
+            "expected 'ENTRY_POINT' env variable to be set to rlocation of the tool"
+        )
 
         entry_point = pathlib.Path(runfiles.Create().Rlocation(rlocation_path))
         self.assertTrue(entry_point.exists(), f"'{entry_point}' does not exist")

examples/bzlmod/entry_points/tests/yamllint_test.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 import os
-import pathlib
 import re
 import sys
 import unittest
@@ -59,7 +58,7 @@ def test_coverage_sys_path(self):
                 f"sys.path has {len(sys.path)} items:\n    {all_paths}",
             )
 
-        first_item, last_item = sys.path[0], sys.path[-1]
+        first_item, _ = sys.path[0], sys.path[-1]
         self.assertFalse(
             first_item.endswith("coverage"),
             f"Expected the first item in sys.path '{first_item}' to not be related to coverage",

examples/bzlmod/test.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import sys
 
 import libs.my_lib as my_lib