Welcome to Async Responses documentation!¶

Introduction¶

Async Responses is a library providing an easy way to mock aiohttp responses inspired by aioresponses.

Installation¶

Library is available on PyPi, you can simply install it using pip:

$ pip install async-responses

Usage¶

As an instance¶

ar = AsyncResponses()
ar.get(...)

As a context manager¶

with AsyncResponses() as ar:
    ar.get(...)

With dict as handler¶

Passing dict as handler argument to async-responses would result in it being returned as a JSON payload.

import aiohttp
from async_responses import AsyncResponses


async def test_response():
    ar = AsyncResponses()
    payload = {'status': 'ok'}
    ar.get('http://mock.url', '/v1/status', handler=payload)
    async with aiohttp.ClientSession() as session:
        response = await session.get('http://mock.url/v1/status')
        assert await response.json() == payload

With exception as handler¶

Calling Async Responses with an exception as handler argument would result in it being raised.

import aiohttp
from async_responses import AsyncResponses
import pytest


async def test_response():
    ar = AsyncResponses()
    ar.get('http://mock.url', '/v1/status', handler=ZeroDivisionError)
    with pytest.raises(ZeroDivisionError):
        async with aiohttp.ClientSession() as session:
            await session.get('http://mock.url/v1/status')

With string as handler¶

import aiohttp
from async_responses import AsyncResponses

async def test_response():
    ar = AsyncResponses()
    payload = 'ok'
    ar.get('http://mock.url', '/v1/status', handler=payload)
    async with aiohttp.ClientSession() as session:
        response = await session.get('http://mock.url/v1/status')
        assert await response.text() == payload

With callable as handler¶

import aiohttp
from async_responses import AsyncResponses


async def test_response():
    def handler(data, **kwargs):
        return {'status': 'ok'}

    ar = AsyncResponses()
    ar.get('http://mock.url', '/v1/status', handler=payload)
    async with aiohttp.ClientSession() as session:
        response = await session.get('http://mock.url/v1/status')
        assert await response.json() == {'status': 'ok'}

With a custom status code¶

import aiohttp
from async_responses import AsyncResponses


async def test_response():
    payload = {'status': 'not good'}
    ar = AsyncResponses()
    ar.get('http://mock.url', '/v1/status', handler=payload, status=500)
    async with aiohttp.ClientSession() as session:
        response = await session.get('http://mock.url/v1/status')
        assert response.status == 500
        assert await response.json() == payload

With a custom response class¶

async-responses will make use of a response class passed as an argument to ClientSession, so you can use things like custom JSON serializer:

import aiohttp

async def test_response():
    class CustomResponse(aiohttp.ClientResponse):
        async def json(self, *args, **kwargs):
            return {'hello': 'world'}

    ar = AsyncResponses()
    ar.get('http://mock.url', '/v1/status', handler='')
    async with aiohttp.ClientSession(response_class=CustomResponse) as session:
        response = await session.get('http://mock.url/v1/status')
        assert await response.json() == {'hello': 'world'}
        assert isinstance(response, CustomResponse)

API¶

class async_responses.Response(method, hostname, path, handler, status)¶

class async_responses.Call(method, url, args, kwargs)¶

class async_responses.AsyncResponses(*, mock_module=None, passthrough=[])¶

Async Responses context manager

Parameters

passthrough – list of patterns of URLs which won’t be mocked
mock_module – mock module, defaults to unittest.mock

add(method, hostname, path, handler, status=200)¶

Mocks aiohttp response for the next request matching parameters.

Parameters

method (str) – HTTP method, for example get
hostname (str) – server hostname
path (str) – path
handler (Union[Callable, dict, str, Exception]) – response, can be either a dict, string, callable or an exception
status (int) – status code, defaults to 200

property calls¶

List of calls

Return type: List[Call]

get(hostname, path, handler, status=200)¶

Mocks GET request. Shorthand for add('get', *args)

Return type: None

passthrough(pattern)¶

Adds passthrough. Requests to URLs which match the pattern won’t be mocked.

Return type: None

patch(hostname, path, handler, status=200)¶

Mocks PATCH request. Shorthand for add('patch', *args)

Return type: None

post(hostname, path, handler, status=200)¶

Mocks POST request. Shorthand for add('post', *args)

Return type: None

put(hostname, path, handler, status=200)¶

Mocks PUT request. Shorthand for add('put', *args)

Return type: None

reset()¶

Resets mock

Return type: None

property responses¶

List of responses

Return type: List[Response]

Changelog¶

1.0.0 (21.04.2020)¶

Initial release