Document the fact that add_exception can receive BaseException derived exception

Author: Colin-b

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - URL with more than one value for the same parameter were not matched properly (matching was performed on the first value).
+- `httpx_mock.add_exception` is now properly documented (accepts `BaseException` instead of `Exception`).
 
 ## [0.35.0] - 2024-11-28
 ### Changed

tests/test_httpx_async.py

@@ -726,10 +726,10 @@ def instant_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_async_callback_with_pattern_in_url(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json={"url": str(request.url)})
 
-    def custom_response2(request: httpx.Request) -> httpx.Response:
+    async def custom_response2(request: httpx.Request) -> httpx.Response:
         return httpx.Response(
             status_code=200,
             extensions={"http_version": b"HTTP/2.0"},
@@ -1055,17 +1055,19 @@ async def test_request_exception_raising(httpx_mock: HTTPXMock) -> None:
 @pytest.mark.parametrize(
     ("exception_type", "message"),
     [
+        # httpx exception without request context
         pytest.param(
             httpx.HTTPError, "Unable to read within 5.0", id="non_request_exception"
         ),
+        # BaseException derived exception
         pytest.param(
             asyncio.CancelledError,
             "Request was cancelled",
             id="cancelled_exception",
         ),
     ],
 )
-async def test_exception_raising(
+async def test_non_request_exception_raising(
     httpx_mock: HTTPXMock, exception_type: type, message: str
 ) -> None:
     httpx_mock.add_exception(exception_type(message), url="https://test_url")
@@ -1091,7 +1093,7 @@ def custom_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_async_callback_returning_response(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json={"url": str(request.url)})
 
     httpx_mock.add_callback(custom_response, url="https://test_url")
@@ -1121,7 +1123,7 @@ def custom_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_async_callback_executed_twice(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json=["content"])
 
     httpx_mock.add_callback(custom_response, is_reusable=True)
@@ -1161,7 +1163,7 @@ def custom_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_async_callback_registered_after_response(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json=["content2"])
 
     httpx_mock.add_response(json=["content1"])
@@ -1207,7 +1209,7 @@ def custom_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_response_registered_after_async_callback(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json=["content1"])
 
     httpx_mock.add_callback(custom_response)
@@ -1247,7 +1249,7 @@ def custom_response(request: httpx.Request) -> httpx.Response:
 
 @pytest.mark.asyncio
 async def test_async_callback_matching_method(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json=["content"])
 
     httpx_mock.add_callback(custom_response, method="GET", is_reusable=True)
@@ -2210,7 +2212,7 @@ async def test_elapsed_when_add_callback(httpx_mock: HTTPXMock) -> None:
 
 @pytest.mark.asyncio
 async def test_elapsed_when_add_async_callback(httpx_mock: HTTPXMock) -> None:
-    def custom_response(request: httpx.Request) -> httpx.Response:
+    async def custom_response(request: httpx.Request) -> httpx.Response:
         return httpx.Response(status_code=200, json={"foo": "bar"})
 
     httpx_mock.add_callback(custom_response)