mirror of https://github.com/python/cpython
d65b783b69
mock: Add `ThreadingMock` class Add a new class that allows to wait for a call to happen by using `Event` objects. This mock class can be used to test and validate expectations of multithreading code. It uses two attributes for events to distinguish calls with any argument and calls with specific arguments. The calls with specific arguments need a lock to prevent two calls in parallel from creating the same event twice. The timeout is configured at class and constructor level to allow users to set a timeout, we considered passing it as an argument to the function but it could collide with a function parameter. Alternatively we also considered passing it as positional only but from an API caller perspective it was unclear what the first number meant on the function call, think `mock.wait_until_called(1, "arg1", "arg2")`, where 1 is the timeout. Lastly we also considered adding the new attributes to magic mock directly rather than having a custom mock class for multi threading scenarios, but we preferred to have specialised class that can be composed if necessary. Additionally, having added it to `MagicMock` directly would have resulted in `AsyncMock` having this logic, which would not work as expected, since when if user "waits" on a coroutine does not have the same meaning as waiting on a standard call. Co-authored-by: Karthikeyan Singaravelan <tir.karthi@gmail.com> |
||
|---|---|---|
| .. | ||
| __init__.py | ||
| __main__.py | ||
| support.py | ||
| testasync.py | ||
| testcallable.py | ||
| testhelpers.py | ||
| testmagicmethods.py | ||
| testmock.py | ||
| testpatch.py | ||
| testsealable.py | ||
| testsentinel.py | ||
| testthreadingmock.py | ||
| testwith.py | ||