Pytest plugin for testing async python code
Project description
pytest-aio
pytest-aio – Is a simple pytest plugin for testing any async python code
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.9
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 TrueNo 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):
assert request.paramIf 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', {'use_uvloop': False}), id='asyncio'),
pytest.param(('asyncio', {'use_uvloop': True}), id='asyncio+uvloop'),
pytest.param(('trio', {'trio_asyncio': True}), id='trio+asyncio'),
pytest.param(('curio', {'debug': True}), id='curio'),
])
def aiolib(request):
assert request.paramTo set a specific backends for a single test only:
@pytest.mark.parametrize('aiolib', ['asyncio'])
async def only_with_asyncio():
await asyncio.sleep(1)
assert TrueHelpers
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pytest_aio-1.8.1.tar.gz.
File metadata
- Download URL: pytest_aio-1.8.1.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 97dcbc1c5ac991705f32bb2cf72f9ba94a8889fd0295d29ed4d7252b3e158684 |
|
| MD5 | d542d21af8ce603c5676fdb17962a14f |
|
| BLAKE2b-256 | 1dffd84578dfa2180ee5fd73bb28a6b040e537ee126fa929cf5cc3023bd9af87 |
File details
Details for the file pytest_aio-1.8.1-py3-none-any.whl.
File metadata
- Download URL: pytest_aio-1.8.1-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 878b73534eaacdb9b5fa22f183435117f79d18daa1d249a2ba567ff3807175c6 |
|
| MD5 | f2f34aec659d0326bf8e52a6ce3a3e29 |
|
| BLAKE2b-256 | c4fb77e3709333b3e9b8655e4445b78391da4870d7b0c6c2c8eedab4fa6880e4 |
