Spy type is missing extra attributes

[glukki]

According to the documentation and code Spy provides extra attributes: https://pytest-mock.readthedocs.io/en/latest/usage.html#spy

pytest-mock/src/pytest_mock/plugin.py

Lines 213 to 218 in 184eb19

	spy_obj = self.patch.object(obj, name, side_effect=wrapped, autospec=autospec)
	spy_obj.spy_return = None
	spy_obj.spy_return_iter = None
	spy_obj.spy_return_list = []
	spy_obj.spy_exception = None
	return spy_obj

But they're not listed in the Spy type.

Spy definition:

pytest-mock/src/pytest_mock/plugin.py

Lines 160 to 162 in 184eb19

	def spy(
	self, obj: object, name: str, duplicate_iterators: bool = False
	) -> MockType:

Spy type definition:

pytest-mock/src/pytest_mock/plugin.py

Lines 29 to 33 in 184eb19

	MockType = Union[
	unittest.mock.MagicMock,
	unittest.mock.AsyncMock,
	unittest.mock.NonCallableMagicMock,
	]

This breaks autocomplete 😢

[nicoddemus]

Hi @glukki,

Thanks for the report. I'm not sure what would be the proper fix here though... perhaps we need to declare subclasses for those modules which add the extra attributes?

[glukki]

Hi @nicoddemus,

From the first glance I thought of making a SpyType, that would be a union of the MockType and the Spy's extras.
I'll try to make a draft PR.

[nicoddemus]

Cool, thanks.

You likely need to make a new class which subclasses MockType and adds the attributes. An Union won't work, because users would need to check (isinstance) for MockTypewhen accessing the mock types, andSpyType` when accessing the spy attributes.