.pre-commit-config.yaml

default_language_version:
  python: python3.12

minimum_pre_commit_version: 3.5.0

default_install_hook_types: [commit-msg,
                             post-checkout,
                             post-commit,
                             post-merge,
                             post-rewrite,
                             pre-commit,
                             pre-merge-commit,
                             pre-push,
                             pre-rebase,
                             prepare-commit-msg
                             ]

files: ''
exclude: |
  (?x)^(
    venv/.*|
    .git/.*|
    book/_build/.*
  )$
fail_fast: true # false #

default_stages: [pre-commit, pre-merge-commit, pre-push]


repos:

- repo: local
  hooks:

#======================================================================================================================
# Git hooks
#======================================================================================================================
  - id: forbid-new-submodules
    name: "Prevent addition of new git submodules (forbid-new-submodules)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: forbid-new-submodules
    types: [file]
    require_serial: true

  - id: check-merge-conflict
    name: "Check for files that contain merge conflict strings (check-merge-conflict)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-merge-conflict
    types: [file]
    require_serial: true

  - id: check-added-large-files
    name: "Prevent giant files from being committed (check-added-large-files)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-added-large-files
    args: [--maxkb=10240,
           --enforce-all,
    ]
    types: [file]
    require_serial: true

  - id: check-case-conflict
    name: "Check for files with names that would conflict on a case-insensitive filesystem (check-case-conflict)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-case-conflict
    types: [file]
    require_serial: true


#======================================================================================================================
# Common files hooks
#======================================================================================================================
  - id: trailing-whitespace
    name: "Trims trailing whitespace (trailing-whitespace)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: trailing-whitespace-fixer
    types: [text]
    require_serial: true

  - id: mixed-line-ending
    name: "Replaces or checks mixed line ending (mixed-line-ending)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: mixed-line-ending
    args: [--fix=lf]
    types: [text]
    require_serial: true

  - id: end-of-file-fixer
    name: "Makes sure files end in a newline and only a newline (end-of-file-fixer)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: end-of-file-fixer
    types_or: [markdown, pyi, python, toml]
    require_serial: true

  - id: fix-byte-order-marker
    name: "Removes UTF-8 byte order marker (fix-byte-order-marker)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: fix-byte-order-marker
    types: [text]
    require_serial: true

# False positives raised by check-executables-have-shebangs
# https://github.com/pre-commit/pre-commit-hooks/issues/528
#  - id: check-executables-have-shebangs
#    name: "Checks that non-binary executables have a proper shebang (check-executables-have-shebangs)"
#    description: "https://github.com/pre-commit/pre-commit-hooks"
#    language: system
#    entry: check-executables-have-shebangs
#    types_or: [bash, python]
#    require_serial: true

  - id: check-symlinks
    name: "Checks for symlinks which do not point to anything (check-symlinks)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-symlinks
    types_or: [text]
    require_serial: true

  - id: check-vcs-permalinks
    name: "Ensures that links to vcs websites are permalinks (check-vcs-permalinks)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-vcs-permalinks
    types_or: [text]
    require_serial: true

  - id: destroyed-symlinks
    name: "Detects symlinks which are changed to regular files with a content of a path (destroyed-symlinks)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: destroyed-symlinks
    types_or: [text]
    require_serial: true

  - id: detect-private-key
    name: "Checks for the existence of private keys (detect-private-key)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: detect-private-key
    types_or: [text]
    require_serial: true


#======================================================================================================================
# Type files hooks
#======================================================================================================================
  - id: check-ast
    name: "Simply check whether files parse as valid python (check-ast)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-ast
    types_or: [pyi, python]
    require_serial: true

  - id: pretty-format-json
    name: "Checks that all your JSON files are pretty (pretty-format-json)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: pretty-format-json
    args: [--autofix,
           --indent=4,
           --no-ensure-ascii,
           --no-sort-keys,
    ]
    types_or: [json, jupyter]
    require_serial: true

  - id: check-json
    name: "Attempts to load all json files to verify syntax (check-json)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-json
    types_or: [json, jupyter]
    require_serial: true

  - id: check-toml
    name: "Attempts to load all TOML files to verify syntax (check-toml)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-toml
    types: [toml]
    require_serial: true

  - id: check-xml
    name: "Attempts to load all xml files to verify syntax (check-xml)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-xml
    types_or: [html, xml, xhtml]
    require_serial: true

  - id: check-yaml
    name: "Attempts to load all yaml files to verify syntax (check-yaml)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-yaml
    args: [--allow-multiple-documents]
    types: [yaml]
    require_serial: true

  - id: requirements-txt-fixer
    name: "Sorts entries in requirements.txt and constraints.txt (requirements-txt-fixer)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: requirements-txt-fixer
    files: .*(requirements).*(.txt)$
    require_serial: true
    verbose: true


#======================================================================================================================
# Python hooks
#======================================================================================================================
  - id: fix-encoding-pragma
    name: "Remove # -*- coding: utf-8 -*- to the top of python files (fix-encoding-pragma)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: fix-encoding-pragma
    args: [--remove]
    types_or: [pyi, python]
    require_serial: true

  - id: check-docstring-first
    name: "Checks for a common error of placing code before the docstring (check-docstring-first)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: check-docstring-first
    types_or: [pyi, python]
    require_serial: true

  - id: debug-statements
    name: "Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: debug-statement-hook
    types_or: [pyi, python]
    require_serial: true

  - id: pyupgrade
    name: "Automatically upgrade syntax for newer versions (pyupgrade)"
    description: "https://github.com/asottile/pyupgrade"
    language: system
    entry: python -m pyupgrade
    args: [--py312-plus]
    types_or: [pyi, python]
    require_serial: true

  - id: pyupgrade-nbqa
    name: "Automatically upgrade syntax for newer versions (pyupgrade + nbqa)"
    description: "https://github.com/asottile/pyupgrade
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa pyupgrade
    args: [--py312-plus]
    types_or: [jupyter, markdown]
    require_serial: true

#  - id: check-builtin-literals
#    name: "Require literal syntax when initializing empty or zero Python builtin types (check-builtin-literals)"
#    description: "https://github.com/pre-commit/pre-commit-hooks"
#    language: system
#    entry: check-builtin-literals
#    types_or: [jupyter, markdown, pyi, python ]
#    require_serial: true

  - id: isort
    name: "Import sorting (isort)"
    description: "https://github.com/pycqa/isort"
    language: system
    entry: python -m isort
    args: [--settings-file=pyproject.toml,
           --float-to-top,
    ]
    types_or: [pyi, python]
    require_serial: true

  - id: isort-nbqa
    name: "Import sorting (isort + nbqa)"
    description: "https://github.com/pycqa/isort
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa isort
    args: [--settings-file=pyproject.toml]
    types_or: [jupyter, markdown]
    require_serial: true

  - id: black
    name: "Python code formatter (black)"
    description: "https://github.com/psf/black"
    language: system
    entry: python -m black
    args: [--config=pyproject.toml]
    types_or: [pyi, python]
    require_serial: true

  - id: black-nbqa
    name: "Python code formatter (black + nbqa)"
    description: "https://github.com/psf/black
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa black
    args: [--config=pyproject.toml]
    types_or: [jupyter, markdown]
    require_serial: true

  - id: mypy
    name: "Static type checking (mypy)"
    description: "https://github.com/python/mypy"
    language: system
    entry: python -m mypy
    args: [--config-file=pyproject.toml]
    types_or: [pyi, python]
    require_serial: true

  - id: mypy-nbqa
    name: "Static type checking (mypy + nbqa)"
    description: "https://github.com/python/mypy
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa mypy
    args: [--config-file=pyproject.toml]
    types_or: [jupyter, markdown]
    require_serial: true

  - id: bandit
    name: "Security code analysis (bandit)"
    description: "https://github.com/PyCQA/bandit"
    language: system
    entry: python -m bandit
    args: [--configfile=pyproject.toml]
    types_or: [pyi, python]
    require_serial: true

  - id: bandit-nbqa
    name: "Security code analysis (bandit + nbqa)"
    description: "https://github.com/PyCQA/bandit
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa bandit
    args: [--configfile=pyproject.toml]
    types_or: [jupyter, markdown]
    require_serial: true

  - id: pylint
    name: "Static code analysis (pylint)"
    description: "https://github.com/pylint-dev/pylint"
    language: system
    entry: python -m pylint
    args: [--rcfile=pyproject.toml]
    types_or: [pyi, python]
    require_serial: true

  - id: pylint-nbqa
    name: "Static code analysis (pylint + nbqa)"
    description: "https://github.com/pylint-dev/pylint
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa pylint
    args: [--rcfile=pyproject.toml,
           --disable=C0103, # Skip the hyphen in the file name (invalid-name)
           --disable=C0111, # Missing module docstring (missing-module-docstring)
           --disable=C0413, # Import should be placed at the top of the module (wrong-import-position)
    ]
    types_or: [jupyter, markdown]
    require_serial: true

  - id: doctest
    name: "Test interactive Python examples (doctest)"
    description: "https://docs.python.org/3/library/doctest.html"
    language: system
    entry: python -m doctest
    #args: [--verbose]
    types: [python]
    require_serial: true

  - id: doctest-nbqa
    name: "Test interactive Python examples (doctest + nbqa)"
    description: "https://docs.python.org/3/library/doctest.html
                  https://github.com/nbQA-dev/nbQA"
    language: system
    entry: python -m nbqa doctest
    #args: [--verbose]
    types_or: [jupyter, markdown, tex]
    require_serial: true

  - id: name-tests-test
    name: "Verifies that test files are named correctly (name-tests-test)"
    description: "https://github.com/pre-commit/pre-commit-hooks"
    language: system
    entry: name-tests-test
    args: [--pytest]
    files: ^tests/
    types: [python]
    require_serial: true

  - id: pytest
    name: "Testing the code (pytest)"
    description: "https://github.com/pytest-dev/pytest/"
    language: system
    entry: python -m pytest
    args: [--tb=line,
           --cache-clear,
           --ignore=./tests/__init__.py,
           --doctest-modules,
           --verbose,
    ]
    files:  ^(tests\/).*(_test.py)$
    types: [python]
    require_serial: true
    always_run: true
    verbose: true