From 1f7eebdd383bc09ea67707d924dd631290caaede Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 17:05:44 +0000
Subject: [PATCH 01/10] Rework our linting setup

---
 .github/workflows/tests.yml               | 21 ------------------
 .pre-commit-config.yaml                   | 26 +++++++++++++++++------
 pyproject.toml                            | 10 ++++-----
 requirements-tests.txt                    |  2 +-
 scripts/generate_proto_stubs.sh           |  6 ++----
 scripts/sync_tensorflow_protobuf_stubs.sh |  6 ++----
 6 files changed, 30 insertions(+), 41 deletions(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index e6ed3481ca5b..b2453af4eff6 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -44,27 +44,6 @@ jobs:
           python-version: "3.11"
       - run: ./tests/check_new_syntax.py
 
-  ruff:
-    name: Lint with Ruff
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
-        with:
-          version: "0.2.1" # must match .pre-commit-config.yaml and requirements-test.txt
-
-  flake8:
-    name: Lint with Flake8
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.11"
-      - run: curl -LsSf https://astral.sh/uv/install.sh | sh
-      - run: uv pip install -r requirements-tests.txt --system
-      - run: flake8 --color always
-
   pytype:
     name: Run pytype against the stubs
     runs-on: ubuntu-latest
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 9bf998ec4bdd..bc02761232bc 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -9,16 +9,28 @@ repos:
       - id: check-merge-conflict
       - id: mixed-line-ending
       - id: check-case-conflict
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0 # must match requirements-tests.txt and tests.yml
+    hooks:
+      - id: ruff
+        name: Run ruff on stubs, tests and scripts
+        args: ["--exit-non-zero-on-fix"]
+      - id: ruff
+        # Run this separately because we don't really want
+        # to use --unsafe-fixes for all rules
+        name: Remove unnecessary `sys.version_info` blocks
+        args: ["--exit-non-zero-on-fix", "--select=UP036", "--unsafe-fixes"]
+      - id: ruff
+        # This is the only rule
+        # that it's really useful to run on the test cases:
+        name: Check __future__ annotations in test cases
+        args: ["--exit-non-zero-on-fix", "--select=FA", "--no-force-exclude", "--unsafe-fixes"]
+        files: '.*test_cases/.+\.py$'
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.1.1 # must match requirements-tests.txt
     hooks:
       - id: black
         language_version: python3.10
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.2.1 # must match requirements-tests.txt and tests.yml
-    hooks:
-      - id: ruff
-        args: [--exit-non-zero-on-fix, --fix-only]
   - repo: https://github.com/pycqa/flake8
     rev: 7.0.0 # must match requirements-tests.txt
     hooks:
@@ -28,11 +40,13 @@ repos:
           - "flake8-pyi==24.1.0" # must match requirements-tests.txt
         types: [file]
         types_or: [python, pyi]
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
 
 ci:
   autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
   autofix_prs: true
   autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
   autoupdate_schedule: quarterly
-  skip: [flake8]
   submodules: false
diff --git a/pyproject.toml b/pyproject.toml
index 64a5cda842ac..02e203610a08 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -24,6 +24,10 @@ exclude = [
 ]
 
 [tool.ruff.lint]
+# Disable all rules on test cases by default:
+# test cases often deliberately contain code
+# that might not be considered idiomatic or modern
+exclude = ["**/test_cases/**/*.py"]
 select = [
     "B", # flake8-bugbear
     "FA", # flake8-future-annotations
@@ -48,12 +52,8 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
-# Disable "modernization" rules with autofixes from test cases as they often
-# deliberately contain code that might not be considered idiomatic or modern
-# These can be run manually once in a while
-"**/test_cases/**/*.py" = ["UP"]
 "*.pyi" = [
-    # Most flake8-bugbear rules don't apply for third-party stubs like typeshed,
+    # Most flake8-bugbear rules don't apply for third-party stubs like typeshed.
     # B033 could be slightly useful but Ruff doesn't have per-file select
     "B", # flake8-bugbear
 ]
diff --git a/requirements-tests.txt b/requirements-tests.txt
index b336a45085db..5bd9ba7da2f7 100644
--- a/requirements-tests.txt
+++ b/requirements-tests.txt
@@ -8,7 +8,7 @@ flake8-pyi==24.1.0       # must match .pre-commit-config.yaml
 mypy==1.8.0
 pre-commit-hooks==4.5.0  # must match .pre-commit-config.yaml
 pytype==2024.2.27; platform_system != "Windows" and python_version < "3.12"
-ruff==0.2.1              # must match .pre-commit-config.yaml and tests.yml
+ruff==0.3.0              # must match .pre-commit-config.yaml and tests.yml
 
 # Libraries used by our various scripts.
 aiohttp==3.9.3
diff --git a/scripts/generate_proto_stubs.sh b/scripts/generate_proto_stubs.sh
index 0e10aa2b4867..055f93c1a1c2 100755
--- a/scripts/generate_proto_stubs.sh
+++ b/scripts/generate_proto_stubs.sh
@@ -45,7 +45,7 @@ PYTHON_PROTOBUF_DIR="protobuf-$PYTHON_PROTOBUF_VERSION"
 VENV=venv
 python3 -m venv "$VENV"
 source "$VENV/bin/activate"
-pip install -r "$REPO_ROOT/requirements-tests.txt"  # for Black and Ruff
+pip install pre-commit
 
 # Install mypy-protobuf
 pip install mypy-protobuf=="$MYPY_PROTOBUF_VERSION"
@@ -73,9 +73,7 @@ PROTO_FILES=$(grep "GenProto.*google" $PYTHON_PROTOBUF_DIR/python/setup.py | \
 # shellcheck disable=SC2086
 protoc_install/bin/protoc --proto_path="$PYTHON_PROTOBUF_DIR/src" --mypy_out="relax_strict_optional_primitives:$REPO_ROOT/stubs/protobuf" $PROTO_FILES
 
-ruff check "$REPO_ROOT/stubs/protobuf" --fix-only
-ruff check "$REPO_ROOT/stubs/protobuf" --fix-only --select=UP036 --unsafe-fixes
-black "$REPO_ROOT/stubs/protobuf"
+pre-commit run --files "$REPO_ROOT/stubs/protobuf" || true
 
 sed --in-place="" \
   "s/extra_description = .*$/extra_description = \"Generated using [mypy-protobuf==$MYPY_PROTOBUF_VERSION](https:\/\/github.com\/nipunn1313\/mypy-protobuf\/tree\/v$MYPY_PROTOBUF_VERSION) on protobuf==$PYTHON_PROTOBUF_VERSION\"/" \
diff --git a/scripts/sync_tensorflow_protobuf_stubs.sh b/scripts/sync_tensorflow_protobuf_stubs.sh
index 3e4a355e0d67..79a696e0b54f 100755
--- a/scripts/sync_tensorflow_protobuf_stubs.sh
+++ b/scripts/sync_tensorflow_protobuf_stubs.sh
@@ -15,7 +15,7 @@ TENSORFLOW_VERSION=2.12.1
 # protobuf<4.
 MYPY_PROTOBUF_VERSION=3.5.0
 
-pip install mypy-protobuf=="$MYPY_PROTOBUF_VERSION"
+pip install pre-commit mypy-protobuf=="$MYPY_PROTOBUF_VERSION"
 
 cd "$(dirname "$0")" > /dev/null
 cd ../stubs/tensorflow
@@ -61,9 +61,7 @@ rm tensorflow/compiler/xla/service/hlo_execution_profile_data_pb2.pyi \
    tensorflow/core/protobuf/worker_service_pb2.pyi \
    tensorflow/core/util/example_proto_fast_parsing_test_pb2.pyi
 
-ruff check "$REPO_ROOT/stubs/tensorflow/tensorflow" --fix-only
-ruff check "$REPO_ROOT/stubs/protobuf" --fix-only --select=UP036 --unsafe-fixes
-black "$REPO_ROOT/stubs/tensorflow/tensorflow"
+pre-commit run --files "$REPO_ROOT/stubs/tensorflow/tensorflow" || true
 
 sed --in-place="" \
     "s/extra_description = .*$/extra_description = \"Partially generated using [mypy-protobuf==$MYPY_PROTOBUF_VERSION](https:\/\/github.com\/nipunn1313\/mypy-protobuf\/tree\/v$MYPY_PROTOBUF_VERSION) on tensorflow==$TENSORFLOW_VERSION\"/" \

From b92129024532e0ac0eb058c1ebf7b60ee40254bc Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 17:22:18 +0000
Subject: [PATCH 02/10] fix `check_consistent.py`

---
 tests/check_consistent.py | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/tests/check_consistent.py b/tests/check_consistent.py
index 1abb4d635148..18b7b2514870 100755
--- a/tests/check_consistent.py
+++ b/tests/check_consistent.py
@@ -158,16 +158,16 @@ def get_precommit_requirements() -> dict[str, SpecifierSet]:
     yam: PreCommitConfig = yaml.load(precommit, Loader=yaml.Loader)
     precommit_requirements: dict[str, SpecifierSet] = {}
     for repo in yam["repos"]:
-        if not repo.get("python_requirement", True):
+        package_rev = repo.get("rev")
+        if package_rev is None:
             continue
-        hook = repo["hooks"][0]
         package_name = Path(urllib.parse.urlparse(repo["repo"]).path).name
-        package_rev = repo["rev"].removeprefix("v")
-        package_specifier = SpecifierSet(f"=={package_rev}")
+        package_specifier = SpecifierSet(f"=={package_rev.removeprefix('v')}")
         precommit_requirements[package_name] = package_specifier
-        for additional_req in hook.get("additional_dependencies", ()):
-            req = Requirement(additional_req)
-            precommit_requirements[req.name] = req.specifier
+        for hook in repo["hooks"]:
+            for additional_req in hook.get("additional_dependencies", ()):
+                req = Requirement(additional_req)
+                precommit_requirements[req.name] = req.specifier
     return precommit_requirements
 
 

From b4ea3ee0504beca465d9473e14b3441ab88f1a51 Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 17:26:18 +0000
Subject: [PATCH 03/10] try to make pyright happy

---
 tests/check_consistent.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/tests/check_consistent.py b/tests/check_consistent.py
index 18b7b2514870..bf02d848c0a7 100755
--- a/tests/check_consistent.py
+++ b/tests/check_consistent.py
@@ -145,7 +145,6 @@ def get_txt_requirements() -> dict[str, SpecifierSet]:
 class PreCommitConfigRepos(TypedDict):
     hooks: list[dict[str, str]]
     repo: str
-    rev: str
 
 
 class PreCommitConfig(TypedDict):
@@ -159,7 +158,7 @@ def get_precommit_requirements() -> dict[str, SpecifierSet]:
     precommit_requirements: dict[str, SpecifierSet] = {}
     for repo in yam["repos"]:
         package_rev = repo.get("rev")
-        if package_rev is None:
+        if not isinstance(package_rev, str):
             continue
         package_name = Path(urllib.parse.urlparse(repo["repo"]).path).name
         package_specifier = SpecifierSet(f"=={package_rev.removeprefix('v')}")

From f10047ae35e24fff5329ef3cb7f065ed994602ba Mon Sep 17 00:00:00 2001
From: Alex Waygood <Alex.Waygood@Gmail.com>
Date: Sat, 2 Mar 2024 17:27:54 +0000
Subject: [PATCH 04/10] Update scripts/generate_proto_stubs.sh

Co-authored-by: Avasam <samuel.06@hotmail.com>
---
 scripts/generate_proto_stubs.sh | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/scripts/generate_proto_stubs.sh b/scripts/generate_proto_stubs.sh
index 055f93c1a1c2..3687f499efe2 100755
--- a/scripts/generate_proto_stubs.sh
+++ b/scripts/generate_proto_stubs.sh
@@ -45,10 +45,7 @@ PYTHON_PROTOBUF_DIR="protobuf-$PYTHON_PROTOBUF_VERSION"
 VENV=venv
 python3 -m venv "$VENV"
 source "$VENV/bin/activate"
-pip install pre-commit
-
-# Install mypy-protobuf
-pip install mypy-protobuf=="$MYPY_PROTOBUF_VERSION"
+pip install pre-commit mypy-protobuf=="$MYPY_PROTOBUF_VERSION"
 
 # Remove existing pyi
 find "$REPO_ROOT/stubs/protobuf/" -name '*_pb2.pyi' -delete

From 7c841808da59136b63e5703053c6b88ad0f5b427 Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 17:36:26 +0000
Subject: [PATCH 05/10] better comment

---
 pyproject.toml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 02e203610a08..9239e77a5c63 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -26,7 +26,11 @@ exclude = [
 [tool.ruff.lint]
 # Disable all rules on test cases by default:
 # test cases often deliberately contain code
-# that might not be considered idiomatic or modern
+# that might not be considered idiomatic or modern.
+#
+# Note: some rules that are specifically useful to the test cases
+# are invoked via separate runs of ruff in pre-commit:
+# see our .pre-commit-config.yaml file for details
 exclude = ["**/test_cases/**/*.py"]
 select = [
     "B", # flake8-bugbear

From b97df38beaed24212a27267a34a0accff3e9aff9 Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 17:40:34 +0000
Subject: [PATCH 06/10] Also run isort on the test cases

---
 .pre-commit-config.yaml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index bc02761232bc..5a2f7c22c956 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -21,10 +21,10 @@ repos:
         name: Remove unnecessary `sys.version_info` blocks
         args: ["--exit-non-zero-on-fix", "--select=UP036", "--unsafe-fixes"]
       - id: ruff
-        # This is the only rule
-        # that it's really useful to run on the test cases:
-        name: Check __future__ annotations in test cases
-        args: ["--exit-non-zero-on-fix", "--select=FA", "--no-force-exclude", "--unsafe-fixes"]
+        # Very few rules are useful to run on our test cases;
+        # we explicitly enumerate them here:
+        name: Run ruff on the test cases
+        args: ["--exit-non-zero-on-fix", "--select=FA,I", "--no-force-exclude", "--unsafe-fixes"]
         files: '.*test_cases/.+\.py$'
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.1.1 # must match requirements-tests.txt

From be503c534f1f6a3ed7915d9d70ea3578b43e6f1c Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sat, 2 Mar 2024 18:01:55 +0000
Subject: [PATCH 07/10] Update CONTRIBUTING and runtests.py

---
 CONTRIBUTING.md        | 35 +++++++++++++----------------------
 requirements-tests.txt |  1 +
 scripts/runtests.py    | 17 ++++-------------
 3 files changed, 18 insertions(+), 35 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1dd7fd6fdb84..93e0626f8069 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -87,34 +87,25 @@ terminal to install all non-pytype requirements:
 ## Code formatting
 
 The code is formatted using [`Black`](https://github.com/psf/black).
-Various other autofixes are
-also performed by [`Ruff`](https://github.com/astral-sh/ruff).
+Various other autofixes and lint rules are
+also performed by [`Ruff`](https://github.com/astral-sh/ruff) and
+[`Flake8`](https://github.com/pycqa/flake8),
+with plugins [`flake8-pyi`](https://github.com/pycqa/flake8-pyi),
+and [`flake8-noqa`](https://github.com/plinss/flake8-noqa).
 
 The repository is equipped with a [`pre-commit.ci`](https://pre-commit.ci/)
 configuration file. This means that you don't *need* to do anything yourself to
-run the code formatters. When you push a commit, a bot will run those for you
-right away and add a commit to your PR.
-
-That being said, if you *want* to run the checks locally when you commit,
-you're free to do so. Either run the following manually...
+run the code formatters or linters. When you push a commit, a bot will run
+those for you right away and add any autofixes to your PR. Anything
+that can't be autofixed will show up as a CI failure, hopefully with an error
+message that will make it clear what's gone wrong.
 
-```bash
-(.venv)$ ruff check .
-(.venv)$ black .
-```
-
-...Or install the pre-commit hooks: please refer to the
-[pre-commit](https://pre-commit.com/) documentation.
-
-Our code is also linted using [`Flake8`](https://github.com/pycqa/flake8),
-with plugins [`flake8-pyi`](https://github.com/pycqa/flake8-pyi),
-and [`flake8-noqa`](https://github.com/plinss/flake8-noqa).
-As with our other checks, running
-Flake8 before filing a PR is not required. However, if you wish to run Flake8
-locally, install the test dependencies as outlined above, and then run:
+That being said, if you *want* to run the formatters and linters locally
+when you commit, you're free to do so. To use the same configuration as we use
+in CI, we recommend doing this via pre-commit:
 
 ```bash
-(.venv)$ flake8 .
+(.venv)$ pre-commit run --all-files
 ```
 
 ## Where to make changes
diff --git a/requirements-tests.txt b/requirements-tests.txt
index 5bd9ba7da2f7..609e561b469a 100644
--- a/requirements-tests.txt
+++ b/requirements-tests.txt
@@ -14,6 +14,7 @@ ruff==0.3.0              # must match .pre-commit-config.yaml and tests.yml
 aiohttp==3.9.3
 packaging==23.2
 pathspec>=0.11.1
+pre-commit
 pyyaml==6.0.1
 stubdefaulter==0.1.0
 termcolor>=2.3
diff --git a/scripts/runtests.py b/scripts/runtests.py
index f8c1ce8f21d8..b68ceb64179a 100755
--- a/scripts/runtests.py
+++ b/scripts/runtests.py
@@ -81,17 +81,8 @@ def main() -> None:
     stubtest_result: subprocess.CompletedProcess[bytes] | None = None
     pytype_result: subprocess.CompletedProcess[bytes] | None = None
 
-    # Run formatters first. Order matters.
-    print("\nRunning Ruff...")
-    subprocess.run([sys.executable, "-m", "ruff", "check", path])
-    print("\nRunning Black...")
-    black_result = subprocess.run([sys.executable, "-m", "black", path])
-    if black_result.returncode == 123:
-        print("Could not run tests due to an internal error with Black. See above for details.", file=sys.stderr)
-        sys.exit(black_result.returncode)
-
-    print("\nRunning Flake8...")
-    flake8_result = subprocess.run([sys.executable, "-m", "flake8", path])
+    print("\nRunning pre-commit...")
+    pre_commit_result = subprocess.run(["pre-commit", "run", "--all-files"])
 
     print("\nRunning check_consistent.py...")
     check_consistent_result = subprocess.run([sys.executable, "tests/check_consistent.py"])
@@ -187,7 +178,7 @@ def main() -> None:
 
     any_failure = any(
         [
-            flake8_result.returncode,
+            pre_commit_result.returncode,
             check_consistent_result.returncode,
             check_new_syntax_result.returncode,
             pyright_returncode,
@@ -203,7 +194,7 @@ def main() -> None:
         print(colored("\n\n--- TEST SUMMARY: One or more tests failed. See above for details. ---\n", "red"))
     else:
         print(colored("\n\n--- TEST SUMMARY: All tests passed! ---\n", "green"))
-    print("Flake8:", _SUCCESS if flake8_result.returncode == 0 else _FAILED)
+    print("pre-commit:", _SUCCESS if pre_commit_result.returncode == 0 else _FAILED)
     print("Check consistent:", _SUCCESS if check_consistent_result.returncode == 0 else _FAILED)
     print("Check new syntax:", _SUCCESS if check_new_syntax_result.returncode == 0 else _FAILED)
     if pyright_skipped:

From 760867ed79c589786d1afafc3569bf08150bafe4 Mon Sep 17 00:00:00 2001
From: Alex Waygood <Alex.Waygood@Gmail.com>
Date: Sat, 2 Mar 2024 19:28:43 +0000
Subject: [PATCH 08/10] Update .pre-commit-config.yaml

Co-authored-by: Avasam <samuel.06@hotmail.com>
---
 .pre-commit-config.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 5a2f7c22c956..948e705731af 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -8,6 +8,7 @@ repos:
       - id: check-toml
       - id: check-merge-conflict
       - id: mixed-line-ending
+        args: [--fix=lf]
       - id: check-case-conflict
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.3.0 # must match requirements-tests.txt and tests.yml

From 6f079ee96c7aa7c39eaf8d56692203085605d5d9 Mon Sep 17 00:00:00 2001
From: Alex Waygood <alex.waygood@gmail.com>
Date: Sun, 3 Mar 2024 15:50:41 +0000
Subject: [PATCH 09/10] Give a verbose message if pre-commit fails as part of
 runtests.py

---
 scripts/runtests.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/scripts/runtests.py b/scripts/runtests.py
index b68ceb64179a..4e7755bc6b3d 100755
--- a/scripts/runtests.py
+++ b/scripts/runtests.py
@@ -194,7 +194,18 @@ def main() -> None:
         print(colored("\n\n--- TEST SUMMARY: One or more tests failed. See above for details. ---\n", "red"))
     else:
         print(colored("\n\n--- TEST SUMMARY: All tests passed! ---\n", "green"))
-    print("pre-commit:", _SUCCESS if pre_commit_result.returncode == 0 else _FAILED)
+    if pre_commit_result.returncode == 0:
+        print("pre-commit", _SUCCESS)
+    else:
+        print("pre-commit", _FAILED)
+        print(
+            """\
+  Check the output of pre-commit for more details.
+  This could mean that there's a lint failure on your code,
+  but could also just mean that one of the pre-commit tools
+  applied some autofixes. If the latter, you may want to check
+  that the autofixes did sensible things."""
+        )
     print("Check consistent:", _SUCCESS if check_consistent_result.returncode == 0 else _FAILED)
     print("Check new syntax:", _SUCCESS if check_new_syntax_result.returncode == 0 else _FAILED)
     if pyright_skipped:

From fdfad952eb11ff1849fa1b19331b2627d001b008 Mon Sep 17 00:00:00 2001
From: Alex Waygood <Alex.Waygood@Gmail.com>
Date: Sun, 3 Mar 2024 23:03:22 +0000
Subject: [PATCH 10/10] Apply suggestions from code review

---
 .pre-commit-config.yaml                   | 2 +-
 requirements-tests.txt                    | 2 +-
 scripts/generate_proto_stubs.sh           | 2 ++
 scripts/sync_tensorflow_protobuf_stubs.sh | 2 ++
 4 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 948e705731af..dc4bc138b4f1 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -11,7 +11,7 @@ repos:
         args: [--fix=lf]
       - id: check-case-conflict
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.0 # must match requirements-tests.txt and tests.yml
+    rev: v0.3.0 # must match requirements-tests.txt
     hooks:
       - id: ruff
         name: Run ruff on stubs, tests and scripts
diff --git a/requirements-tests.txt b/requirements-tests.txt
index 609e561b469a..cf3bbef95265 100644
--- a/requirements-tests.txt
+++ b/requirements-tests.txt
@@ -8,7 +8,7 @@ flake8-pyi==24.1.0       # must match .pre-commit-config.yaml
 mypy==1.8.0
 pre-commit-hooks==4.5.0  # must match .pre-commit-config.yaml
 pytype==2024.2.27; platform_system != "Windows" and python_version < "3.12"
-ruff==0.3.0              # must match .pre-commit-config.yaml and tests.yml
+ruff==0.3.0              # must match .pre-commit-config.yaml
 
 # Libraries used by our various scripts.
 aiohttp==3.9.3
diff --git a/scripts/generate_proto_stubs.sh b/scripts/generate_proto_stubs.sh
index 3687f499efe2..88c36bef7250 100755
--- a/scripts/generate_proto_stubs.sh
+++ b/scripts/generate_proto_stubs.sh
@@ -70,6 +70,8 @@ PROTO_FILES=$(grep "GenProto.*google" $PYTHON_PROTOBUF_DIR/python/setup.py | \
 # shellcheck disable=SC2086
 protoc_install/bin/protoc --proto_path="$PYTHON_PROTOBUF_DIR/src" --mypy_out="relax_strict_optional_primitives:$REPO_ROOT/stubs/protobuf" $PROTO_FILES
 
+# use `|| true` so the script still continues even if a pre-commit hook
+# applies autofixes (which will result in a nonzero exit code)
 pre-commit run --files "$REPO_ROOT/stubs/protobuf" || true
 
 sed --in-place="" \
diff --git a/scripts/sync_tensorflow_protobuf_stubs.sh b/scripts/sync_tensorflow_protobuf_stubs.sh
index 79a696e0b54f..29b603c810bd 100755
--- a/scripts/sync_tensorflow_protobuf_stubs.sh
+++ b/scripts/sync_tensorflow_protobuf_stubs.sh
@@ -61,6 +61,8 @@ rm tensorflow/compiler/xla/service/hlo_execution_profile_data_pb2.pyi \
    tensorflow/core/protobuf/worker_service_pb2.pyi \
    tensorflow/core/util/example_proto_fast_parsing_test_pb2.pyi
 
+# use `|| true` so the script still continues even if a pre-commit hook
+# applies autofixes (which will result in a nonzero exit code)
 pre-commit run --files "$REPO_ROOT/stubs/tensorflow/tensorflow" || true
 
 sed --in-place="" \