Python unittest.mock.AsyncMock Class: Usage and Examples

AsyncMock models awaited async callables and records await arguments separately from ordinary calls.

Understanding the Concept

AsyncMock models awaited async callables and records await arguments separately from ordinary calls. Use assert_awaited_once_with to confirm the coroutine was actually awaited.

How this fits into a real test suite

A reliable test starts with a specific expected behavior. Keep the fixture small, arrange the input, call the real code, and assert a result the reader can verify. Add one boundary or failure case so the test does not pass only for a convenient example. In a larger project, run the same test automatically after each change.

Tests are repeatable experiments. Use temporary resources and injected dependencies where possible; when the environment is part of the requirement, add a separate integration test rather than weakening the unit test.

Worked Example

Read the code from the first line to the last. Identify which values are inputs, which operation is being demonstrated and what should happen before running it.

import asyncio
from unittest.mock import AsyncMock
async def main():
    request_mock = AsyncMock(return_value={'status': 'ok'})
    response = await request_mock('https://example.invalid/status')
    request_mock.assert_awaited_once_with('https://example.invalid/status')
    print(response['status'])
asyncio.run(main())

Walkthrough: What Each Part Does

• The imports make asyncio, unittest.mock available. These are standard-library building blocks unless the example explicitly names an external tool.
• The definition main creates reusable behavior. Its body runs when called, awaited or instantiated; defining it alone does not run the body of an ordinary function.
• Each await is a suspension point. When the awaited operation is not ready, the loop can schedule other tasks instead of blocking the entire thread.
• The coordination call waits for a result or a completion condition. Predict what would happen if the worker failed or never became ready.
• The final check compares actual behavior with an explicit expectation. A successful test tells you that this particular case passed, not that every possible input works.

This demonstration focuses on one practical behavior. Before changing several lines, vary one input or one configuration choice and check whether the result changes for the reason you expected.

Example Output

ok

The output above was captured by running the example in the available Python environment. The order of concurrent events, durations and platform-dependent values can legitimately differ on your computer.

Important Behavior and Edge Cases

Checking only that an async mock was called while forgetting to await the returned coroutine.

Pay particular attention to the documented return values, errors and resource-lifetime rules. A convenient result under normal inputs does not guarantee correct behavior under cancellation, missing data or environmental failure.

Practice Exercise

Mock an async HTTP helper and assert the awaited URL.

Write down the result you expect before running your changed code. Check at least one normal case and one boundary or failure case. If your example starts workers or opens resources, verify how they are cleaned up.

Further reading: official documentation and API reference.

Common Beginner Mistakes

• Checking only that an async mock was called while forgetting to await the returned coroutine.
• Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.

Key Takeaways

• AsyncMock models awaited async callables and records await arguments separately from ordinary calls.
• AsyncMock models awaited async callables and records await arguments separately from ordinary calls. Use assert_awaited_once_with to confirm the coroutine was actually awaited.
• Practice: Mock an async HTTP helper and assert the awaited URL.