Mock automatically creates attributes and records interactions.
Understanding the Concept
Mock automatically creates attributes and records interactions. Configure return_value or side_effect to simulate behavior and inspect call_args or assert_called_once_with to verify expected use.
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 unittest.mock import Mock
payment_service = Mock()
payment_service.charge.return_value = 'approved'
print(payment_service.charge(125))
payment_service.charge.assert_called_once_with(125)Walkthrough: What Each Part Does
- The imports make unittest.mock available. These are standard-library building blocks unless the example explicitly names an external tool.
- 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
approvedThe 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
Believing a plain Mock validates a real API signature or catches every misspelled attribute.
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
Simulate a payment service and verify its method was called exactly once.
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
- Believing a plain Mock validates a real API signature or catches every misspelled attribute.
- Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.
Key Takeaways
- Mock automatically creates attributes and records interactions.
- Mock automatically creates attributes and records interactions. Configure return_value or side_effect to simulate behavior and inspect call_args or assert_called_once_with to verify expected use.
- Practice: Simulate a payment service and verify its method was called exactly once.