pytest-runner

Warnings

• breaking The `pytest-runner` project is officially deprecated and its GitHub repository was archived in December 2023. The `setup.py test` command it enables is also being deprecated and slated for removal by `setuptools` itself. You should migrate away from `pytest-runner` for all projects.
  Fix: Remove `pytest-runner` from `setup_requires` and `pytest` from `tests_require` in your `setup.py`. Instead, invoke `pytest` directly (e.g., `python -m pytest` or `pytest`) or use a dedicated test orchestration tool like `tox`. Configure `pytest` using `pyproject.toml`, `pytest.ini`, or `setup.cfg`'s `[tool:pytest]` section.
• gotcha `pytest-runner` (and the `setup_requires`/`tests_require` mechanism it relies upon) can bypass security mechanisms in `pip`, specifically `pip --require-hashes`. This can lead to insecure dependency resolution.
  Fix: Follow the deprecation migration path by removing `pytest-runner` and invoking `pytest` directly. Manage test dependencies explicitly in `pyproject.toml` or `requirements.txt` for better security and reproducibility.
• gotcha For new projects, or migrating existing ones, `pytest-runner` is unnecessary. `pytest` should be installed as a regular development dependency, typically specified in `pyproject.toml` (`[project.optional-dependencies]`) or `requirements-dev.txt`, and invoked directly from the command line (e.g., `pytest` or `python -m pytest`).
  Fix: Ensure `pytest` is listed as a development dependency. Remove `pytest-runner` and any `setup_requires` or `tests_require` sections related to testing from `setup.py`. Configure `pytest` using `pyproject.toml`, `pytest.ini`, or `setup.cfg`.

Install

• pip install pytest-runner Install pytest-runner

Quickstart

This is the *deprecated* quickstart method for `pytest-runner`. It demonstrates how to configure your `setup.py` to use `pytest-runner` to enable the `python setup.py pytest` (or `test`) command. Modern projects are advised to run `pytest` directly or via tools like `tox`.

# In setup.py (NOTE: This usage pattern is deprecated!)
from setuptools import setup, find_packages

setup(
    name='my-package',
    version='0.1.0',
    packages=find_packages(),
    setup_requires=[
        'pytest-runner',
    ],
    tests_require=[
        'pytest',
    ],
)

# To run tests (from your project root):
# python setup.py pytest
# OR python setup.py test (if 'test=pytest' alias is set in setup.cfg)