pytest-asyncio 0.4.1

Pytest support for asyncio.

pytest-asyncio is an Apache2 licensed library, written in Python, for testing asyncio code with pytest.

asyncio code is usually written in the form of coroutines, which makes it slightly more difficult to test using normal testing tools. pytest-asyncio provides useful fixtures and markers to make testing easier.

@pytest.mark.asyncio
async def test_some_asyncio_code():
    res = await library.do_something()
    assert b'expected result' == res

or, if you’re using the pre-Python 3.5 syntax:

@pytest.mark.asyncio
def test_some_asyncio_code():
    res = yield from library.do_something()
    assert b'expected result' == res

pytest-asyncio has been strongly influenced by pytest-tornado.

Features

• fixtures for creating and injecting versions of the asyncio event loop

• fixtures for injecting unused tcp ports

• pytest markers for treating tests as asyncio coroutines

• easy testing with non-default event loops

Installation

To install pytest-asyncio, simply:

$ pip install pytest-asyncio

This is enough for pytest to pick up pytest-asyncio.

Fixtures

event_loop

Creates and injects a new instance of the default asyncio event loop. The loop will be closed at the end of the test.

Note that just using the event_loop fixture won’t make your test function a coroutine. You’ll need to interact with the event loop directly, using methods like event_loop.run_until_complete. See the pytest.mark.asyncio marker for treating test functions like coroutines.

def test_http_client(event_loop):
    url = 'http://httpbin.org/get'
    resp = event_loop.run_until_complete(http_client(url))
    assert b'HTTP/1.1 200 OK' in resp

This fixture can be easily overridden in any of the standard pytest locations (e.g. directly in the test file, or in conftest.py) to use a non-default event loop. This will take effect even if you’re using the pytest.mark.asyncio marker and not the event_loop fixture directly.

@pytest.fixture()
def event_loop():
    return MyCustomLoop()

event_loop_process_pool

The event_loop_process_pool fixture is almost identical to the event_loop fixture, except the created event loop will have a concurrent.futures.ProcessPoolExecutor set as the default executor.

unused_tcp_port

Finds and yields a single unused TCP port on the localhost interface. Useful for binding temporary test servers.

unused_tcp_port_factory

A callable which returns a different unused TCP port each invocation. Useful when several unused TCP ports are required in a test.

def a_test(unused_tcp_port_factory):
    port1, port2 = unused_tcp_port_factory(), unused_tcp_port_factory()
    ...

Markers

pytest.mark.asyncio(forbid_global_loop=False)

Mark your test coroutine with this marker and pytest will execute it as an asyncio task using the event loop provided by the event_loop fixture. See the introductory section for an example.

The event loop used can be overriden by overriding the event_loop fixture (see above).

If forbid_global_loop is true, asyncio.get_event_loop() will result in exceptions, ensuring your tests are always passing the event loop explicitly.

pytest.mark.asyncio_process_pool(forbid_global_loop=False)

The asyncio_process_pool marker is almost identical to the asyncio marker, except the event loop used will have a concurrent.futures.ProcessPoolExecutor set as the default executor.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.