Skip to content

Add pytest_mock stubs #4275

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

Merged
merged 6 commits into from
Jun 28, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions third_party/3/pytest_mock/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from .plugin import *
from .plugin import _get_mock_module as _get_mock_module
1 change: 1 addition & 0 deletions third_party/3/pytest_mock/_version.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
version: str
101 changes: 101 additions & 0 deletions third_party/3/pytest_mock/plugin.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import unittest.mock
from typing import Any, Callable, Optional, TypeVar, Union, overload

from ._version import version as version

_T = TypeVar("_T")
_MockModule = Any # usually unittest.mock
_Config = Any # pytest.Config

__version__ = version

def _get_mock_module(config: _Config) -> _MockModule: ...

class MockFixture:
mock_module: _MockModule
patch: MockFixture._Patcher # google/pytype#611
# The following aliases don't work due to google/pytype#612
Mock: Any # actually unittest.mock.Mock
MagicMock: Any # actually unittest.mock.MagicMock
NonCallableMock: Any # actually unittest.mock.NonCallableMock
PropertyMock: Any # actually unittest.mock.PropertyMock
call: Any # actually unittest.mock.call
ANY: Any # actually unittest.mock.ANY
DEFAULT: Any # actually unittest.mock.DEFAULT
create_autospec: Any # actually unittest.mock.create_autospec
sentinel: Any # actually unittest.mock.sentinel
mock_open: Any # actually unittest.mock.mock_open
def __init__(self, config: _Config) -> None: ...
def resetall(self) -> None: ...
def stopall(self) -> None: ...
def spy(self, obj: object, name: str) -> unittest.mock.MagicMock: ...
def stub(self, name: Optional[str] = ...) -> unittest.mock.MagicMock: ...
class _Patcher:
mock_module: _MockModule
def object(
self,
target: Any,
attribute: str,
new: Optional[Any] = ...,
spec: Optional[Any] = ...,
create: bool = ...,
spec_set: Optional[Any] = ...,
autospec: Optional[Any] = ...,
new_callable: Optional[Any] = ...,
**kwargs: Any,
) -> Any: ...
def multiple(
self,
target: Any,
spec: Optional[Any] = ...,
create: bool = ...,
spec_set: Optional[Any] = ...,
autospec: Optional[Any] = ...,
new_callable: Optional[Any] = ...,
**kwargs: Any,
) -> Any: ...
def dict(self, in_dict: Any, values: Any = ..., clear: bool = ..., **kwargs: Any) -> Any: ...
@overload
def __call__(
self,
target: Any,
new: None = ...,
spec: Optional[Any] = ...,
create: bool = ...,
spec_set: Optional[Any] = ...,
autospec: Optional[Any] = ...,
new_callable: Optional[Any] = ...,
**kwargs: Any,
) -> unittest.mock.MagicMock: ...
@overload
def __call__(
self,
target: Any,
new: _T,
spec: Optional[Any] = ...,
create: bool = ...,
spec_set: Optional[Any] = ...,
autospec: Optional[Any] = ...,
new_callable: Optional[Any] = ...,
**kwargs: Any,
) -> _T: ...

mocker: Any
class_mocker: Any
module_mocker: Any
package_mocker: Any
session_mocker: Any

def assert_wrapper(__wrapped_mock_method__: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ...
def wrap_assert_not_called(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_called_with(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_called_once(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_called_once_with(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_has_calls(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_any_call(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_called(*args: Any, **kwargs: Any) -> None: ...
def wrap_assert_methods(config: _Config) -> None: ...
def unwrap_assert_methods() -> None: ...
def pytest_addoption(parser) -> None: ...
def parse_ini_boolean(value: Union[bool, str]) -> bool: ...
def pytest_configure(config: _Config) -> None: ...