Add pre-commit

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      - id: fix-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+        exclude: '^zuul.d/.*$'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
+    hooks:
+      - id: ruff-check
+        args: ['--fix', '--unsafe-fixes']
+      - id: ruff-format

scripts/all-pythons

@@ -6,64 +6,61 @@ Prints output as a subunit test suite. If anything goes to stderr, that is
 treated as a test error. If a Python is not available, then it is skipped.
 """
 
-from datetime import datetime
 import io
 import os
 import subprocess
 import sys
+from datetime import datetime
 
 import subunit
 from subunit import (
-    iso8601,
-    _make_stream_binary,
     TestProtocolClient,
     TestProtocolServer,
-    )
+    _make_stream_binary,
+    iso8601,
+)
+
 from testtools import (
     PlaceHolder,
-    TestCase,
-    )
+)
 from testtools.content import text_content
 
-
 ROOT = os.path.dirname(os.path.dirname(__file__))
 
 
 def run_for_python(version, result, tests):
     if not tests:
-        tests = ['tests.test_suite']
+        tests = ["tests.test_suite"]
     # XXX: This could probably be broken up and put into subunit.
-    python = 'python%s' % (version,)
+    python = f"python{version}"
     # XXX: Correct API, but subunit doesn't support it. :(
     # result.tags(set(python), set())
     result.time(now())
-    test = PlaceHolder(''.join(c for c in python if c != '.'))
+    test = PlaceHolder("".join(c for c in python if c != "."))
     process = subprocess.Popen(
-        '%s -c pass' % (python,), shell=True,
-        stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        f"{python} -c pass", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+    )
     process.communicate()
 
     if process.returncode:
         result.startTest(test)
-        result.addSkip(test, reason='%s not available' % (python,))
+        result.addSkip(test, reason=f"{python} not available")
         result.stopTest(test)
         return
 
     env = os.environ.copy()
-    if env.get('PYTHONPATH', None):
-        env['PYTHONPATH'] = os.pathsep.join([ROOT, env['PYTHONPATH']])
+    if env.get("PYTHONPATH", None):
+        env["PYTHONPATH"] = os.pathsep.join([ROOT, env["PYTHONPATH"]])
     else:
-        env['PYTHONPATH'] = ROOT
+        env["PYTHONPATH"] = ROOT
     result.time(now())
     protocol = TestProtocolServer(result)
-    subunit_path = os.path.join(os.path.dirname(subunit.__file__), 'run.py')
-    cmd = [
-        python,
-        '-W', 'ignore:Module testtools was already imported',
-        subunit_path]
+    subunit_path = os.path.join(os.path.dirname(subunit.__file__), "run.py")
+    cmd = [python, "-W", "ignore:Module testtools was already imported", subunit_path]
     cmd.extend(tests)
     process = subprocess.Popen(
-        cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
+        cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env
+    )
     _make_stream_binary(process.stdout)
     _make_stream_binary(process.stderr)
     # XXX: This buffers everything. Bad for memory, bad for getting progress
@@ -72,22 +69,24 @@ def run_for_python(version, result, tests):
     protocol.readFrom(io.BytesIO(output))
     if error:
         result.startTest(test)
-        result.addError(test, details={
-            'stderr': text_content(error),
-           })
+        result.addError(
+            test,
+            details={
+                "stderr": text_content(error),
+            },
+        )
         result.stopTest(test)
     result.time(now())
     # XXX: Correct API, but subunit doesn't support it. :(
-    #result.tags(set(), set(python))
+    # result.tags(set(), set(python))
 
 
 def now():
     return datetime.now(tz=iso8601.Utc())
 
 
-
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.path.append(ROOT)
     result = TestProtocolClient(sys.stdout)
-    for version in '3.10 3.11 3.12 3.13 3.14'.split():
+    for version in "3.10 3.11 3.12 3.13 3.14".split():
         run_for_python(version, result, sys.argv[1:])

scripts/update-rtfd

@@ -2,9 +2,8 @@
 
 from urllib2 import urlopen
 
+WEB_HOOK = "http://readthedocs.org/build/588"
 
-WEB_HOOK = 'http://readthedocs.org/build/588'
 
-
-if __name__ == '__main__':
-    urlopen(WEB_HOOK, data='  ')
+if __name__ == "__main__":
+    urlopen(WEB_HOOK, data="  ")

testtools/run.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python3
+
 # Copyright (c) 2009 testtools developers. See LICENSE for details.
 
 """python -m testtools.run testspec [testspec...]

tox.ini

@@ -12,10 +12,9 @@ commands =
 
 [testenv:ruff]
 deps =
-  ruff
+  pre-commit
 commands =
-  ruff check --fix .
-  ruff format .
+  pre-commit run -a
 
 [testenv:mypy]
 deps =