Skip to main content

pytest-aio

pytest-aio – Is a simple pytest plugin for testing any async python code

Tests Status PYPI Version Python Versions

Features

  • Supports all most popular async python libraries: Asyncio, Trio and Curio

  • Automatically run your async tests

  • Works with contextvars correctly (supports it for async/sync fixtures)

  • Supports trio-asyncio

Requirements

  • python >= 3.10

Installation

pytest-aio should be installed using pip:

pip install pytest-aio

optionally extras are available:

pip install pytest-aio[curio,trio]

Usage

When installed the plugin runs all your async test functions/fixtures.

async def test_async():
    assert True

No need to mark your async tests. Just run pytest as is.

Async fixtures for sync tests

If you plan use async fixtures for sync tests, please ensure you have to include aiolib fixture:

# It's important to add aiolib fixture here
def test_with_async_fixtures(async_fixture, aiolib):
    assert async_fixture == 'value from async fixture'

As an alternative, If you are doing the async fixtures yourself, you can add aiolib inside them:

@pytest.fixture
async def async_fixture(aiolib):
    return 'value from async fixture'

# So for the test we don't need to implicity use `aiolib` anymore
def test_with_async_fixtures(async_fixture):
    assert async_fixture == 'value from async fixture'

Customize async libraries

By default each test function will be run with asyncio, trio, curio backends consistently (only if trio/curio are installed). But you can customise the libraries for all your tests creating the global fixture:

# Run all tests with Asyncio/Trio only
@pytest.fixture(params=['asyncio', 'trio'])
def aiolib(request):
    return request.param

If you want to specify different options for the selected backend, you can do so by passing a tuple of (backend name, options dict):

@pytest.fixture(params=[
    pytest.param(('asyncio'), id='asyncio'),
    pytest.param(('asyncio', {'loop_factory': uvloop.new_event_loop}), id='asyncio+uvloop'),
    pytest.param(('trio', {'trio_asyncio': True}), id='trio+asyncio'),
    pytest.param(('curio', {'debug': True}), id='curio'),
])
def aiolib(request):
    assert request.param

To set a specific backends for a single test only:

@pytest.mark.parametrize('aiolib', ['asyncio'])
async def only_with_asyncio():
    await asyncio.sleep(1)
    assert True

Helpers

The plugin contains aiosleep fixture. It’s an equivalent to asyncio.sleep, trio.sleep, curio.sleep for current running library.

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/asgi-tools/issues

Contributing

Development of the project happens at: https://github.com/klen/pytest-aio

License

Licensed under a MIT license.

Metadata

Release files for pytest-aio 2.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-aio 2.1.7
File Size Uploaded
pytest_aio-2.1.7.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytest-aio 2.1.7
File Interpreter ABI Platform
pytest_aio-2.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 12.1 kB

Release files / pytest_aio-2.1.7.tar.gz

Download URL pytest_aio-2.1.7.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
c9c2fa05787a48cc6abf90f57d2333dc4fe356a1b49db7bcb52ec32ada8bb684
BLAKE2b-256 checksum
How to use checksums
ba389aab892a064592dde69b68554550a7f773d9120d5cbd77c9c033a91bba71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pytest_aio-2.1.7-py3-none-any.whl

Download URL pytest_aio-2.1.7-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
72eca30834d254d3f36336295a19119b42900c84bdd8155a0c242467987d0e73
BLAKE2b-256 checksum
How to use checksums
8a39a9a065eaf0336041225443e79ecbaa27146c241514782990480a70df0ac0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

2.1.7 This release

2 release files

2.1.6

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.9.0

2 release files

1.8.1

2 release files

1.5.0

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.2

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

1 release file

0.4.7

1 release file

0.4.6

1 release file

0.4.5

1 release file

0.4.4

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.0

1 release file

0.1.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page