pyreqwest 0.5.1__cp314-cp314-macosx_10_12_x86_64.whl → 0.6.0__cp314-cp314-macosx_10_12_x86_64.whl

pyreqwest/compatibility/__init__.py

@@ -0,0 +1,4 @@
+"""Compatibility layers for different HTTP client libraries.
+
+See individual modules for details.
+"""

pyreqwest/compatibility/httpx/__init__.py

@@ -0,0 +1,11 @@
+"""httpx compatibility layer"""
+
+try:
+    import httpx  # noqa: F401
+except ImportError as e:
+    err = "httpx is not installed. Please install httpx to use the httpx compatibility layer."
+    raise ImportError(err) from e
+
+from .transport import HttpxTransport, SyncHttpxTransport
+
+__all__ = ["HttpxTransport", "SyncHttpxTransport"]

pyreqwest/compatibility/httpx/_internal.py

@@ -0,0 +1,60 @@
+from datetime import timedelta
+from typing import TypeVar
+
+import httpx
+
+from pyreqwest import exceptions
+from pyreqwest.exceptions import PyreqwestError
+from pyreqwest.request import BaseRequestBuilder
+from pyreqwest.response import BaseResponse
+
+T = TypeVar("T", bound=BaseRequestBuilder)
+
+EXCEPTION_MAPPING: dict[type[PyreqwestError], type[httpx.RequestError]] = {
+    exceptions.ConnectTimeoutError: httpx.ConnectTimeout,
+    exceptions.ReadTimeoutError: httpx.ReadTimeout,
+    exceptions.WriteTimeoutError: httpx.WriteTimeout,
+    exceptions.PoolTimeoutError: httpx.PoolTimeout,
+    exceptions.RequestTimeoutError: httpx.TimeoutException,
+    exceptions.ConnectError: httpx.ConnectError,
+    exceptions.ReadError: httpx.ReadError,
+    exceptions.WriteError: httpx.WriteError,
+    exceptions.NetworkError: httpx.NetworkError,
+    exceptions.DecodeError: httpx.DecodingError,
+    exceptions.RedirectError: httpx.TooManyRedirects,
+}
+
+
+def build_httpx_response(
+    response: BaseResponse, response_stream: httpx.SyncByteStream | httpx.AsyncByteStream | None
+) -> httpx.Response:
+    return httpx.Response(
+        status_code=response.status,
+        headers=list(response.headers.items()),
+        stream=response_stream,
+        extensions={"pyreqwest_response": response},
+    )
+
+
+def map_extensions(builder: T, request: httpx.Request) -> T:
+    if not (ext := request.extensions):
+        return builder
+
+    # Handle timeout
+    # reqwest differs https://docs.rs/reqwest/latest/reqwest/struct.RequestBuilder.html#method.timeout
+    # For more granular control, users should configure the pyreqwest.Client directly.
+    if (timeout := ext.get("timeout")) and isinstance(timeout, dict) and (tot_timeout := sum(timeout.values())) > 0:
+        builder = builder.timeout(timedelta(seconds=tot_timeout))
+
+    return builder.extensions(ext)
+
+
+def map_exception(exc: PyreqwestError, request: httpx.Request) -> httpx.RequestError | None:
+    if exact := EXCEPTION_MAPPING.get(type(exc)):
+        return exact(exc.message, request=request)
+
+    for pyreqwest_exc, httpx_exc in EXCEPTION_MAPPING.items():
+        if isinstance(exc, pyreqwest_exc):
+            return httpx_exc(exc.message, request=request)
+
+    return None

pyreqwest/compatibility/httpx/transport.py

@@ -0,0 +1,154 @@
+"""Compatibility layer for httpx, which allows pyreqwest to replace httpcore transport for httpx."""
+
+from collections.abc import AsyncIterator, Iterator
+from contextlib import AsyncExitStack, ExitStack
+
+import httpx
+
+from pyreqwest.client import Client, ClientBuilder, SyncClient, SyncClientBuilder
+from pyreqwest.exceptions import PyreqwestError
+from pyreqwest.request import RequestBuilder, SyncRequestBuilder
+from pyreqwest.response import Response, SyncResponse
+
+from ._internal import build_httpx_response, map_exception, map_extensions
+
+
+class HttpxTransport(httpx.AsyncBaseTransport):
+    """httpx transport that uses pyreqwest for HTTP requests.
+
+    Example usage:
+    ```python
+    import httpx
+    from pyreqwest.compatibility.httpx import HttpxTransport
+
+    async with httpx.AsyncClient(transport=HttpxTransport()) as httpx_client:
+        print(await httpx_client.get("https://example.com"))
+    ```
+    """
+
+    def __init__(self, client: Client | None = None, *, close_client: bool = True) -> None:
+        """Initialize the HttpxTransport.
+        :param client: An optional pyreqwest Client instance. If not provided, a default Client will be created.
+        :param close_client: Whether to close the provided Client when the transport is closed.
+        """
+        self._client: Client = client or ClientBuilder().build()
+        self._close_client = (client is None) or close_client
+
+    async def aclose(self) -> None:
+        """Close the underlying pyreqwest Client if needed."""
+        if self._close_client:
+            await self._client.close()
+
+    async def handle_async_request(self, request: httpx.Request) -> httpx.Response:
+        """AsyncBaseTransport implementation to handle httpx request using pyreqwest."""
+        req_builder = self._client.request(request.method, str(request.url)).headers(request.headers.multi_items())
+        req_builder = self._map_body(req_builder, request)
+        req_builder = map_extensions(req_builder, request)
+        return await self._map_response(req_builder, request)
+
+    def _map_body(self, builder: RequestBuilder, request: httpx.Request) -> RequestBuilder:
+        try:
+            return builder.body_bytes(request.content)
+        except httpx.RequestNotRead:
+            return builder.body_stream(request.stream)
+
+    async def _map_response(self, builder: RequestBuilder, request: httpx.Request) -> httpx.Response:
+        req_exit_stack = AsyncExitStack()
+        try:
+            response = await req_exit_stack.enter_async_context(builder.build_streamed())
+            return build_httpx_response(response, response_stream=ResponseStream(response, req_exit_stack))
+        except Exception as exc:
+            await req_exit_stack.aclose()
+            if isinstance(exc, PyreqwestError) and (mapped := map_exception(exc, request)):
+                raise mapped from exc
+            raise
+
+
+class SyncHttpxTransport(httpx.BaseTransport):
+    """httpx transport that uses pyreqwest for HTTP requests.
+
+    Example usage:
+    ```python
+    import httpx
+    from pyreqwest.compatibility.httpx import SyncHttpxTransport
+
+    with httpx.Client(transport=SyncHttpxTransport()) as httpx_client:
+        print(httpx_client.get("https://example.com"))
+    ```
+    """
+
+    def __init__(self, client: SyncClient | None = None, *, close_client: bool = True) -> None:
+        """Initialize the SyncHttpxTransport.
+        :param client: An optional pyreqwest SyncClient instance. If not provided, a default SyncClient will be created.
+        :param close_client: Whether to close the provided SyncClient when the transport is closed.
+        """
+        self._client: SyncClient = client or SyncClientBuilder().build()
+        self._close_client = (client is None) or close_client
+
+    def close(self) -> None:
+        """Close the underlying pyreqwest SyncClient if needed."""
+        if self._close_client:
+            self._client.close()
+
+    def handle_request(self, request: httpx.Request) -> httpx.Response:
+        """BaseTransport implementation to handle httpx request using pyreqwest."""
+        req_builder = self._client.request(request.method, str(request.url)).headers(request.headers.multi_items())
+        req_builder = self._map_body(req_builder, request)
+        req_builder = map_extensions(req_builder, request)
+        return self._map_response(req_builder, request)
+
+    def _map_body(self, builder: SyncRequestBuilder, request: httpx.Request) -> SyncRequestBuilder:
+        try:
+            return builder.body_bytes(request.content)
+        except httpx.RequestNotRead:
+            if isinstance(request.stream, httpx.AsyncByteStream):
+                err = "Cannot use async stream in sync transport"
+                raise TypeError(err) from None
+            return builder.body_stream(request.stream)
+
+    def _map_response(self, builder: SyncRequestBuilder, request: httpx.Request) -> httpx.Response:
+        req_exit_stack = ExitStack()
+        try:
+            response = req_exit_stack.enter_context(builder.build_streamed())
+            return build_httpx_response(response, response_stream=SyncResponseStream(response, req_exit_stack))
+        except Exception as exc:
+            req_exit_stack.close()
+            if isinstance(exc, PyreqwestError) and (mapped := map_exception(exc, request)):
+                raise mapped from exc
+            raise
+
+
+class ResponseStream(httpx.AsyncByteStream):
+    """httpx AsyncByteStream that wraps a pyreqwest Response body reader."""
+
+    def __init__(self, response: Response, exit_stack: AsyncExitStack) -> None:
+        """Internally initialized."""
+        self._body_reader = response.body_reader
+        self._exit_stack = exit_stack
+
+    async def __aiter__(self) -> AsyncIterator[bytes]:
+        """Asynchronously iterate over the response body in chunks."""
+        while (chunk := await self._body_reader.read()) is not None:
+            yield bytes(chunk)
+
+    async def aclose(self) -> None:
+        """Close the response stream."""
+        await self._exit_stack.aclose()
+
+
+class SyncResponseStream(httpx.SyncByteStream):
+    """httpx SyncByteStream that wraps a pyreqwest SyncResponse body reader."""
+
+    def __init__(self, response: SyncResponse, exit_stack: ExitStack) -> None:
+        """Internally initialized."""
+        self._body_reader = response.body_reader
+        self._exit_stack = exit_stack
+
+    def __iter__(self) -> Iterator[bytes]:
+        """Iterate over the response body in chunks."""
+        while (chunk := self._body_reader.read()) is not None:
+            yield bytes(chunk)
+
+    def close(self) -> None:
+        """Close the response stream."""
+        self._exit_stack.close()

{pyreqwest-0.5.1.dist-info → pyreqwest-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyreqwest
-Version: 0.5.1
+Version: 0.6.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -32,6 +32,8 @@ Project-URL: Source, https://github.com/MarkusSintonen/pyreqwest
 </p>
 
 ---
+[![codecov](https://codecov.io/github/markussintonen/pyreqwest/graph/badge.svg?token=OET0CMZYOH)](https://codecov.io/github/markussintonen/pyreqwest)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyreqwest)
 
 pyreqwest - Powerful and fast Rust based HTTP client. Built on top of and inspired by [reqwest](https://github.com/seanmonstar/reqwest).
 
@@ -104,3 +106,7 @@ See [docs](https://markussintonen.github.io/pyreqwest/pyreqwest.html)
 
 See [examples](https://github.com/MarkusSintonen/pyreqwest/tree/main/examples)
 
+## Compatibility with other libraries
+
+See [compatibility docs](https://markussintonen.github.io/pyreqwest/pyreqwest/compatibility.html)
+

{pyreqwest-0.5.1.dist-info → pyreqwest-0.6.0.dist-info}/RECORD

@@ -1,15 +1,19 @@
-pyreqwest-0.5.1.dist-info/METADATA,sha256=w1NHKbA5Buar80S3xPfnQ0fyTBVvQ23PmL_dGG1S8Jk,4315
-pyreqwest-0.5.1.dist-info/WHEEL,sha256=0p9RWqZ1tTIS4XVGVX-OqQSPs2Wp470cV_pQ0zUt98A,107
-pyreqwest-0.5.1.dist-info/entry_points.txt,sha256=x6BM9g8m805tw6VqKvSe_Kgd2qp4Eq3moyIoFnETeoE,61
-pyreqwest-0.5.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyreqwest-0.6.0.dist-info/METADATA,sha256=vWepMhQitXcL4ksYIzjgOpIp9OoL-HN8KGiqtIuMxB8,4678
+pyreqwest-0.6.0.dist-info/WHEEL,sha256=0p9RWqZ1tTIS4XVGVX-OqQSPs2Wp470cV_pQ0zUt98A,107
+pyreqwest-0.6.0.dist-info/entry_points.txt,sha256=x6BM9g8m805tw6VqKvSe_Kgd2qp4Eq3moyIoFnETeoE,61
+pyreqwest-0.6.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
 pyreqwest/__init__.py,sha256=AqtJmAtOEQ6kYGY2_Qzw2f_q5K3Q5PN-TpOmIKaeiEM,86
 pyreqwest/__init__.pyi,sha256=Y25n44pyE3vp92MiABKrcK3IWRyQ1JG1rZ4Ufqy2nC0,17
-pyreqwest/_pyreqwest.cpython-314-darwin.so,sha256=xIE_cACifQRc9EwOCOu8ENCKK8OkIN_ztYPj39OG3gU,6721716
+pyreqwest/_pyreqwest.cpython-314-darwin.so,sha256=NXF4_HUhCzKpuZVmHMGVWgt4hZxEwGex2ZASwgE-Dgk,6717524
 pyreqwest/bytes/__init__.py,sha256=uzB8cxWbBizu0kyrdXhmnwWKWdwBcVIv4mgEhCR1LMs,465
 pyreqwest/bytes/__init__.pyi,sha256=bttN8uCg7K3gW90FBgPP4vbtNrBCOwqX4v7LAK-T1pU,4569
 pyreqwest/client/__init__.py,sha256=tPfCyh-HJJEepvGMvLSLjKkZySTKsATsnbJziT_P4IM,369
 pyreqwest/client/__init__.pyi,sha256=y9AfLH2Dhw8UOnnia1hk1qVGjAGW43LGT3dwqZfEVm4,14231
 pyreqwest/client/types.py,sha256=CpfplqBGOyvpZNpwbOqal89dBztZlZTYuX-nM1Qrwrg,1475
+pyreqwest/compatibility/__init__.py,sha256=yJ4VD9iMzvSpYDjM6kEM-F2A_avMFCkOo1g5bgD2AGU,102
+pyreqwest/compatibility/httpx/__init__.py,sha256=Gc0jMCgmpSHkqQha_zAzxXjrbRSvS6KUOnHp4Z0UMDc,334
+pyreqwest/compatibility/httpx/_internal.py,sha256=olu1ES7bV8AHUqtEMEmGHlejQCxAS3BYwl_r0GunAew,2220
+pyreqwest/compatibility/httpx/transport.py,sha256=2wuhREEvpWvcrCZcNv0mH_7MbuqwCO0_b9j7TMxkee8,6672
 pyreqwest/cookie/__init__.py,sha256=whcJaTtVHgqH2n_lvGYXYHP7D9BolDU6SvKjuKpewAs,128
 pyreqwest/cookie/__init__.pyi,sha256=YCOI79evRpc7xmSpY6q1MsQMCHSucGDpLmsk0ZqfXN4,6401
 pyreqwest/exceptions/__init__.py,sha256=LWD8I6hFsw0ogHwpobPVcO5tfFRhRg0rPF2Bs64XjuI,5319
@@ -38,4 +42,4 @@ pyreqwest/request/__init__.pyi,sha256=UB9IMIep6xwCvinv7OD9lNTNYLw-kkxdVMEqvVDRFk
 pyreqwest/response/__init__.py,sha256=u1M-aMKJdS3EQ9NqANnpnZ4S2XeWsM2ncd73Oj7T1_E,373
 pyreqwest/response/__init__.pyi,sha256=8hebHvfuWadg4zi0esEMJikTrXE296DlWHbYGGkLNfQ,5737
 pyreqwest/types.py,sha256=10lGx5uugbo5awMz6nNOcuIsyeG3NIB7DqQHiPbOHLk,643
-pyreqwest-0.5.1.dist-info/RECORD,,
+pyreqwest-0.6.0.dist-info/RECORD,,