Add teyit for better unittest assertions.

.github/workflows/pre-commit-update.yml

@@ -0,0 +1,29 @@
+name: Pre-Commit Update
+on:
+  schedule:
+    - cron: "0 12 * * 0" # run once a week on Sunday
+  # Allow to run this workflow manually from the Actions tab
+  workflow_dispatch:
+jobs:
+  pre-commit-update:
+    strategy:
+      matrix:
+        python-version:
+          - 3.11
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: Check for pre-commit dependency updates
+        # This fails, if there is a new version available,
+        # Update to the new version number in
+        # .pre-commit-config.yaml and config/default/pre-commit-config.yaml.j2.
+        run: |
+          pre-commit autoupdate
+          git diff --exit-code

.pre-commit-config.yaml

@@ -14,6 +14,10 @@ repos:
       rev: v2.0.4
       hooks:
           - id: autopep8
+    - repo: https://github.com/isidentical/teyit
+      rev: 0.4.3
+      hooks:
+      - id: teyit
     - repo: https://github.com/PyCQA/flake8
       rev: 6.1.0
       hooks:

config/README.rst

@@ -337,6 +337,9 @@ updated. Example:
         "*.mo",
         ]
 
+    [pre-commit]
+    teyit-exclude = "App/tests/fixtures/error\.py"
+
     [readthedocs]
     build-extra = [
         "apt_packages:",
@@ -623,6 +626,15 @@ ignore
   Additional lines to be added to the ``.gitignore`` file. This option has to
   be a list of strings and defaults to an empty list.
 
+pre-commit options
+``````````````````
+
+The corresponding section is named: ``[pre-commit]``.
+
+teyit-exclude
+  Regex for files to be hidden from teyit. It fails on files containing syntax
+  errors. This option has to be a string and is omitted when not defined.
+
 ReadTheDocs options
 ```````````````````
 

config/config-package.py

@@ -335,13 +335,14 @@ def gitignore(self):
         )
 
     def pre_commit_config_yaml(self):
-        # git_ignore = self.meta_cfg["git"].get("ignore", [])
+        teyit_exclude = self.meta_cfg["pre-commit"].get("teyit-exclude", "")
 
         self.copy_with_meta(
             "pre-commit-config.yaml.j2",
             self.path / ".pre-commit-config.yaml",
             self.config_type,
             oldest_python_version=OLDEST_PYTHON_VERSION.replace(".", ""),
+            teyit_exclude=teyit_exclude,
         )
 
     def readthedocs(self):

config/default/pre-commit-config.yaml.j2

@@ -14,6 +14,13 @@ repos:
     hooks:
     - id: pyupgrade
       args: [--py%(oldest_python_version)s-plus]
+  - repo: https://github.com/isidentical/teyit
+    rev: 0.4.3
+    hooks:
+    - id: teyit
+{% if teyit_exclude %}
+      exclude: %(teyit_exclude)s
+{% endif %}
   - repo: https://github.com/PyCQA/flake8
     rev: "7.1.1"
     hooks: