skip to navigation
skip to content

Not Logged In

pytest-runner 2.5.1

Invoke py.test as distutils command with dependency resolution.

Package Documentation

Setup scripts can use pytest-runner to add test support for pytest runner.


  • Add ‘pytest-runner’ to your ‘setup_requires’. Pin to ‘>=2.0,<3dev’ (or similar) to avoid pulling in incompatible versions.
  • Include ‘pytest’ and any other testing requirements to ‘tests_require’.
  • Invoke tests with pytest.
  • Pass --index-url to have test requirements downloaded from an alternate index URL.
  • Pass additional py.test command-line options using --addopts.
  • Set permanent options for the pytest distutils command in the [pytest] section of setup.cfg.
  • Set permanent options for the pytest run itself in the [pytest] section of pytest.ini or tox.ini. See pytest 567 for details on why setup.cfg is inadequate.
  • Optionally, set test=pytest in the [aliases] section of setup.cfg to cause test to invoke pytest.


The most simple usage looks like this in


Additional dependencies require to run the tests (e.g. mock or pytest plugins) may be added to tests_require and will be downloaded and required by the session before invoking pytest.

See the jaraco.collections project for real-world usage.

Standalone Example

Although pytest-runner is typically used to add pytest test runner support to maintained packages, pytest-runner may also be used to create standalone tests. Consider this example failure, reported in jsonpickle #117.

That single file may be cloned or downloaded and simply run on any system with Python and Setuptools. It will download the specified dependencies and run the tests. Afterward, the the cloned directory can be removed and with it all trace of invoking the test. No other dependencies are needed and no system configuration is altered.

Then, anyone trying to replicate the failure can do so easily and with all the power of pytest (rewritten assertions, rich comparisons, interactive debugging, extensibility through plugins, etc).

As a result, the communication barrier for describing and replicating failures is made almost trivially low.


Conditional Requirement

Because it uses Setuptools setup_requires, pytest-runner will install itself on every invocation of In some cases, this causes delays for invocations of that will never invoke pytest-runner. To help avoid this contingency, consider requiring pytest-runner only when pytest is invoked:

needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
pytest_runner = ['pytest-runner'] if needs_pytest else []

# ...

        #... (other setup requirements)
    ] + pytest_runner,
File Type Py Version Uploaded on Size (md5) Source 2015-03-04 11KB
  • Downloads (All Versions):
  • 343 downloads in the last day
  • 2420 downloads in the last week
  • 7548 downloads in the last month