Add pre-commit (#146)

StanFromIreland · web-flow · commit 42c0a4d0b942 · 2025-06-09T18:01:42.000+01:00
This commit includes fixing all existing infractions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -8,7 +8,7 @@ updates:
       - "rffontenelle"
     commit-message:
       prefix: "gha"
-      
+
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ on:
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-  
+
 env:
   TX_CLI_VERSION: '1.6.16'
   TX_PROJECT: python-newest  # Project name for the latest python version
@@ -67,13 +67,13 @@ jobs:
         echo "all_versions=$(scripts/manage_versions.py all)" >> $GITHUB_OUTPUT
         echo "current=$(scripts/manage_versions.py current)" >> $GITHUB_OUTPUT
         echo "version_pairs=$(scripts/manage_versions.py generate_pairs)" >> $GITHUB_OUTPUT
-    
+
     - name: Check out branch ${{ steps.version.outputs.current }}
       uses: actions/checkout@v4.2.2
       with:
-        ref: ${{ steps.version.outputs.current }}      
+        ref: ${{ steps.version.outputs.current }}
         path: ${{ steps.version.outputs.current }}
-    
+
     - name: Set languages variable
       id: languages
       working-directory: ${{ steps.version.outputs.current }}
@@ -158,7 +158,7 @@ jobs:
         run: |
           deleted_files=$(git status -s | grep ^' D' | cut -d' ' -f3)
           if [ -n "$deleted_files" ]; then git rm -v $deleted_files; else echo "no POT files to remove"; fi
-        
+
       - name: Remove problematic source messages from POT files
         run: |
           scripts/remove-msgid.sh cpython/Doc/locales/pot
@@ -237,19 +237,19 @@ jobs:
     steps:
       - name: Check out main
         uses: actions/checkout@v4.2.2
-        
+
       - name: Check out branch ${{ matrix.branch.new }}
         uses: actions/checkout@v4.2.2
         with:
           ref: ${{ matrix.branch.new }}
           path: ${{ matrix.branch.new }}
-    
+
       - name: Check out branch ${{ matrix.branch.prev }}
         uses: actions/checkout@v4.2.2
         with:
           ref: ${{ matrix.branch.prev }}
           path: ${{ matrix.branch.prev }}
-      
+
       - name: Set up Python 3
         uses: actions/setup-python@v5.6.0
         with:
@@ -262,7 +262,7 @@ jobs:
         working-directory: /usr/local/bin
         run: |
           curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash -s -- v${{ env.TX_CLI_VERSION }}
-    
+
       - name: Install dependencies
         run: |
           python3 -m pip install --upgrade pip
@@ -285,4 +285,3 @@ jobs:
           tx push -t -l ${{ matrix.language }}
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
-        
diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml
@@ -14,7 +14,7 @@ concurrency:
 
 permissions:
   pull-requests: write
-  
+
 jobs:
   documentation-links:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/updpyver.yml b/.github/workflows/updpyver.yml
@@ -48,7 +48,7 @@ jobs:
         run: |
           scripts/manage_versions.py update_versions_file
 
-      - name: Commit changes to a new branch 
+      - name: Commit changes to a new branch
         if: ${{ success() && !contains(fromJSON('["push", "pull_request"]'), github.event_name) }}
         uses: devops-infra/action-commit-push@v0.10.0
         with:
@@ -58,7 +58,7 @@ jobs:
           force: false
           target_branch: update/version
 
-      - name: Create pull request 
+      - name: Create pull request
         if: ${{ success() && !contains(fromJSON('["push", "pull_request"]'), github.event_name) }}
         uses: devops-infra/action-pull-request@v0.6.0
         with:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: forbid-submodules
+      - id: trailing-whitespace
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.32.1
+    hooks:
+      - id: check-github-workflows
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -19,4 +19,4 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: docs/requirements.txt
diff --git a/README.rst b/README.rst
@@ -13,4 +13,3 @@ For information about translating on transifex for both users and maintainers se
 .. _python-doc: https://app.transifex.com/python-doc/
 .. _Transifex: https://www.transifex.com
 .. _translation: https://devguide.python.org/documentation/translating/
-
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,30 +6,30 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'Python Docs Transifex Automations'
-copyright = '2025, rffontenelle'
-author = 'rffontenelle'
+project = "Python Docs Transifex Automations"
+copyright = "2025, rffontenelle"
+author = "rffontenelle"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = []
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
-html_static_path = ['_static']
-html_title = 'Python Docs Transifex Automations'
+html_theme = "furo"
+html_static_path = ["_static"]
+html_title = "Python Docs Transifex Automations"
 
 # ----------------------------------------------------------------------------
 
 # Python versions
-newest = '3.13'
-previous = '3.12'
+newest = "3.13"
+previous = "3.12"
 
 rst_prolog = f"""
 .. |py_new| replace:: {newest}
diff --git a/docs/index.rst b/docs/index.rst
@@ -41,4 +41,3 @@ See also  Translating_ in the Python Developer's Guide for more information.
    bumping-relsease.rst
    commands.rst
    placeholders.rst
-
diff --git a/docs/placeholders.rst b/docs/placeholders.rst
@@ -16,7 +16,7 @@ Some notes:
       of place holders, and will be rendered as normal text.
     - The roles :dfn: and :term: were not included because their content are normally translatable, so making them
       placeholders would pop up too many false-positive warnings.
-    - \``$\`` is being wrongly replaced with the placeholder ```{TX-PL-LABEL}#x60;``` by Transifex because of the 
+    - \``$\`` is being wrongly replaced with the placeholder ```{TX-PL-LABEL}#x60;``` by Transifex because of the
       custom placeholder that starts and ends with \``. Removing this custom placeholder ceases the issue, but it
       disables custom placeholders for all literal expressions.
 
@@ -76,7 +76,7 @@ Note that the commands sort by alphabetic order ``sort -u``, but it could be sor
 1. To list two-part roles (e.g. ``:c:func:` ``)::
 
 .. code-block:: shell
-   
+
    grep -Po '(^|\s+):([\w\-\_\~!]*:){2}`' strings.txt | sed -E 's|^ +||;' | tr '[:upper:]' '[:lower:]' | sort -u
 
 2. To list one-part roles (e.g. ``:class:` ``):
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
 sphinx>=8.0.0
-furo
+furo
diff --git a/sample-workflows/po-lint.yml b/sample-workflows/po-lint.yml
@@ -25,4 +25,4 @@ jobs:
         with:
           ref: ${{ matrix.version }}
       - uses: rffontenelle/sphinx-lint-problem-matcher@v1.0.0
-      - run: sphinx-lint
+      - run: sphinx-lint
diff --git a/sample-workflows/test-build.yml b/sample-workflows/test-build.yml
@@ -57,4 +57,4 @@ jobs:
       - uses: actions/upload-artifact@master
         with:
           name: build-${{ matrix.version }}-pdf
-          path: .
+          path: .
diff --git a/sample-workflows/transifex-util.py b/sample-workflows/transifex-util.py
@@ -2,7 +2,7 @@
 #
 # This python file contains utility functions to manage a Python docs translation
 # with Transifex.
-# 
+#
 # This file is maintained at: https://github.com/python-docs-translations/transifex-automations/blob/main/sample-workflows/transifex-util.py
 
 import configparser
@@ -14,9 +14,6 @@
 import sys
 from tempfile import TemporaryDirectory
 
-from polib import pofile
-from transifex.api import transifex_api
-
 
 def fetch():
     """
@@ -26,14 +23,16 @@ def fetch():
         sys.stderr.write("The Transifex client app is required.\n")
         exit(code)
     lang = LANGUAGE
-    _call(f'tx pull -l {lang} --force') # XXX Do we pull everything?
-    for file in Path().rglob('*.po'):
-        _call(f'msgcat --no-location -o {file} {file}')
+    _call(f"tx pull -l {lang} --force")  # XXX Do we pull everything?
+    for file in Path().rglob("*.po"):
+        _call(f"msgcat --no-location -o {file} {file}")
+
 
 def _call(command: str):
     if (return_code := call(command, shell=True)) != 0:
         exit(return_code)
 
+
 def recreate_tx_config():
     """
     Regenerate Transifex client config for all resources.
@@ -42,15 +41,16 @@ def recreate_tx_config():
         with chdir(directory):
             _clone_cpython_repo(VERSION)
             _build_gettext()
-            with chdir(Path(directory) / 'cpython/Doc/build'):
+            with chdir(Path(directory) / "cpython/Doc/build"):
                 _create_txconfig()
                 _update_txconfig_resources()
-                with open('.tx/config', 'r') as file:
+                with open(".tx/config", "r") as file:
                     contents = file.read()
-        contents = contents.replace('./<lang>/LC_MESSAGES/', '')
-        with open('.tx/config', 'w') as file:
+        contents = contents.replace("./<lang>/LC_MESSAGES/", "")
+        with open(".tx/config", "w") as file:
             file.write(contents)
 
+
 def delete_obsolete_files():
     files_to_delete = list(_get_files_to_delete())
     if not files_to_delete:
@@ -61,31 +61,39 @@ def delete_obsolete_files():
             os.remove(file)
             _call(f'git rm --quiet "{file}"')
 
+
 def _get_files_to_delete():
-    with open('.tx/config') as config_file:
+    with open(".tx/config") as config_file:
         config = config_file.read()
-    for file in Path().rglob('*.po'):
+    for file in Path().rglob("*.po"):
         if os.fsdecode(file) not in config:
             yield os.fsdecode(file)
 
+
 def _clone_cpython_repo(version: str):
-    _call(f'git clone -b {version} --single-branch https://github.com/python/cpython.git --depth 1')
+    _call(
+        f"git clone -b {version} --single-branch https://github.com/python/cpython.git --depth 1"
+    )
+
 
 def _build_gettext():
     _call("make -C cpython/Doc/ gettext")
 
+
 def _create_txconfig():
-    _call('sphinx-intl create-txconfig')
+    _call("sphinx-intl create-txconfig")
+
 
 def _update_txconfig_resources():
     _call(
-        f'sphinx-intl update-txconfig-resources --transifex-organization-name python-doc '
-        f'--transifex-project-name {PROJECT_SLUG} --locale-dir . --pot-dir gettext'
+        f"sphinx-intl update-txconfig-resources --transifex-organization-name python-doc "
+        f"--transifex-project-name {PROJECT_SLUG} --locale-dir . --pot-dir gettext"
     )
 
+
 def _get_tx_token() -> str:
-    if os.path.exists('.tx/api-key'):
-        with open('.tx/api-key') as f:
+    if os.path.exists(".tx/api-key"):
+        with open(".tx/api-key") as f:
             return f.read()
 
     config = configparser.ConfigParser()
@@ -95,16 +103,17 @@ def _get_tx_token() -> str:
     except KeyError:
         pass
 
-    return os.getenv('TX_TOKEN', '')
+    return os.getenv("TX_TOKEN", "")
+
 
 if __name__ == "__main__":
-    RUNNABLE_SCRIPTS = ('fetch', 'recreate_tx_config', 'delete_obsolete_files')
+    RUNNABLE_SCRIPTS = ("fetch", "recreate_tx_config", "delete_obsolete_files")
 
     parser = ArgumentParser()
-    parser.add_argument('cmd', choices=RUNNABLE_SCRIPTS)
-    parser.add_argument('--language', required=True)
-    parser.add_argument('--project-slug', required=True)
-    parser.add_argument('--version', required=True)
+    parser.add_argument("cmd", choices=RUNNABLE_SCRIPTS)
+    parser.add_argument("--language", required=True)
+    parser.add_argument("--project-slug", required=True)
+    parser.add_argument("--version", required=True)
 
     options = parser.parse_args()
 
diff --git a/scripts/getlangs.py b/scripts/getlangs.py
diff --git a/scripts/lock-translations.py b/scripts/lock-translations.py
diff --git a/scripts/manage_versions.py b/scripts/manage_versions.py
diff --git a/scripts/remove_untranslated.sh b/scripts/remove_untranslated.sh
