pytest-aiohttp

1.1.0 · active · verified Thu Apr 09

pytest-aiohttp is a pytest plugin that provides useful fixtures for testing aiohttp applications. It simplifies the creation and interaction with aiohttp servers and clients within your pytest test suite. The current version is 1.1.0 and releases are typically made as needed, often following updates to `aiohttp` or `pytest`.

Warnings

breaking The `loop` fixture was removed in version 1.0.0. If your tests explicitly depended on `loop` for asyncio event loop access, you should now use `asyncio.get_event_loop()` or `asyncio.current_task()` where appropriate.
Fix: Remove the `loop` fixture from your test function signatures. Instead, use standard `asyncio` module functions like `asyncio.get_event_loop()` if you need to interact with the event loop directly, or rely on `pytest-asyncio` to manage it implicitly.
breaking Python 3.7 and 3.8 support was dropped in version 1.0.0. Users on these Python versions must upgrade to Python 3.9 or newer to use `pytest-aiohttp` v1.0.0 and later.
Fix: Upgrade your Python environment to version 3.9 or higher. Alternatively, if upgrading Python is not an option, you must stick to `pytest-aiohttp` versions older than 1.0.0 (e.g., `0.4.0`).
gotcha You must configure `pytest-asyncio` by adding `asyncio_mode = auto` to your `pytest.ini` or `pyproject.toml` file. Without this, your async tests using `pytest-aiohttp` fixtures will not run correctly.
Fix: Create a `pytest.ini` file in your project root (or configure `pyproject.toml`) and add the line `asyncio_mode = auto` under the `[pytest]` section. For example: ```ini [pytest] asyncio_mode = auto ```
gotcha `pytest-aiohttp` has specific `pytest` version requirements. For example, `pytest-aiohttp>=1.0.0` requires `pytest>=7.0.0`. Using an incompatible version of `pytest` can lead to unexpected errors or fixtures not being discovered.
Fix: Always ensure your `pytest` installation meets the requirements specified by `pytest-aiohttp`. Check the `install_requires` section on the `pytest-aiohttp` PyPI page or its `setup.py`/`pyproject.toml` for the exact `pytest` version bounds.

Install

pip install pytest-aiohttp Install stable version

Quickstart

To use `pytest-aiohttp`, you need to configure `pytest-asyncio` in your `pytest.ini` (or `pyproject.toml`). A minimal `pytest.ini` might look like this: ```ini [pytest] asyncio_mode = auto ``` This setup automatically handles the asyncio event loop. The example demonstrates defining an `aiohttp` application within a fixture and then using the `aiohttp_client` fixture (provided by `pytest-aiohttp`) to create a test client for your app, which can then be used in your async test functions.

import pytest
from aiohttp import web

# test_app.py

@pytest.fixture
async def cli(aiohttp_client):
    """Client fixture that returns a test client for your aiohttp application."""
    app = web.Application()
    async def hello_handler(request):
        return web.Response(text="Hello from aiohttp app!")
    app.router.add_get('/', hello_handler)
    return await aiohttp_client(app)

async def test_hello_world(cli):
    """Test that the application responds correctly."""
    resp = await cli.get('/')
    assert resp.status == 200
    text = await resp.text()
    assert 'Hello from aiohttp app!' in text

view raw JSON →