Merge pull request #1123 from VWS-Python/more-precommit-hooks

Add more pre-commit hooks

.checkmake-config.ini

@@ -0,0 +1,2 @@
+[minphony]
+disabled = true

.pre-commit-config.yaml

@@ -23,6 +23,22 @@ repos:
       - id: file-contents-sorter
         files: spelling_private_dict\.txt$
       - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+      - id: text-unicode-replacement-char
+      - id: rst-backticks
+  - repo: https://github.com/mrtazz/checkmake.git
+    rev: 0.2.2
+    hooks:
+      - id: checkmake
+        args: ["--config", ".checkmake-config.ini"]
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.13.0
+    hooks:
+      - id: yamlfmt
   - repo: local
     hooks:
       - id: actionlint
@@ -33,6 +49,13 @@ repos:
         types_or: [yaml]
         additional_dependencies: ["uv"]
 
+      - id: docformatter
+        name: docformatter
+        entry: uv run --extra=dev -m docformatter --in-place
+        language: python
+        types_or: [python]
+        additional_dependencies: ["uv"]
+
       - id: shellcheck
         name: shellcheck
         entry: uv run --extra=dev shellcheck --shell=bash --exclude=SC1017
@@ -260,6 +283,7 @@ ci:
     - ruff-check-fix-docs
     - ruff-format-fix
     - ruff-format-fix-docs
+    - docformatter
     - shellcheck
     - shellcheck-docs
     - shfmt

.yamlfmt

@@ -0,0 +1,5 @@
+formatter:
+    include_document_start: true
+    retain_line_breaks_single: true
+    trim_trailing_whitespace: true
+    end_of_file_newline: true

codecov.yaml

@@ -1,3 +1,4 @@
+---
 coverage:
   status:
     patch:

conftest.py

@@ -1,4 +1,6 @@
-"""Setup for test suite."""
+"""
+Setup for test suite.
+"""
 
 import uuid
 from collections.abc import Generator
@@ -20,8 +22,7 @@
 def fixture_mock_vws(
     monkeypatch: pytest.MonkeyPatch,
 ) -> Generator[None]:
-    """
-    Yield a mock VWS.
+    """Yield a mock VWS.
 
     The keys used here match the keys in the documentation.
     """

docs/source/__init__.py

@@ -1 +1,3 @@
-"""Documentation."""
+"""
+Documentation.
+"""

docs/source/conf.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
-"""Configuration for Sphinx."""
+"""
+Configuration for Sphinx.
+"""
 
 import importlib.metadata
 

pyproject.toml

@@ -40,6 +40,7 @@ optional-dependencies.dev = [
     "deptry==0.20.0",
     "doc8==1.1.2",
     "doccmd==2024.10.8.12",
+    "docformatter==1.7.5",
     "freezegun==1.5.1",
     "furo==2024.8.6",
     "interrogate==1.7.0",
@@ -240,6 +241,9 @@ spelling-private-dict-file = 'spelling_private_dict.txt'
 # --spelling-private-dict-file option instead of raising a message.
 spelling-store-unknown-words = 'no'
 
+[tool.docformatter]
+make-summary-multi-line = true
+
 [tool.check-manifest]
 
 ignore = [

readthedocs.yaml

@@ -1,3 +1,4 @@
+---
 version: 2
 
 build:
@@ -7,10 +8,10 @@ build:
 
 python:
   install:
-     - method: pip
-       path: .
-       extra_requirements:
-           - dev
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
 
 sphinx:
   builder: html

src/vws_auth_tools/__init__.py

@@ -1,4 +1,6 @@
-"""Authorization helpers."""
+"""
+Authorization helpers.
+"""
 
 import base64
 import email.utils
@@ -10,7 +12,9 @@
 
 @beartype
 def _compute_hmac_base64(key: bytes, data: bytes) -> bytes:
-    """Return the Base64 encoded HMAC-SHA1 hash of `data` using the `key`."""
+    """
+    Return the Base64 encoded HMAC-SHA1 hash of `data` using the `key`.
+    """
     hashed = hmac.new(key=key, msg=None, digestmod=hashlib.sha1)
     hashed.update(msg=data)
     return base64.b64encode(s=hashed.digest())

tests/__init__.py

@@ -1 +1,3 @@
-"""Tests for authorization tools."""
+"""
+Tests for authorization tools.
+"""

tests/test_vws_auth_tools.py

@@ -1,4 +1,6 @@
-"""Tests for authorization tools."""
+"""
+Tests for authorization tools.
+"""
 
 import datetime
 from zoneinfo import ZoneInfo
@@ -42,8 +44,8 @@ def test_rfc_1123_date() -> None:
 def test_authorization_header(content: bytes | str) -> None:
     """The Authorization header is constructed as documented.
 
-    This example has been run on known-working code and so any refactor should
-    continue to pass this test.
+    This example has been run on known-working code and so any refactor
+    should continue to pass this test.
     """
     access_key = "my_access_key"
     # Ignore "Possible hardcoded password" as it is appropriate here.