Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A twisted plugin for py.test.

Project description

PyPI version Supported Python versions Travis build status AppVeyor build status Black code style

Authors:Ralf Schmitt, Kyle Altendorf, Victor Titor

pytest-twisted is a plugin for pytest, which allows to test code, which uses the twisted framework. test functions can return Deferred objects and pytest will wait for their completion with this plugin.

Python 2 support plans

At some point it may become impractical to retain Python 2 support. Given the small size and very low amount of development it seems likely that this will not be a near term issue. While I personally have no need for Python 2 support I try to err on the side of being helpful so support will not be explicitly removed just to not have to think about it. If major issues are reported and neither myself nor the community have time to resolve them then options will be considered.


Install the plugin as below.

pip install pytest-twisted

Using the plugin

The plugin is available after installation and can be disabled using -p no:twisted.

By default twisted.internet.default is used to install the reactor. This creates the same reactor that import twisted.internet.reactor would. Alternative reactors can be specified using the --reactor option. This presently supports qt5reactor for use with pyqt5 and pytest-qt as well as asyncio. This guide describes how to add support for a new reactor.

The reactor is automatically created prior to the first test but can be explicitly installed earlier by calling pytest_twisted.init_default_reactor() or the corresponding function for the desired alternate reactor.

Beware that in situations such as a file that the name pytest_twisted may be undesirably detected by pytest as an unknown hook. One alternative is to import pytest_twisted as pt.


Using twisted.internet.defer.inlineCallbacks as a decorator for test functions, which use fixtures, does not work. Please use pytest_twisted.inlineCallbacks instead.

def test_some_stuff(tmpdir):
    res = yield threads.deferToThread(os.listdir, tmpdir.strpath)
    assert res == []


Using twisted.internet.defer.ensureDeferred as a decorator for test functions, which use fixtures, does not work. Please use pytest_twisted.ensureDeferred instead.

async def test_some_stuff(tmpdir):
    res = await threads.deferToThread(os.listdir, tmpdir.strpath)
    assert res == []

Waiting for deferreds in fixtures

pytest_twisted.blockon allows fixtures to wait for deferreds.

def val():
    d = defer.Deferred()
    reactor.callLater(1.0, d.callback, 10)
    return pytest_twisted.blockon(d)

async/await fixtures

async/await fixtures can be used along with yield for normal pytest fixture semantics of setup, value, and teardown. At present only function scope is supported.

async def foo():
    d1, d2 = defer.Deferred(), defer.Deferred()
    reactor.callLater(0.01, d1.callback, 42)
    reactor.callLater(0.02, d2.callback, 37)
    value = await d1
    yield value
    await d2

The twisted greenlet

Some libraries (e.g. corotwine) need to know the greenlet, which is running the twisted reactor. It’s available from the twisted_greenlet fixture. The following code can be used to make corotwine work with pytest-twisted.

@pytest.fixture(scope="session", autouse=True)
def set_MAIN(request, twisted_greenlet):
    from corotwine import protocol
    protocol.MAIN = twisted_greenlet

That’s (almost) all.



Use pytest_twisted.blockon
Use pytest_twisted.inlineCallbacks

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-twisted, version 1.12
Filename, size File type Python version Upload date Hashes
Filename, size pytest_twisted-1.12-py2.py3-none-any.whl (7.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size (16.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page