Skip to content

Commit

Permalink
Merge pull request #178 from OldSneerJaw/response-args-type-hints
Browse files Browse the repository at this point in the history
  • Loading branch information
@jamielennox
jamielennox committed Jun 9, 2021
2 parents 7d2eb83 + 4ffdc24 commit 2d8be9e
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 23 deletions.
20 changes: 17 additions & 3 deletions requests_mock/adapter.pyi
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Stubs for requests_mock.adapter

from http.cookiejar import CookieJar
from io import IOBase
from typing import Any, Callable, Dict, List, NewType, Optional, Pattern, Union

from requests.adapters import BaseAdapter
from requests.packages.urllib3.response import HTTPResponse

from requests_mock.response import _Context
from requests_mock import _RequestObjectProxy
from typing import Any, Callable, Dict, List, NewType, Optional, Pattern, Union

AnyMatcher = NewType("AnyMatcher", object)

Expand Down Expand Up @@ -33,11 +39,19 @@ class Adapter(BaseAdapter, _RequestHistoryTracker):
method: Union[str, AnyMatcher],
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any
) -> Any: ...
Expand Down
118 changes: 98 additions & 20 deletions requests_mock/mocker.pyi
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Stubs for requests_mock.mocker

from requests_mock.adapter import AnyMatcher
from http.cookiejar import CookieJar
from io import IOBase
from typing import Any, Callable, Dict, List, Optional, Pattern, Type, TypeVar, Union

from requests import Response
from requests.packages.urllib3.response import HTTPResponse

from requests_mock.adapter import AnyMatcher
from requests_mock.request import _RequestObjectProxy
from typing import Any, Callable, Dict, List, Optional, Pattern, Type, TypeVar, Union
from requests_mock.response import _Context

DELETE: str
GET: str
Expand Down Expand Up @@ -34,100 +40,172 @@ class MockerCore:
method: Union[str, AnyMatcher],
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def request(
self,
method: Union[str, AnyMatcher],
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def get(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def head(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def options(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def post(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def put(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def patch(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...
def delete(
self,
url: Union[str, Pattern[str], AnyMatcher],
response_list: Optional[List[Dict[str, Any]]] = ...,
*,
request_headers: Dict[str, str] = ...,
complete_qs: bool = ...,
status_code: int = ...,
text: str = ...,
headers: Optional[Dict[str, str]] = ...,
reason: str = ...,
headers: Dict[str, str] = ...,
cookies: Union[CookieJar, Dict[str, str]] = ...,
json: Union[Any, Callable[[_RequestObjectProxy, _Context], Any]] = ...,
text: Union[str, Callable[[_RequestObjectProxy, _Context], str]] = ...,
content: Union[bytes, Callable[[_RequestObjectProxy, _Context], bytes]] = ...,
body: Union[IOBase, Callable[[_RequestObjectProxy, _Context], IOBase]] = ...,
raw: HTTPResponse = ...,
exc: Exception = ...,
additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
**kwargs: Any) -> Response: ...

Expand Down

0 comments on commit 2d8be9e

Please sign in to comment.