Merge pull request Colin-b#30 from Colin-b/develop

Release 0.9.0

Author: Colin-b

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9.0] - 2020-09-22
+### Changed
+- Requires [`httpx`](https://www.python-httpx.org)==0.15.*
+- Callbacks are now called with `ext` dictionary instead of `timeout`. To follow `httpcore` design changes. You can still retrieve timeout by using ```ext['timeout']```
+
 ## [0.8.0] - 2020-08-26
 ### Added
 - `non_mocked_hosts` fixture allowing to avoid mocking requests sent on some specific hosts.
@@ -99,7 +104,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First release, should be considered as unstable for now as design might change.
 
-[Unreleased]: https://github.com/Colin-b/pytest_httpx/compare/v0.8.0...HEAD
+[Unreleased]: https://github.com/Colin-b/pytest_httpx/compare/v0.9.0...HEAD
+[0.9.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.5.0...v0.6.0

README.md

@@ -336,7 +336,7 @@ You can perform custom manipulation upon request reception by registering callba
 
 Callback should expect at least two parameters:
  * request: The received [`httpx.Request`](https://www.python-httpx.org/api/#request).
- * timeout: The [timeouts](https://www.python-httpx.org/advanced/#timeout-configuration) linked to the request.
+ * ext: The extensions (including the [timeouts](https://www.python-httpx.org/advanced/#timeout-configuration)) linked to the request.
 
 If all callbacks are not executed during test execution, the test case will fail at teardown.
 
@@ -352,7 +352,7 @@ def assert_all_responses_were_requested() -> bool:
 
 ### Dynamic responses
 
-Callback should return a httpcore response (as a tuple), you can use `pytest_httpx.to_response` function to create such a tuple.
+Callback should return a `httpcore` response (as a tuple), you can use `pytest_httpx.to_response` function to create such a tuple.
 
 ```python
 import httpx
@@ -386,8 +386,8 @@ from pytest_httpx import HTTPXMock
 
 
 def test_exception_raising(httpx_mock: HTTPXMock):
-    def raise_timeout(request, timeout):
-        raise httpx.ReadTimeout(f"Unable to read within {timeout}", request=request)
+    def raise_timeout(request, ext: dict):
+        raise httpx.ReadTimeout(f"Unable to read within {ext['timeout']}", request=request)
 
     httpx_mock.add_callback(raise_timeout)
 
@@ -422,7 +422,7 @@ You can add criteria so that callback will be sent only in case of a more specif
 
 #### Matching on URL
 
-`url` parameter can either be a string, a python [re.Pattern](https://docs.python.org/3/library/re.html) instance or a [httpx.URL](https://www.python-httpx.org/api/#url) instance.
+`url` parameter can either be a string, a python [`re.Pattern`](https://docs.python.org/3/library/re.html) instance or a [`httpx.URL`](https://www.python-httpx.org/api/#url) instance.
 
 Matching is performed on the full URL, query parameters included.
 
@@ -616,6 +616,7 @@ Below is a list of parameters that will require a change in your code.
 
 Sample adding a response with `aioresponses`:
 ```python
+import pytest
 from aioresponses import aioresponses
 
 

pytest_httpx/_httpx_internals.py

@@ -16,7 +16,7 @@ def stream(
     if files:
         # TODO Get rid of this internal import
         # import is performed at runtime when needed to reduce impact of internal changes in httpx
-        from httpx._content_streams import MultipartStream
+        from httpx._multipart import MultipartStream
 
         return MultipartStream(data=data or {}, files=files, boundary=boundary)
 

pytest_httpx/_httpx_mock.py

@@ -13,7 +13,7 @@
 TimeoutDict = Dict[str, Optional[float]]
 
 Response = Tuple[
-    bytes, int, bytes, Headers, Union[httpcore.SyncByteStream, httpcore.AsyncByteStream]
+    int, Headers, Union[httpcore.SyncByteStream, httpcore.AsyncByteStream], dict
 ]
 
 
@@ -153,7 +153,7 @@ def add_callback(self, callback: Callable, **matchers):
         :param callback: The callable that will be called upon reception of the matched request.
         It must expect at least 2 parameters:
          * request: The received httpx.Request.
-         * timeout: The timeout linked to the request.
+         * ext: The extensions linked to the request (such as timeout).
         It should return a valid httpcore response tuple, you can use pytest_httpx.to_response function to create one.
         :param url: Full URL identifying the request(s) to match.
         Can be a str, a re.Pattern instance or a httpx.URL instance.
@@ -169,7 +169,7 @@ def _handle_request(
         url: URL,
         headers: Headers = None,
         stream: Union[httpcore.SyncByteStream, httpcore.AsyncByteStream] = None,
-        timeout: TimeoutDict = None,
+        ext: dict = None,
     ) -> Response:
         request = to_request(method, url, headers, stream)
         self._requests.append(request)
@@ -180,7 +180,7 @@ def _handle_request(
 
         callback = self._get_callback(request)
         if callback:
-            return callback(request=request, timeout=timeout)
+            return callback(request=request, ext=ext)
 
         raise httpx.TimeoutException(
             self._explain_that_no_response_was_found(request), request=request
@@ -325,17 +325,17 @@ def __init__(self, mock: HTTPXMock):
 
     def request(
         self, *args, **kwargs
-    ) -> Tuple[bytes, int, bytes, List[Tuple[bytes, bytes]], httpcore.SyncByteStream]:
+    ) -> Tuple[int, List[Tuple[bytes, bytes]], httpcore.SyncByteStream, dict]:
         return self.mock._handle_request(*args, **kwargs)
 
 
 class _PytestAsyncTransport(httpcore.AsyncHTTPTransport):
     def __init__(self, mock: HTTPXMock):
         self.mock = mock
 
-    async def request(
+    async def arequest(
         self, *args, **kwargs
-    ) -> Tuple[bytes, int, bytes, List[Tuple[bytes, bytes]], httpcore.AsyncByteStream]:
+    ) -> Tuple[int, List[Tuple[bytes, bytes]], httpcore.AsyncByteStream, dict]:
         return self.mock._handle_request(*args, **kwargs)
 
 
@@ -366,4 +366,4 @@ def to_response(
         else []
     )
     body = stream(data=data, files=files, json=json, boundary=boundary)
-    return http_version.encode(), status_code, b"", headers, body
+    return status_code, headers, body, {"http_version": http_version}

pytest_httpx/version.py

@@ -3,4 +3,4 @@
 # Major should be incremented in case there is a breaking change. (eg: 2.5.8 -> 3.0.0)
 # Minor should be incremented in case there is an enhancement. (eg: 2.5.8 -> 2.6.0)
 # Patch should be incremented in case there is a bug fix. (eg: 2.5.8 -> 2.5.9)
-__version__ = "0.8.0"
+__version__ = "0.9.0"

setup.py

@@ -36,7 +36,7 @@
     keywords=["pytest", "testing", "mock", "httpx"],
     packages=find_packages(exclude=["tests*"]),
     entry_points={"pytest11": ["pytest_httpx = pytest_httpx"]},
-    install_requires=["httpx==0.14.*", "pytest==6.*"],
+    install_requires=["httpx==0.15.*", "pytest==6.*"],
     extras_require={
         "testing": [
             # Used to run async test functions

tests/test_httpx_async.py

@@ -619,14 +619,17 @@ async def test_requests_json_body(httpx_mock: HTTPXMock):
 
 @pytest.mark.asyncio
 async def test_callback_raising_exception(httpx_mock: HTTPXMock):
-    def raise_timeout(request, timeout):
-        raise httpx.ReadTimeout(f"Unable to read within {timeout}", request=request)
+    def raise_timeout(request, ext):
+        raise httpx.ReadTimeout(
+            f"Unable to read within {ext['timeout']['read']}", request=request
+        )
 
     httpx_mock.add_callback(raise_timeout, url="http://test_url")
 
     async with httpx.AsyncClient() as client:
-        with pytest.raises(httpx.ReadTimeout):
+        with pytest.raises(httpx.ReadTimeout) as exception_info:
             await client.get("http://test_url")
+        assert str(exception_info.value) == "Unable to read within 5.0"
 
 
 @pytest.mark.asyncio

tests/test_httpx_sync.py

@@ -578,14 +578,17 @@ def test_requests_json_body(httpx_mock: HTTPXMock):
 
 
 def test_callback_raising_exception(httpx_mock: HTTPXMock):
-    def raise_timeout(request, timeout):
-        raise httpx.ReadTimeout(f"Unable to read within {timeout}", request=request)
+    def raise_timeout(request, ext):
+        raise httpx.ReadTimeout(
+            f"Unable to read within {ext['timeout']['read']}", request=request
+        )
 
     httpx_mock.add_callback(raise_timeout, url="http://test_url")
 
     with httpx.Client() as client:
-        with pytest.raises(httpx.ReadTimeout):
+        with pytest.raises(httpx.ReadTimeout) as exception_info:
             client.get("http://test_url")
+        assert str(exception_info.value) == "Unable to read within 5.0"
 
 
 def test_callback_returning_response(httpx_mock: HTTPXMock):