Merge pull request #173 from OldSneerJaw/mocker-type-stub

Author: jamielennox

requests_mock/adapter.pyi

@@ -2,9 +2,11 @@
 
 from requests.adapters import BaseAdapter
 from requests_mock import _RequestObjectProxy
-from typing import Any, List, Optional
+from typing import Any, Callable, Dict, List, NewType, Optional, Pattern, Union
 
-ANY: object = ...
+AnyMatcher = NewType("AnyMatcher", object)
+
+ANY: AnyMatcher = ...
 
 class _RequestHistoryTracker:
     request_history: List[_RequestObjectProxy] = ...
@@ -26,5 +28,17 @@ class _Matcher(_RequestHistoryTracker):
 
 class Adapter(BaseAdapter, _RequestHistoryTracker):
     def __init__(self, case_sensitive: bool = ...) -> None: ...
-    def register_uri(self, method: Any, url: Any, response_list: Optional[Any] = ..., **kwargs: Any) -> Any: ...
+    def register_uri(
+        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]] = ...,
+        additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
+        **kwargs: Any
+    ) -> Any: ...
     def add_matcher(self, matcher: Any) -> None: ...

requests_mock/mocker.pyi

@@ -1,5 +1,6 @@
 # Stubs for requests_mock.mocker
 
+from requests_mock.adapter import AnyMatcher
 from requests import Response
 from requests_mock.request import _RequestObjectProxy
 from typing import Any, Callable, Dict, List, Optional, Pattern, Type, TypeVar, Union
@@ -30,71 +31,100 @@ class MockerCore:
     def call_count(self) -> int: ...
     def register_uri(
       self,
-      method: str,
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def request(
       self,
-      method: str,
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def get(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def head(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def options(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def post(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def put(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def patch(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,
       additional_matcher: Optional[Callable[[_RequestObjectProxy], bool]] = ...,
       **kwargs: Any) -> Response: ...
     def delete(
       self,
-      path: Union[str, Pattern[str]],
+      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]] = ...,