Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix type annotation #364

Merged
merged 4 commits into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Releases
========

UNRELEASED
-------------------

* Updated type annotations for ``mocker.patch`` and ``mocker.spy`` (`#364`_).

.. _#364: https://github.com/pytest-dev/pytest-mock/pull/364

3.10.0 (2022-10-05)
-------------------

Expand Down
22 changes: 14 additions & 8 deletions src/pytest_mock/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,16 @@

_T = TypeVar("_T")

if sys.version_info[:2] > (3, 7):
if sys.version_info >= (3, 8):
AsyncMockType = unittest.mock.AsyncMock
MockType = Union[
unittest.mock.MagicMock,
unittest.mock.AsyncMock,
unittest.mock.NonCallableMagicMock,
]
else:
AsyncMockType = Any
MockType = Union[unittest.mock.MagicMock, unittest.mock.NonCallableMagicMock]


class PytestMockWarning(UserWarning):
Expand Down Expand Up @@ -112,7 +118,7 @@ def stop(self, mock: unittest.mock.MagicMock) -> None:
else:
raise ValueError("This mock object is not registered")

def spy(self, obj: object, name: str) -> unittest.mock.MagicMock:
def spy(self, obj: object, name: str) -> MockType:
egor43 marked this conversation as resolved.
Show resolved Hide resolved
"""
Create a spy of method. It will run method normally, but it is now
possible to use `mock` call features with it, like call count.
Expand Down Expand Up @@ -205,13 +211,13 @@ def __init__(self, patches_and_mocks, mock_module):

def _start_patch(
self, mock_func: Any, warn_on_mock_enter: bool, *args: Any, **kwargs: Any
) -> unittest.mock.MagicMock:
) -> MockType:
"""Patches something by calling the given function from the mock
module, registering the patch to stop it later and returns the
mock object resulting from the mock call.
"""
p = mock_func(*args, **kwargs)
mocked = p.start() # type: unittest.mock.MagicMock
mocked: MockType = p.start()
self.__patches_and_mocks.append((p, mocked))
if hasattr(mocked, "reset_mock"):
# check if `mocked` is actually a mock object, as depending on autospec or target
Expand Down Expand Up @@ -242,7 +248,7 @@ def object(
autospec: Optional[object] = None,
new_callable: object = None,
**kwargs: Any
) -> unittest.mock.MagicMock:
) -> MockType:
"""API to mock.patch.object"""
if new is self.DEFAULT:
new = self.mock_module.DEFAULT
Expand Down Expand Up @@ -271,7 +277,7 @@ def context_manager(
autospec: Optional[builtins.object] = None,
new_callable: builtins.object = None,
**kwargs: Any
) -> unittest.mock.MagicMock:
) -> MockType:
"""This is equivalent to mock.patch.object except that the returned mock
does not issue a warning when used as a context manager."""
if new is self.DEFAULT:
Expand Down Expand Up @@ -299,7 +305,7 @@ def multiple(
autospec: Optional[builtins.object] = None,
new_callable: Optional[builtins.object] = None,
**kwargs: Any
) -> Dict[str, unittest.mock.MagicMock]:
) -> Dict[str, MockType]:
"""API to mock.patch.multiple"""
return self._start_patch(
self.mock_module.patch.multiple,
Expand Down Expand Up @@ -341,7 +347,7 @@ def __call__(
autospec: Optional[builtins.object] = ...,
new_callable: None = ...,
**kwargs: Any
) -> unittest.mock.MagicMock:
) -> MockType:
...

@overload
Expand Down