.pre-commit-config.yaml

default_install_hook_types:
  - pre-commit
  - pre-merge-commit
  - commit-msg
default_stages:
  - pre-commit
  - pre-merge-commit
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
      # Reject commits that add large files (coverage.xml, for example)
      # Consider adjusting kB limit
      - id: check-added-large-files
        args:
          - --enforce-all
          - --maxkb=5000
      # Check valid Python syntax
      - id: check-ast
      # Require literal syntax when initializing empty or zero python builtin types
      - id: check-builtin-literals
      # Check for files that would conflict in case-insensitive filesystems
      - id: check-case-conflict
      # Check for a common error of defining a docstring after code
      - id: check-docstring-first
      # Check for files that contain merge conflict strings
      - id: check-merge-conflict
      # Check TOML files for parsable syntax
      - id: check-toml
      # Check YAML files for parsable syntax
      - id: check-yaml
      # Files must end in a single newline
      - id: end-of-file-fixer
      # Remove whitespace at the end of lines
      - id: trailing-whitespace
      # Prevent commit directly to main
      - id: no-commit-to-branch
        args: [-b, main]
      # Sort spell check custom dictionary
      - id: file-contents-sorter
        files: ^\.cspell/.+\.txt$
        args:
          - --ignore-case
          - --unique
        fail_fast: true
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.10.0
    hooks:
      # Prevent common mistakes of `assert mck.not_called()`,
      # `assert mck.called_once_with(...)` and `mck.assert_called`
      - id: python-check-mock-methods
      # Check for the deprecated `.warn()` method of Python loggers
      - id: python-no-log-warn
      # Enforce that type annotations are used instead of type comments
      - id: python-use-type-annotations
  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.5.5
    hooks:
      # No tabs, only spaces
      - id: forbid-tabs
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.11.2
    hooks:
      # Run the formatter.
      - id: ruff-format
        types_or: [ python, jupyter ]
        fail_fast: true
      # Run the linter.
      - id: ruff
        types_or: [ python, jupyter ]
        args: [--fix]
        # Abort if ruff linter fails as there is some duplication of functionality with
        # the slow pylint hook
        fail_fast: true
  - repo: https://github.com/regebro/pyroma
    rev: "4.2"
    hooks:
      # Ensure that necessary package information is provided
      - id: pyroma
  - repo: https://github.com/streetsidesoftware/cspell-cli
    rev: v8.17.3
    hooks:
      # Run a spellcheck (words pulled from cspell.config.yaml)
        - id: cspell
          stages:
            - pre-commit
            - pre-merge-commit
            - commit-msg
          exclude: |
            (?x)^(
              .gitignore|
              .*.properties|
              requirements.txt|
              requirements-docs.txt|
              .pylintrc|
              LICENSE.md
            )$
  - repo: https://github.com/kynan/nbstripout
    rev: 0.8.1
    hooks:
      - id: nbstripout
        args:
          - --drop-empty-cells
          - "--extra-keys=metadata.kernelspec cell.metadata.vscode metadata.language_info.version"
          - --keep-id
  - repo: local
    hooks:
      # Check files are valid UTF-8
      - id: require-utf8
        name: Check file encoding
        description: Ensure file is valid UTF-8
        entry: python pre_commit_hooks/require_utf8.py
        language: python
        exclude:
          (?x)^(
            docs/source/_static/.+.png
          )$
      # Keep requirements-docs.txt in sync with uv.lock
      - id: check-requirements-docs
        name: Keep requirements-docs.txt in sync with uv.lock
        language: system
        entry: >
          uv export
          --frozen
          --quiet
          --format requirements-txt
          --no-hashes
          --no-dev
          --no-editable
          --extra doc
          --output-file requirements-docs.txt
        pass_filenames: false
        files: ^uv\.lock$
      - id: check-copyright
        name: Check for copyright notice
        description: Ensure a copyright notice is present at the top of each Python file
        entry: python pre_commit_hooks/check_copyright.py
        types: [ python ]
        language: python
        # require_utf8 is excluded as it's licensed under the Apache license, so has a different header
        exclude: |
          (?x)^(
            pre_commit_hooks/require_utf8.py
          )$
      - id: markdown-cells
        name: forbid markdown cells
        description: Forbid any Markdown cell in a Jupyter notebook
        types: [jupyter]
        entry: python pre_commit_hooks/markdown_cells.py
        language: python
        additional_dependencies: ["nbformat"]
      - id: pylint
        name: pylint
        description: Run Pylint static analysis
        entry: pylint
        language: system
        types:
          - python
        args:
          - "-rn" # Only display messages
          - "-sn" # Don't display the score
          - "--rcfile=.pylintrc" # pylint configuration file
        exclude: "documentation/source/snippets"