Add SpyType for mocker.spy results#582
Open
Himanshuagrawal4 wants to merge 1 commit into
Open
Conversation
nicoddemus
requested changes
Jun 3, 2026
| foo = Foo() | ||
| spy: SpyType = mocker.spy(foo, "bar") | ||
|
|
||
| assert getattr(spy, "spy_return") is None |
Member
There was a problem hiding this comment.
Why use getattr instead of accessing the attribute directly?
| spy = mocker.spy(Foo, "bar") | ||
| assert spy.spy_return is None | ||
| assert spy.spy_return_iter is None | ||
| assert getattr(spy, "spy_return") is None |
Member
There was a problem hiding this comment.
What is the purpose of these changes?
If they were required because mypy was complaining, then the SpyType is not working as intended -- the sole purpose of adding it is to avoid typing errors when annotating the object returned by mocker.spy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SpyTypeformocker.spy()return valuesspy_return,spy_return_iter,spy_return_list,spy_exception) to type checkersSpyTypefrompytest_mockand add a regression testCloses #547.
Validation
pre-commit run --files CHANGELOG.rst src/pytest_mock/__init__.py src/pytest_mock/plugin.py tests/test_pytest_mock.pypython -m mypy src testspython -m pytest tests/test_pytest_mock.py::test_spy_type tests/test_pytest_mock.py::test_instance_method_spy tests/test_pytest_mock.py::test_spy_return_iter_resets -qpython -m pytest tests -q -k "not introspection"python -m compileall -q src\pytest_mockgit diff --checkNotes
The full local
python -m pytest tests -qrun has four existing assertion-introspection output failures on this Windows/Python 3.13 environment. They appear unrelated to this typing change, so this PR leaves those tests untouched.