pyproject.toml

[build-system]
requires = ['uv_build>=0.11.0,<1']
build-backend = 'uv_build'

[project]
name = 'mt-940'
version = "5.1.3"
description = 'A library to parse MT940 files and returns smart Python collections for statistics and manipulation.'
readme = 'README.md'
license = 'BSD-3-Clause'
license-files = ['LICENSE']
requires-python = '>=3.10'
authors = [{ name = 'Rick van Hattem', email = 'wolph@wol.ph' }]
keywords = ['MT940']
classifiers = [
    'Development Status :: 6 - Mature',
    'Intended Audience :: Developers',
    'Operating System :: OS Independent',
    'Natural Language :: English',
    'Programming Language :: Python',
    'Programming Language :: Python :: 3',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Programming Language :: Python :: 3.13',
    'Programming Language :: Python :: 3.14',
    'Programming Language :: Python :: 3.15',
    'Topic :: Software Development :: Libraries :: Python Modules',
    'Typing :: Typed',
]
dependencies = []

[project.urls]
Homepage = 'https://github.com/WoLpH/mt940'
Documentation = 'https://mt940.readthedocs.io/'
Repository = 'https://github.com/WoLpH/mt940'
Issues = 'https://github.com/WoLpH/mt940/issues'
Changelog = 'https://github.com/WoLpH/mt940/releases'
Funding = 'https://github.com/sponsors/wolph'

[project.optional-dependencies]
docs = ['sphinx>=8.0', 'furo>=2024.8', 'types-docutils']
tests = [
    'pytest>=8.0',
    'pytest-cov>=5.0',
    'pytest-randomly>=3.15',
    'coverage>=7.0',
    'pyyaml',
    'types-pyyaml',
]
tox = ['tox>=4.0', 'tox-uv>=1.0', 'tox-gh-actions>=3.0']

[dependency-groups]
dev = [
    'mt-940[docs,tests,tox]',
    'ruff>=0.16',
    'mypy>=1.18',
    'basedpyright>=1.31',
    'pyright>=1.1.400',
    'pyrefly>=1.1',
    'ty>=0.0.70',
    'codespell>=2.4',
    'taplo>=0.9',
    'zizmor>=1.0',
    'pip-audit>=2.7',
    'sp-repo-review[cli]>=2025.1',
    'validate-pyproject>=0.24',
    'lefthook>=2.0',
]

[tool.uv]
exclude-newer = '14 days'
# certifi and filelock get a shorter soak of one week: their October 2026
# advisories (PYSEC-2026-4320 for certifi, CVE-2026-112906 and five siblings for
# filelock) were fixed inside the fourteen-day quarantine, and the audit job
# resolves fresh on every run, so the release workflow stayed red on tools that
# never reach the wheel. Drop the entries once the fixes are two weeks old.
exclude-newer-package = { certifi = '7 days', filelock = '7 days' }

[tool.uv.build-backend]
# The distribution name (mt-940) normalizes to `mt_940`, but the import
# package is `mt940`, so the module name has to be set explicitly.
module-root = ''
module-name = 'mt940'
# The source archive contains the materials needed to run and document the
# project. Wheels still contain only the runtime package and its metadata.
source-include = [
    'CONTRIBUTING.rst',
    'docs/**',
    'examples/**',
    'mt940_tests/**',
    'tox.ini',
    'ruff.toml',
    'pyrightconfig.strict.json',
    'taplo.toml',
    'lefthook.yml',
]
source-exclude = [
    'docs/html/**',
    'docs/_build/**',
    'docs/doctrees/**',
    'docs/superpowers/**',
    'docs/modules.rst',
    'docs/mt940*.rst',
]

# ── Tests ────────────────────────────────────────────────────

[tool.pytest.ini_options]
minversion = '8.0'
required_plugins = ['pytest-cov', 'pytest-randomly']
testpaths = ['mt940', 'mt940_tests']
python_files = ['mt940/*.py', 'mt940_tests/*.py']
log_level = 'INFO'
xfail_strict = true
empty_parameter_set_mark = 'fail_at_collect'
addopts = [
    '--strict-config',
    '--strict-markers',
    '-ra',
    '--cov=mt940',
    '--cov=mt940_tests',
    '--cov-report=term-missing',
    '--cov-report=html',
    '--no-cov-on-fail',
    '--doctest-modules',
]
doctest_optionflags = 'NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS'
filterwarnings = ['error']
norecursedirs = ['_build', 'docs', 'build', 'dist', '.tox', '.eggs']

[tool.coverage.run]
branch = true
source = ['mt940', 'mt940_tests']

[tool.coverage.paths]
# Map the package as installed into each tox env back to the source tree so
# per-env `.coverage.*` files combine into a single report.
source = [
    'mt940',
    '*/site-packages/mt940',
    '*/.tox/*/lib/*/site-packages/mt940',
]
tests = ['mt940_tests', '*/mt940_tests']

[tool.coverage.report]
fail_under = 100
show_missing = true
# Only code that cannot run is excluded: type-checking-only blocks, overload
# stubs and Protocol method bodies. Everything else needs a test.
exclude_also = [
    'if (typing\.|)TYPE_CHECKING',
    '@(typing\.|)overload',
    'class .*\bProtocol\):',
    '^\s*\.\.\.$',
]

# ── Type checking ────────────────────────────────────────────

[tool.mypy]
python_version = '3.10'
# docs/conf.py imports sphinx, which uses `type` statements that mypy cannot
# parse at a 3.10 target. tox and the hooks check it separately with
# `mypy --python-version 3.12 docs/conf.py`, the version the docs build on.
files = ['mt940', 'mt940_tests', 'examples', 'docs/_tools']
exclude = ['^dist/', '^build/', '^docs/_build/', '^\.tox/', '^\.?venv/']
strict = true
strict_bytes = true
extra_checks = true
warn_return_any = true
warn_unreachable = true
warn_unused_configs = true
warn_unused_ignores = true
disallow_any_unimported = true
disallow_any_decorated = true
# disallow_any_explicit stays off: parsed tag dictionaries are `dict[str, Any]`
# on purpose (see mt940._types.TagDict), the keys are bank-specific.
enable_error_code = [
    'exhaustive-match',
    'ignore-without-code',
    'possibly-undefined',
    'redundant-expr',
    'truthy-bool',
    'truthy-iterable',
    'unused-awaitable',
]

# Plain pyright (the release gate) reads pyrightconfig.strict.json instead.
# basedpyright refuses a pyproject with both a pyright and a basedpyright
# section, and a discoverable pyrightconfig.json would override this one.
[tool.basedpyright]
typeCheckingMode = 'all'
pythonVersion = '3.10'
include = ['mt940', 'mt940_tests', 'examples', 'docs/_tools', 'docs/conf.py']
exclude = ['**/__pycache__', '.tox', '.venv', 'build', 'dist', 'docs/_build']
# Parsed tag dictionaries are `dict[str, Any]` by design (mt940._types.TagDict).
reportAny = false
reportExplicitAny = false
# `@override` needs typing_extensions at runtime on Python < 3.12 and the
# package has zero runtime dependencies.
reportImplicitOverride = false
# mt940/parser.py imports the package root (`import mt940`) by design.
reportImportCycles = false
# Every processor shares one positional signature, so most of them leave at
# least one argument untouched. Ruff's ARG rules cover the rest of the code.
# A file-level `# pyright:` comment cannot carry this rule, plain pyright
# rejects the basedpyright-only name as unknown.
reportUnusedParameter = false

[tool.pyrefly]
# Explicit includes also work inside a repository-locally ignored worktree.
use-ignore-files = false
# Use the exclusions below, without adding environment-derived paths.
disable-project-excludes-heuristics = true
project-includes = [
    'mt940',
    'mt940_tests',
    'examples',
    'docs/_tools',
    'docs/conf.py',
]
project-excludes = ['**/__pycache__', '.tox', '.venv', 'build', 'dist']
python-version = '3.10'
untyped-def-behavior = 'check-and-infer-return-any'

[tool.ty.environment]
python-version = '3.10'

[tool.ty.src]
include = ['mt940', 'mt940_tests', 'examples', 'docs/_tools', 'docs/conf.py']

[tool.ty.terminal]
error-on-warning = true

# ── Repository checks ────────────────────────────────────────

[tool.codespell]
# Hidden files are checked so .github/ is covered, which means every local
# hidden directory (git objects, tool caches, editor state) must be skipped
# explicitly. The fixture formats carry bank data, not prose.
skip = '''
    ./.git,./.venv,./.tox,./.mypy_cache,./.ruff_cache,./.pytest_cache,
    ./.idea,./.worktrees,./.superpowers,./.remember,./.zshhistory,./.coverage,
    ./build,./dist,*/htmlcov,./docs/_build,./docs/html,./docs/superpowers,
    *.asc,*.yml,*.sta,*.txt,*.html,*.lock'''
check-hidden = true

[tool.repo-review]
ignore = [
    'SEC001', # zizmor runs as a tox env (pedantic persona) in CI, not via pre-commit
    'PY005',  # tests live in mt940_tests/ (established convention)
    'PY006',  # pre-commit replaced by lefthook
    'PC110',  # no pre-commit (we use lefthook)
    'PC111',  # executable examples and the README snippet are checked by pytest
    'PC140',  # manual typecheck hooks
    'PC170',  # strict Sphinx and local link checks cover the documentation
    'RTD',    # no RTD repo-review checks
]