Skip to content

Commit 0704214

Browse files
authored
Add pytest_mock stubs (#4275)
1 parent 986eff0 commit 0704214

File tree

3 files changed

+104
-0
lines changed

3 files changed

+104
-0
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
from .plugin import *
2+
from .plugin import _get_mock_module as _get_mock_module
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
version: str

third_party/3/pytest_mock/plugin.pyi

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import unittest.mock
2+
from typing import Any, Callable, Optional, TypeVar, Union, overload
3+
4+
from ._version import version as version
5+
6+
_T = TypeVar("_T")
7+
_MockModule = Any # usually unittest.mock
8+
_Config = Any # pytest.Config
9+
10+
__version__ = version
11+
12+
def _get_mock_module(config: _Config) -> _MockModule: ...
13+
14+
class MockFixture:
15+
mock_module: _MockModule
16+
patch: MockFixture._Patcher # google/pytype#611
17+
# The following aliases don't work due to google/pytype#612
18+
Mock: Any # actually unittest.mock.Mock
19+
MagicMock: Any # actually unittest.mock.MagicMock
20+
NonCallableMock: Any # actually unittest.mock.NonCallableMock
21+
PropertyMock: Any # actually unittest.mock.PropertyMock
22+
call: Any # actually unittest.mock.call
23+
ANY: Any # actually unittest.mock.ANY
24+
DEFAULT: Any # actually unittest.mock.DEFAULT
25+
create_autospec: Any # actually unittest.mock.create_autospec
26+
sentinel: Any # actually unittest.mock.sentinel
27+
mock_open: Any # actually unittest.mock.mock_open
28+
def __init__(self, config: _Config) -> None: ...
29+
def resetall(self) -> None: ...
30+
def stopall(self) -> None: ...
31+
def spy(self, obj: object, name: str) -> unittest.mock.MagicMock: ...
32+
def stub(self, name: Optional[str] = ...) -> unittest.mock.MagicMock: ...
33+
class _Patcher:
34+
mock_module: _MockModule
35+
def object(
36+
self,
37+
target: Any,
38+
attribute: str,
39+
new: Optional[Any] = ...,
40+
spec: Optional[Any] = ...,
41+
create: bool = ...,
42+
spec_set: Optional[Any] = ...,
43+
autospec: Optional[Any] = ...,
44+
new_callable: Optional[Any] = ...,
45+
**kwargs: Any,
46+
) -> Any: ...
47+
def multiple(
48+
self,
49+
target: Any,
50+
spec: Optional[Any] = ...,
51+
create: bool = ...,
52+
spec_set: Optional[Any] = ...,
53+
autospec: Optional[Any] = ...,
54+
new_callable: Optional[Any] = ...,
55+
**kwargs: Any,
56+
) -> Any: ...
57+
def dict(self, in_dict: Any, values: Any = ..., clear: bool = ..., **kwargs: Any) -> Any: ...
58+
@overload
59+
def __call__(
60+
self,
61+
target: Any,
62+
new: None = ...,
63+
spec: Optional[Any] = ...,
64+
create: bool = ...,
65+
spec_set: Optional[Any] = ...,
66+
autospec: Optional[Any] = ...,
67+
new_callable: Optional[Any] = ...,
68+
**kwargs: Any,
69+
) -> unittest.mock.MagicMock: ...
70+
@overload
71+
def __call__(
72+
self,
73+
target: Any,
74+
new: _T,
75+
spec: Optional[Any] = ...,
76+
create: bool = ...,
77+
spec_set: Optional[Any] = ...,
78+
autospec: Optional[Any] = ...,
79+
new_callable: Optional[Any] = ...,
80+
**kwargs: Any,
81+
) -> _T: ...
82+
83+
mocker: Any
84+
class_mocker: Any
85+
module_mocker: Any
86+
package_mocker: Any
87+
session_mocker: Any
88+
89+
def assert_wrapper(__wrapped_mock_method__: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ...
90+
def wrap_assert_not_called(*args: Any, **kwargs: Any) -> None: ...
91+
def wrap_assert_called_with(*args: Any, **kwargs: Any) -> None: ...
92+
def wrap_assert_called_once(*args: Any, **kwargs: Any) -> None: ...
93+
def wrap_assert_called_once_with(*args: Any, **kwargs: Any) -> None: ...
94+
def wrap_assert_has_calls(*args: Any, **kwargs: Any) -> None: ...
95+
def wrap_assert_any_call(*args: Any, **kwargs: Any) -> None: ...
96+
def wrap_assert_called(*args: Any, **kwargs: Any) -> None: ...
97+
def wrap_assert_methods(config: _Config) -> None: ...
98+
def unwrap_assert_methods() -> None: ...
99+
def pytest_addoption(parser) -> None: ...
100+
def parse_ini_boolean(value: Union[bool, str]) -> bool: ...
101+
def pytest_configure(config: _Config) -> None: ...

0 commit comments

Comments
 (0)