tox.ini

[tox]
# N.B.: We handle installing Pex in the envs that need it with a custom testenv install_command
# below.
skipsdist = true

skip_missing_interpreters = true
minversion = 3.25.1
requires =
    # Ensure tox and virtualenv compatible back through Python 2.7.
    tox<4
    virtualenv<20.16

[testenv]
# N.B.: We need modern setuptools downloaded out of band by virtualenv to work with Python>=3.12.
# Trying to upgrade via Pip is too late and Pip blows up.
download = true

# N.B.: We configure tox to disable its build sdist, then install sdist in venv scheme for all envs
# with `skip_install = false` (the default). As such, we use a custom `install_command` for all
# envs that need Pex installed. The install command is tox's default, with the one addition of
# `{toxinidir}`, which adds `-e .` to the requirement list handed to Pip to install.
install_command =
    # N.B.: The latest Pip supported by Python 2.7 and 3.5 can't install pyproject.toml projects in
    # editable mode.
    # TODO(John Sirois): Consider moving back to the setuptools.build_meta backend and using a
    # minimal setup.py since hatchling is buying us less and less and getting in the way more and
    # more.
    py{py27,py35,27,35}: python -m pip install {opts} {toxinidir} {packages}

    docs,check,typecheck,py{py36,py37,py38,py39,py310,36,37,38,39,310,311,312,313}: \
        python -m pip install {opts} -e {toxinidir} {packages}


commands =
    !integration: python testing/bin/run_tests.py {posargs:-vvs}
    integration: python testing/bin/run_tests.py --it {posargs:-vvs}
deps =
    integration: pytest-xdist==1.34.0
    ansicolors==1.1.8
    coloredlogs==15.0.1
    # The more-itertools project is an indirect requirement of pytest and its broken for
    # Python < 3.6 in newer releases so we force low here.
    more-itertools<=8.10.0; python_version < "3.6"
    pexpect==4.9.0
    pytest==4.6.11; python_version < "3.6"
    pytest==6.2.5; python_version == "3.6"
    pytest==7.4.0; python_version >= "3.7"
    py{27,py27}: mock==3.0.5
    subprocess: subprocess32
passenv =
    # This allows working around broken xcode Python SDKs.
    ARCHFLAGS
    # This allows re-locating the various test caches for CI.
    _PEX_TEST_DEV_ROOT
    # This allows increasing pexpect read timeouts in CI.
    _PEX_PEXPECT_TIMEOUT
    # This allows experimenting with Requires-Python metadata adjustment.
    _PEX_REQUIRES_PYTHON
    # These are to support directing test environments to the correct headers on OSX.
    CPATH
    CPPFLAGS
    LDFLAGS
    PEX_VERBOSE
    # Mac (Homebrew) needs these.
    HOME
    # Windows needs these.
    PATHEXT
    USER
    USERNAME
    # Needed for tests of git+ssh://...
    SSH_AUTH_SOCK
    # Needed for pexpect tests.
    TERM
    # Needed to prevent hitting rate limits on GitHub Releases APIs in `--scie` integration tests.
    SCIENCE_AUTH_API_GITHUB_COM_BEARER
setenv =
    pip20: _PEX_PIP_VERSION=20.3.4-patched
    pip22_2: _PEX_PIP_VERSION=22.2.2
    pip22_3: _PEX_PIP_VERSION=22.3
    pip22_3_1: _PEX_PIP_VERSION=22.3.1
    pip23_0: _PEX_PIP_VERSION=23.0
    pip23_0_1: _PEX_PIP_VERSION=23.0.1
    pip23_1: _PEX_PIP_VERSION=23.1
    pip23_1_1: _PEX_PIP_VERSION=23.1.1
    pip23_1_2: _PEX_PIP_VERSION=23.1.2
    pip23_2: _PEX_PIP_VERSION=23.2
    pip23_3_1: _PEX_PIP_VERSION=23.3.1
    pip23_3_2: _PEX_PIP_VERSION=23.3.2
    pip24_0: _PEX_PIP_VERSION=24.0
    pip24_1: _PEX_PIP_VERSION=24.1
    pip24_1_1: _PEX_PIP_VERSION=24.1.1
    pip24_1_2: _PEX_PIP_VERSION=24.1.2
    pip24_2: _PEX_PIP_VERSION=24.2

    # Python 3 (until a fix here in 3.9: https://bugs.python.org/issue13601) switched from stderr
    # being unbuffered to stderr being buffered by default. This can lead to tests checking stderr
    # failing to see what they expect if the stderr buffer block has not been flushed. Force stderr
    # line buffering (which is what setting PYTHONUNBUFFERED nets you) so that tests can rely on
    # stderr lines being observable.
    py{py35,py36,py37,py38,py39,35,36,37,38}: PYTHONUNBUFFERED=1
allowlist_externals =
    bash
    git

[testenv:{format-run,fmt}]
skip_install = true
deps =
    black==21.12b0
    # The 8.1.0 release of click breaks black; so we pin.
    click==8.0.1
    isort==5.10.1
commands =
    python scripts/format.py

[testenv:format-check]
skip_install = true
deps =
    {[testenv:format-run]deps}
commands =
    python scripts/format.py --check

[testenv:lint]
skip_install = true
deps =
    # The last version to support pyflakes 2.4.0 (see below).
    autoflake==1.7.8
    # The last version to support Python 2.7 comment type hints.
    pyflakes==2.4.0
commands =
    python scripts/lint.py

[testenv:lint-check]
skip_install = true
deps =
    {[testenv:lint]deps}
commands =
    python scripts/lint.py --check

[testenv:{typecheck,check}]
deps =
    # We keep this compatible with Python 2.7 for the 2.7 type check.
    pytest==4.6.11

    # These versions should track the version in pex/vendor/__init__.py.
    ansicolors==1.1.8
    appdirs==1.4.4
    attrs @ git+https://github.com/python-attrs/attrs@947bfb542104209a587280701d8cb389c813459d

    httpx==0.23.0

    # We pin at 0.971 since this is the last version of mypy that supports `--python-version 2.7`.
    mypy[python2]==0.971
    packaging==20.9  # This version should track the lowest version in pex/vendor/__init__.py.
    pip==20.3.4  # This version should track the version in pex/vendor/__init__.py.
    setuptools==44.0.0  # This version should track the version in pex/vendor/__init__.py.
    sphinx
    toml==0.10.2  # This version should track the version in pex/vendor/__init__.py.

    # The following stubs are pinned at the last version that does not use positional-only parameter
    # syntax (/) not available to `--python-version 2.7` type checks.
    types-PyYAML==6.0.12.12
    types-appdirs==1.4.3.5
    types-docutils==0.20.0.20240310
    types-mock==5.1.0.20240106
    types-pexpect==4.9.0.20240207
    types-setuptools==69.1.0.20240302

    # 0.10.6 stubs are not compatible with Python 2.7
    types-toml==0.10.5

    typing-extensions
commands =
    python scripts/typecheck.py

[testenv:vendor]
# The vendored dist may contain references to the python version it was built on
# (e.g., pex/vendor/_vendored/pip/pip-20.0.dev0.dist-info/entry_points.txt).
# So this test restricts the python version, to prevent spurious diffs that will cause it to fail.
basepython = python3.8
skip_install = true
deps =
    ansicolors==1.1.8
    pip==24.0
    redbaron==0.9.2
    setuptools==50.3.2
    wheel==0.35.1
    {[testenv:format-run]deps}
commands =
    python -m pex.vendor {posargs}
    {[testenv:format-run]commands}

[testenv:vendor-check]
basepython = {[testenv:vendor]basepython}
skip_install = true
deps =
    tox
    httpx==0.23.0
commands =
    tox -e vendor -- --no-update
    python scripts/embed_virtualenv.py
    git diff --exit-code

[testenv:docs]
basepython = python3
deps =
    -r docs-requirements.txt
commands =
    python scripts/build_docs.py {posargs}

[_package]
basepython = python3
deps =
    build
    # The `pyproject-hooks` project is an indirect dep via `build` and the 1.1.0 release breaks us
    # through either improved or broken isolation + backend-path integration; so we pin low.
    # See: https://github.com/pypa/pyproject-hooks/pull/165
    pyproject-hooks<1.1.0

[testenv:package]
skip_install = true
basepython = {[_package]basepython}
deps =
    {[_package]deps}
commands =
    python scripts/package.py {posargs}

[testenv:serve]
skip_install = true
basepython = {[_package]basepython}
deps =
    {[_package]deps}
commands =
    python scripts/package.py --additional-format wheel --local --serve {posargs}

[testenv:pip]
description = Run Pex's vendored pip.
skip_install = true
setenv   =
    PYTHONPATH = {env:PYTHONPATH:}{:}{toxinidir}/pex/vendor/_vendored/pip
    SETUPTOOLS_USE_DISTUTILS = stdlib
commands =
    python -s -mpip {posargs}

[testenv:setuptools]
description = Run Python with Pex's vendored setuptools on the sys.path.
skip_install = true
setenv   =
    __PEX_UNVENDORED__ = setuptools
    PYTHONPATH = {env:PYTHONPATH:}{:}{toxinidir}/pex/vendor/_vendored/setuptools
    SETUPTOOLS_USE_DISTUTILS = stdlib
commands =
    python {posargs}

[testenv:devpi-lock]
description = Re-create the devpi-server lock.
skip_install = true
commands =
    python -mpex.cli lock create \
        --style universal \
        --pip-version latest \
        --resolver-version pip-2020-resolver \
        --interpreter-constraint >=3.8,<3.13 \
        devpi-server \
        --indent 2 \
        -o testing/devpi-server.lock

[testenv:build-cache-image]
description = Build the CI cache data image.
skip_install = true
basepython = python3
deps =
    coloredlogs==15.0.1
    PyYAML==6.0.1
commands =
    python scripts/build_cache_image.py {posargs}