Python unittest.mock.patch() Function: Usage and Examples

patch(target) temporarily replaces an attribute during a test or context block and restores it afterward.

Understanding the Concept

patch(target) temporarily replaces an attribute during a test or context block and restores it afterward. The target must identify the name used by the function under test.

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.

from pathlib import Path
from unittest.mock import patch
with patch.object(Path, 'home', return_value=Path('/example-home')):
    print(Path.home())
print(isinstance(Path.home(), Path))

Walkthrough: What Each Part Does

The imports make pathlib, unittest.mock available. These are standard-library building blocks unless the example explicitly names an external tool.
The with or async with scope controls lifetime. Setup takes place on entry, and cleanup runs on exit even when an exception interrupts the body.
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

/example-home
True

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

Patching the definition location instead of the lookup location, leaving the real external call untouched.

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

Temporarily replace pathlib.Path.home and restore it automatically.

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

Patching the definition location instead of the lookup location, leaving the real external call untouched.
Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.

Key Takeaways

patch(target) temporarily replaces an attribute during a test or context block and restores it afterward.
patch(target) temporarily replaces an attribute during a test or context block and restores it afterward. The target must identify the name used by the function under test.
Practice: Temporarily replace pathlib.Path.home and restore it automatically.