tox.ini

# This file is part of the django-environ.
#
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
# the LICENSE.txt file that was distributed with this source code.

# Tox (https://tox.readthedocs.io) - run tests in multiple virtualenvs.
# Also contains configuration settings for all tools executed by Tox.

[tox]
minversion = 3.22
envlist =
    build
    coverage-report
    linkcheck
    docs
    lint
    manifest
    py{39,310,311,312,313}-django{22,30,31,32,40,41,42}
    py{310,311,312,313}-django{50,51}
    pypy-django{22,30,31,32}

[gh-actions]
python =
    3.9: py39
    3.10: py310
    3.11: py311
    3.12: py312
    3.13: py313
    pypy-3.10: pypy

[testenv]
description = Unit tests
extras = testing
deps =
    django22: Django>=2.2,<3.0
    django30: Django>=3.0,<3.1
    django31: Django>=3.1,<3.2
    django32: Django>=3.2,<3.3
    django40: Django>=4.0,<4.1
    django41: Django>=4.1,<4.2
    django42: Django>=4.2,<5.0
commands_pre =
    python -m pip install --upgrade pip
    python -m pip install .
commands =
    coverage erase
    coverage run -m pytest {posargs}

[testenv:coverage-report]
description = Combine coverage reports
skip_install = true
deps = coverage[toml]>=5.4
commands =
    coverage combine
    coverage report
    coverage html
    coverage xml

[testenv:lint]
description = Static code analysis and code style check
skip_install = true
deps =
    flake8
    flake8-blind-except
    flake8-import-order
    pylint
commands_pre =
    python -m pip install --upgrade pip
    python -m pip install .
commands =
    flake8 environ setup.py
    pylint \
        --logging-format-style=old \
        --good-names-rgxs=m[0-9],f,v \
        --disable=too-few-public-methods \
        --disable=import-error \
        --disable=unused-import \
        --disable=too-many-locals \
        --disable=too-many-branches \
        --disable=too-many-public-methods \
        --disable=too-many-lines \
        environ

[testenv:linkcheck]
description = Check external links in the package documentation
# Keep basepython in sync with .readthedocs.yml and docs.yml
# (GitHub Action Workflow).
basepython = python3.12
extras = docs
commands =
    {envpython} -m sphinx \
      -j auto \
      -b linkcheck \
      {tty:--color} \
      -n -W -a \
      --keep-going \
      -d {envtmpdir}/doctrees \
      docs \
      docs/_build/linkcheck
isolated_build = true

[testenv:docs]
description = Build package documentation (HTML)
# Keep basepython in sync with .readthedocs.yml and docs.yml
# (GitHub Action Workflow).
basepython = python3.12
extras = docs
commands =
    {envpython} -m sphinx \
      -j auto \
      -b html \
      {tty:--color} \
      -n -T -W \
      -d {envtmpdir}/doctrees \
      docs \
      docs/_build/html

    {envpython} -m sphinx \
      -j auto \
      -b doctest \
      {tty:--color} \
      -n -T -W \
      -d {envtmpdir}/doctrees \
      docs \
      docs/_build/doctest

    {envpython} -m doctest \
      AUTHORS.rst \
      CHANGELOG.rst \
      CONTRIBUTING.rst \
      README.rst \
      SECURITY.rst

[testenv:manifest]
description = Check MANIFEST.in in a source package for completeness
deps = check-manifest
skip_install = true
commands = check-manifest -v

[testenv:build]
description = Build and test package distribution
skip_install = true
deps =
    twine
    check-wheel-contents
commands_pre =
    python -m pip install -U pip setuptools wheel
    python setup.py bdist_wheel -d {envtmpdir}/build
    python setup.py sdist -d {envtmpdir}/build
commands =
    twine check {envtmpdir}/build/*
    check-wheel-contents {envtmpdir}/build

[pytest]
testpaths = tests
addopts =
    --verbose
    --ignore=.tox

[coverage:run]
branch = True
parallel = True
# A list of file name patterns, the files to leave
# out of measurement or reporting.
omit =
    .tox/*
    tests/*
    */__pycache__/*

[coverage:report]
precision = 2
show_missing = True

[flake8]
# Base flake8 configuration:
statistics = True
show-source = True
# TODO: max-complexity = 10
# Plugins:
import-order-style = smarkets
# A list of mappings of files and the codes that should be ignored for
# the entirety of the file:
per-file-ignores =
    environ/__init__.py:F401,F403
    environ/compat.py:F401
# Excluding some directories:
extend-exclude =
    .tox
    build*
    dist
    htmlcov