Add SpyType protocol to expose spy attributes for type checking#572
Open
BlocksecPHD wants to merge 2 commits intopytest-dev:mainfrom
Open
Add SpyType protocol to expose spy attributes for type checking#572BlocksecPHD wants to merge 2 commits intopytest-dev:mainfrom
BlocksecPHD wants to merge 2 commits intopytest-dev:mainfrom
Conversation
The Spy type definition previously didn't include the extra attributes (spy_return, spy_return_list, spy_return_iter, spy_exception) that are added at runtime by the spy() method. This broke autocomplete and type checking for users. This change introduces a new SpyType protocol that: - Defines the spy-specific attributes with proper type annotations - Includes common mock assertion methods for full mock interface - Uses runtime_checkable decorator for isinstance support - Is exported from pytest_mock module for easy import The spy() method now returns SpyType instead of MockType, enabling proper type inference and autocomplete in IDEs. Fixes pytest-dev#547
for more information, see https://pre-commit.ci
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
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
The Spy type definition previously didn't include the extra attributes (spy_return, spy_return_list, spy_return_iter, spy_exception) that are added at runtime by the spy() method. This broke autocomplete and type checking for users.
This PR introduces a new SpyType protocol that:
runtime_checkabledecorator for isinstance supportpytest_mockmodule for easy importThe
spy()method now returnsSpyTypeinstead ofMockType, enabling proper type inference and autocomplete in IDEs.Changes
Added
SpyTypeprotocol insrc/pytest_mock/plugin.pywith:spy_return: Anyspy_return_list: list[Any]spy_return_iter: Optional[Iterator[Any]]spy_exception: Optional[BaseException]assert_called,assert_called_once, etc.)call_count,call_args,call_args_list,called)Updated
spy()method to returnSpyTypeExported
SpyTypefromsrc/pytest_mock/__init__.pyAdded comprehensive tests in
tests/test_spy_type_annotations.pyExample Usage
Before (required
type: ignorecomments):After (type checker recognizes attributes):
Testing
All existing spy tests pass. New test file verifies:
Fixes #547