Might mock.MagicMock be given a type parameter?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
Proposal:
In the case of
class MyClass:
def method_that_exists_on_my_class(self):
pass
my_mock_thing = mock.create_autospec(MyClass)
my_mock_thing.method_that_exists_on_my_class()
my_mock_thing.method_that_does_not_exist_on_my_class()
my_mock_thing.method_that_exists_on_my_class.assert_called_once()
my_mock_thing.method_that_does_not_exist_on_my_class.assert_called_once()
it would be nice if the type of my_mock_thing were mock.MagicMock[MyClass] (instead of "raw" mock.MagicMock) so that type-checkers could alert me that my call to my_mock_thing.method_that_does_not_exist_on_my_class is a flaw in my test.
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
(I looked around among both open and closed issues and didn't see anything on this topic; apologies if I overlooked an already-ongoing discussion...)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The proposal centers on mock.MagicMock and mock.create_autospec; start by locating those entry points and reviewing how mocks are currently typed. Then identify the relevant tests for autospec attribute access. Done means type checkers can flag nonexistent methods on an autospecced mock while preserving valid method access.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100