pytest-anyio (DEPRECATED: Plugin built into anyio)

0.0.0 · deprecated · verified Wed Apr 15

This package is obsolete. The pytest plugin for AnyIO is built directly into the `anyio` library itself, meaning `pytest-anyio` does not need to be installed. The PyPI entry for `pytest-anyio` serves primarily as a redirect to this information. AnyIO provides a robust asynchronous networking and concurrency library compatible with asyncio and Trio, with its pytest plugin facilitating asynchronous test writing and fixture management.

Warnings

breaking The `pytest-anyio` package is deprecated and should NOT be installed. Its functionality was absorbed into the `anyio` library itself.
Fix: Uninstall `pytest-anyio` if present (`pip uninstall pytest-anyio`) and ensure you have `anyio` (>=3.0.0) and `pytest` installed (`pip install anyio pytest`).
gotcha Asynchronous test functions and fixtures are not automatically detected by pytest without proper marking or configuration. They require explicit indications for the AnyIO plugin to run them correctly.
Fix: Use `@pytest.mark.anyio` on async test functions/fixtures, or add `anyio_mode = "auto"` to your `pytest.ini` file. Alternatively, explicitly request the `anyio_backend` fixture in your async test function signatures.
gotcha Conflicts can arise if `pytest-asyncio` is installed and configured to use `asyncio_mode = 'auto'` simultaneously with `anyio`'s plugin, as both attempt to auto-detect and run async tests.
Fix: If `pytest-asyncio` is installed, remove `asyncio_mode` from your `pytest` configuration to allow `pytest-asyncio` to use its default strict mode, preventing conflicts with `anyio`'s auto-detection.

Install

pip install anyio pytest Install AnyIO and pytest

Imports

pytest.mark.anyio
wrong:
```
from pytest_anyio import anyio_backend
```
correct:
```
import pytest
# ... then use @pytest.mark.anyio on async test functions or pytestmark = pytest.mark.anyio
```
The plugin is integrated into 'anyio'; access markers and fixtures via 'pytest' directly after installing 'anyio'.
anyio_backend (fixture)
```
def test_my_async_function(anyio_backend): ...
```
The 'anyio_backend' fixture is automatically provided by the 'anyio' pytest plugin when 'anyio' is installed.

Quickstart

To write asynchronous tests with AnyIO and pytest, ensure `anyio` and `pytest` are installed. You can mark individual asynchronous test functions with `@pytest.mark.anyio`, apply `pytestmark = pytest.mark.anyio` at the module level to mark all tests, or configure `anyio_mode = 'auto'` in your `pytest.ini`. The `anyio_backend` fixture is automatically available for managing async backends. Asynchronous fixtures are also fully supported by marking them with `@pytest.fixture` and `@pytest.mark.anyio`.

import pytest
import anyio

# Option 1: Mark individual async test functions
@pytest.mark.anyio
async def test_async_function():
    await anyio.sleep(0.001)
    assert True

# Option 2: Mark all async test functions in a module
pytestmark = pytest.mark.anyio

async def test_another_async_function_module_wide():
    await anyio.sleep(0.001)
    assert True

# Option 3: Use the anyio_backend fixture (often implicitly, or for custom backend control)
async def test_with_anyio_backend_fixture(anyio_backend):
    # 'anyio_backend' can be used to explicitly specify a backend or is implicitly available
    # For example, to run only on 'asyncio':
    # @pytest.mark.parametrize('anyio_backend', ['asyncio'])
    # async def test_on_asyncio_only(anyio_backend):
    await anyio.sleep(0.001)
    assert True

# Example of an asynchronous fixture
@pytest.fixture
@pytest.mark.anyio
async def async_data():
    # Simulate async setup
    await anyio.sleep(0.001)
    yield {'key': 'value'}
    # Simulate async teardown
    await anyio.sleep(0.001)

async def test_using_async_fixture(async_data):
    assert async_data['key'] == 'value'

view raw JSON →