Improve pre-commit config (#9563)

AlexWaygood · web-flow · commit a4e3cfefacbf · 2023-01-18T06:29:18.000-08:00
- Add a few more hooks. These are all very fast, and I've found them useful in other projects: - Autofixes: - `trailing-whitespace`: fixes trailing whitespace - `requirements-txt-fixer`: alphabetises items in `requirements.txt` files - `end-of-file-fixer`: makes sure every file ends with a single newline character - `mixed-line-ending`: Makes sure Windows users don't accidentally introduce CRLF line endings into a file that uses LF line endings - None-autofixes: - `check-yaml`: loads YAML files to validate syntax - `check-toml`: loads TOML files to validate syntax - `check-merge-conflict`: detects merge-conflict strings in files and blocks them from accidentally being committed - `check-case-conflict`: checks for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT; blocks them from being committed. - Change the bot schedule to quarterly, to reduce noisy PRs - Change the `black` language target-version to Python 3.10, synching the setting here with the changes that were made to our `pyproject.toml` file in #7538
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,4 +1,15 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0 # must match requirements-tests.txt
+    hooks:
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+      - id: check-case-conflict
   - repo: https://github.com/hadialqattan/pycln
     rev: v2.1.3 # must match requirements-tests.txt
     hooks:
@@ -8,7 +19,7 @@ repos:
     rev: 22.12.0 # must match requirements-tests.txt
     hooks:
       - id: black
-        language_version: python3.9
+        language_version: python3.10
   - repo: https://github.com/pycqa/isort
     rev: 5.11.4 # must match requirements-tests.txt
     hooks:
@@ -33,6 +44,6 @@ 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: weekly
+  autoupdate_schedule: quarterly
   skip: [flake8]
   submodules: false
diff --git a/LICENSE b/LICENSE
@@ -235,4 +235,3 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
 = = = = =
-
diff --git a/requirements-tests.txt b/requirements-tests.txt
@@ -8,9 +8,10 @@ isort==5.11.4                                     # must match .pre-commit-confi
 mypy==0.991
 packaging==23.0
 pathspec>=0.10.3
+pre-commit-hooks==4.4.0                           # must match .pre-commit-config.yaml
 pycln==2.1.3                                      # must match .pre-commit-config.yaml
-pyyaml==6.0
 pytype==2023.1.17; platform_system != "Windows" and python_version < "3.11"
+pyyaml==6.0
 termcolor>=2
 tomli==2.0.1
 tomlkit==0.11.6
diff --git a/stubs/aiofiles/@tests/stubtest_allowlist.txt b/stubs/aiofiles/@tests/stubtest_allowlist.txt
@@ -63,4 +63,3 @@ aiofiles.tempfile.AiofilesContextManagerTempDir
 
 # Helper decorator, too complex to type
 aiofiles.os.wrap
-
diff --git a/stubs/croniter/@tests/stubtest_allowlist.txt b/stubs/croniter/@tests/stubtest_allowlist.txt
@@ -2,4 +2,4 @@
 croniter.croniter.EXPANDERS
 croniter.croniter.HashExpander
 croniter.croniter.VALID_LEN_EXPRESSION
-croniter.croniter.timedelta_to_seconds
+croniter.croniter.timedelta_to_seconds
diff --git a/stubs/editdistance/METADATA.toml b/stubs/editdistance/METADATA.toml
@@ -2,4 +2,3 @@ version = "0.6.*"
 
 [tool.stubtest]
 ignore_missing_stub = false
-
diff --git a/stubs/humanfriendly/@tests/requirements-stubtest.txt b/stubs/humanfriendly/@tests/requirements-stubtest.txt
@@ -1,2 +1,2 @@
 docutils
-mock
+mock
diff --git a/stubs/oauthlib/@tests/stubtest_allowlist.txt b/stubs/oauthlib/@tests/stubtest_allowlist.txt
@@ -1 +1 @@
-oauthlib.oauth1.rfc5849.parameters.prepare_headers
+oauthlib.oauth1.rfc5849.parameters.prepare_headers
diff --git a/stubs/openpyxl/@tests/stubtest_allowlist.txt b/stubs/openpyxl/@tests/stubtest_allowlist.txt
@@ -1,2 +1,2 @@
 # "cls" argument has wrong name in implementation.
-openpyxl.descriptors.slots.AutoSlotProperties.__new__ 
+openpyxl.descriptors.slots.AutoSlotProperties.__new__
diff --git a/stubs/psycopg2/METADATA.toml b/stubs/psycopg2/METADATA.toml
@@ -1 +1 @@
-version = "2.9.*"
+version = "2.9.*"
diff --git a/stubs/tensorflow/@tests/stubtest_allowlist.txt b/stubs/tensorflow/@tests/stubtest_allowlist.txt
@@ -1,4 +1,4 @@
-# Some methods are dynamically patched onto to instances as they 
+# Some methods are dynamically patched onto to instances as they
 # may depend on whether code is executed in graph/eager/v1/v2/etc.
 # Tensorflow supports multiple modes of execution which changes some
 # of the attributes/methods/even class hierachies.
@@ -17,6 +17,6 @@ tensorflow.Operation.__getattr__
 tensorflow.Variable.__getattr__
 # Internal undocumented API
 tensorflow.RaggedTensor.__init__
-# Has an undocumented extra argument that tf.Variable which acts like subclass 
+# Has an undocumented extra argument that tf.Variable which acts like subclass
 # (by dynamically patching tf.Tensor methods) does not preserve.
-tensorflow.Tensor.__getitem__
+tensorflow.Tensor.__getitem__
diff --git a/stubs/tqdm/@tests/requirements-stubtest.txt b/stubs/tqdm/@tests/requirements-stubtest.txt
@@ -1,4 +1,4 @@
-tensorflow
-pandas
 dask
+pandas
 rich
+tensorflow
diff --git a/tests/check_consistent.py b/tests/check_consistent.py
@@ -8,6 +8,7 @@
 import os
 import re
 import sys
+import urllib.parse
 from pathlib import Path
 
 import tomli
@@ -220,8 +221,9 @@ def get_precommit_requirements() -> dict[str, SpecifierSet]:
         if not repo.get("python_requirement", True):
             continue
         hook = repo["hooks"][0]
-        package_name, package_rev = hook["id"], repo["rev"]
-        package_specifier = SpecifierSet(f"=={package_rev.removeprefix('v')}")
+        package_name = Path(urllib.parse.urlparse(repo["repo"]).path).name
+        package_rev = repo["rev"].removeprefix("v")
+        package_specifier = SpecifierSet(f"=={package_rev}")
         precommit_requirements[package_name] = package_specifier
         for additional_req in hook.get("additional_dependencies", []):
             req = Requirement(additional_req)
diff --git a/tests/stubtest_allowlists/darwin-py311.txt b/tests/stubtest_allowlists/darwin-py311.txt
@@ -10,4 +10,4 @@ socket.TCP_CONNECTION_INFO
 (locale.dcgettext)
 (locale.dgettext)?
 (locale.gettext)?
-(locale.textdomain)?
+(locale.textdomain)?

Original file line number	Diff line number	Diff line change
`@@ -235,4 +235,3 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER`
`235`	`235`	`DEALINGS IN THE SOFTWARE.`
`236`	`236`
`237`	`237`	`= = = = =`
`238`		`-`
Original file line number	Diff line number	Diff line change
`@@ -63,4 +63,3 @@ aiofiles.tempfile.AiofilesContextManagerTempDir`
`63`	`63`
`64`	`64`	`# Helper decorator, too complex to type`
`65`	`65`	`aiofiles.os.wrap`
`66`		`-`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,3 @@ version = "0.6.*"`
`2`	`2`
`3`	`3`	`[tool.stubtest]`
`4`	`4`	`ignore_missing_stub = false`
`5`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-oauthlib.oauth1.rfc5849.parameters.prepare_headers`
	`1`	`+oauthlib.oauth1.rfc5849.parameters.prepare_headers`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# "cls" argument has wrong name in implementation.`
`2`		`-openpyxl.descriptors.slots.AutoSlotProperties.__new__`
	`2`	`+openpyxl.descriptors.slots.AutoSlotProperties.__new__`