hishel 1.0.0.dev2__py3-none-any.whl → 1.1.0__py3-none-any.whl

hishel/httpx.py

@@ -1,20 +1,5 @@
-from __future__ import annotations
-
-import ssl
-import typing as t
-from typing import AsyncIterator, Iterable, Iterator, Union, overload
-
-from hishel import Headers, Request, Response
-from hishel._async_cache import AsyncCacheProxy
-from hishel._core._base._storages._base import AsyncBaseStorage, SyncBaseStorage
-from hishel._core._spec import (
-    CacheOptions,
-)
-from hishel._core.models import AnyIterable
-from hishel._sync_cache import SyncCacheProxy
-
 try:
-    import httpx
+    import httpx  # noqa: F401
 except ImportError as e:
     raise ImportError(
         "httpx is required to use hishel.httpx module. "
@@ -22,314 +7,6 @@ except ImportError as e:
         "e.g., 'pip install hishel[httpx]'."
     ) from e
 
-SOCKET_OPTION = t.Union[
-    t.Tuple[int, int, int],
-    t.Tuple[int, int, t.Union[bytes, bytearray]],
-    t.Tuple[int, int, None, int],
-]
-
-# 128 KB
-CHUNK_SIZE = 131072
-
-
-class IteratorStream(httpx.SyncByteStream, httpx.AsyncByteStream):
-    def __init__(self, iterator: Iterator[bytes] | AsyncIterator[bytes]) -> None:
-        self.iterator = iterator
-
-    def __iter__(self) -> Iterator[bytes]:
-        assert isinstance(self.iterator, (Iterator))
-        yield from self.iterator
-
-    async def __aiter__(self) -> AsyncIterator[bytes]:
-        assert isinstance(self.iterator, (AsyncIterator))
-        async for chunk in self.iterator:
-            yield chunk
-
-
-@overload
-def internal_to_httpx(
-    value: Request,
-) -> httpx.Request: ...
-@overload
-def internal_to_httpx(
-    value: Response,
-) -> httpx.Response: ...
-def internal_to_httpx(
-    value: Union[Request, Response],
-) -> Union[httpx.Request, httpx.Response]:
-    """
-    Convert internal Request/Response to httpx.Request/httpx.Response.
-    """
-    if isinstance(value, Request):
-        return httpx.Request(
-            method=value.method,
-            url=value.url,
-            headers=value.headers,
-            stream=IteratorStream(value.stream),
-            extensions=value.metadata,
-        )
-    elif isinstance(value, Response):
-        return httpx.Response(
-            status_code=value.status_code,
-            headers=value.headers,
-            stream=IteratorStream(value.stream),
-            extensions=value.metadata,
-        )
-
-
-@overload
-def httpx_to_internal(
-    value: httpx.Request,
-) -> Request: ...
-@overload
-def httpx_to_internal(
-    value: httpx.Response,
-) -> Response: ...
-def httpx_to_internal(
-    value: Union[httpx.Request, httpx.Response],
-) -> Union[Request, Response]:
-    """
-    Convert httpx.Request/httpx.Response to internal Request/Response.
-    """
-    stream: Union[Iterator[bytes], AsyncIterator[bytes]]
-    try:
-        stream = AnyIterable(value.content)
-    except (httpx.RequestNotRead, httpx.ResponseNotRead):
-        if isinstance(value, httpx.Response):
-            stream = (
-                value.iter_raw(chunk_size=CHUNK_SIZE)
-                if isinstance(value.stream, Iterable)
-                else value.aiter_raw(chunk_size=CHUNK_SIZE)
-            )
-        else:
-            stream = value.stream  # type: ignore
-    if isinstance(value, httpx.Request):
-        return Request(
-            method=value.method,
-            url=str(value.url),
-            headers=Headers({key: value for key, value in value.headers.items()}),
-            stream=stream,
-            metadata={
-                "hishel_refresh_ttl_on_access": value.extensions.get("hishel_refresh_ttl_on_access"),
-                "hishel_ttl": value.extensions.get("hishel_ttl"),
-                "hishel_spec_ignore": value.extensions.get("hishel_spec_ignore"),
-            },
-        )
-    elif isinstance(value, httpx.Response):
-        return Response(
-            status_code=value.status_code,
-            headers=Headers({key: value for key, value in value.headers.items()}),
-            stream=stream,
-            metadata={},
-        )
-
-
-class SyncCacheTransport(httpx.BaseTransport):
-    def __init__(
-        self,
-        next_transport: httpx.BaseTransport,
-        storage: SyncBaseStorage | None = None,
-        cache_options: CacheOptions | None = None,
-        ignore_specification: bool = False,
-    ) -> None:
-        self.next_transport = next_transport
-        self._cache_proxy: SyncCacheProxy = SyncCacheProxy(
-            send_request=self.sync_send_request,
-            storage=storage,
-            cache_options=cache_options,
-            ignore_specification=ignore_specification,
-        )
-        self.storage = self._cache_proxy.storage
-
-    def handle_request(
-        self,
-        request: httpx.Request,
-    ) -> httpx.Response:
-        internal_request = httpx_to_internal(request)
-        internal_response = self._cache_proxy.handle_request(internal_request)
-        response = internal_to_httpx(internal_response)
-        return response
-
-    def close(self) -> None:
-        self.next_transport.close()
-        self.storage.close()
-        super().close()
-
-    def sync_send_request(self, request: Request) -> Response:
-        httpx_request = internal_to_httpx(request)
-        httpx_response = self.next_transport.handle_request(httpx_request)
-        return httpx_to_internal(httpx_response)
-
-
-class SyncCacheClient(httpx.Client):
-    @overload
-    def __init__(
-        self,
-        *,
-        storage: SyncBaseStorage | None = None,
-        cache_options: CacheOptions | None = None,
-        **kwargs: t.Any,
-    ) -> None: ...
-    @overload
-    def __init__(
-        self,
-        *args: t.Any,
-        **kwargs: t.Any,
-    ) -> None: ...
-    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
-        self.storage: SyncBaseStorage | None = kwargs.pop("storage", None)
-        self.cache_options: CacheOptions | None = kwargs.pop("cache_options", None)
-        super().__init__(*args, **kwargs)
-
-    def _init_transport(
-        self,
-        verify: ssl.SSLContext | str | bool = True,
-        cert: t.Union[str, t.Tuple[str, str], t.Tuple[str, str, str], None] = None,
-        trust_env: bool = True,
-        http1: bool = True,
-        http2: bool = False,
-        limits: httpx.Limits = httpx.Limits(max_connections=100, max_keepalive_connections=20),
-        transport: httpx.BaseTransport | None = None,
-        **kwargs: t.Any,
-    ) -> httpx.BaseTransport:
-        if transport is not None:
-            return transport
-
-        return SyncCacheTransport(
-            next_transport=httpx.HTTPTransport(
-                verify=verify,
-                cert=cert,
-                trust_env=trust_env,
-                http1=http1,
-                http2=http2,
-                limits=limits,
-            ),
-            storage=self.storage,
-            cache_options=self.cache_options,
-            ignore_specification=False,
-        )
-
-    def _init_proxy_transport(
-        self,
-        proxy: httpx.Proxy,
-        verify: ssl.SSLContext | str | bool = True,
-        cert: t.Union[str, t.Tuple[str, str], t.Tuple[str, str, str], None] = None,
-        trust_env: bool = True,
-        http1: bool = True,
-        http2: bool = False,
-        limits: httpx.Limits = httpx.Limits(max_connections=100, max_keepalive_connections=20),
-        **kwargs: t.Any,
-    ) -> httpx.BaseTransport:
-        return SyncCacheTransport(
-            next_transport=httpx.HTTPTransport(
-                verify=verify,
-                cert=cert,
-                trust_env=trust_env,
-                http1=http1,
-                http2=http2,
-                limits=limits,
-                proxy=proxy,
-            ),
-            storage=self.storage,
-            cache_options=self.cache_options,
-            ignore_specification=False,
-        )
-
-
-class AsyncCacheTransport(httpx.AsyncBaseTransport):
-    def __init__(
-        self,
-        next_transport: httpx.AsyncBaseTransport,
-        storage: AsyncBaseStorage | None = None,
-        cache_options: CacheOptions | None = None,
-        ignore_specification: bool = False,
-    ) -> None:
-        self.next_transport = next_transport
-        self._cache_proxy: AsyncCacheProxy = AsyncCacheProxy(
-            send_request=self.async_send_request,
-            storage=storage,
-            cache_options=cache_options,
-            ignore_specification=ignore_specification,
-        )
-        self.storage = self._cache_proxy.storage
-
-    async def handle_async_request(
-        self,
-        request: httpx.Request,
-    ) -> httpx.Response:
-        internal_request = httpx_to_internal(request)
-        internal_response = await self._cache_proxy.handle_request(internal_request)
-        response = internal_to_httpx(internal_response)
-        return response
-
-    async def aclose(self) -> None:
-        await self.next_transport.aclose()
-        await self.storage.close()
-        await super().aclose()
-
-    async def async_send_request(self, request: Request) -> Response:
-        httpx_request = internal_to_httpx(request)
-        httpx_response = await self.next_transport.handle_async_request(httpx_request)
-        return httpx_to_internal(httpx_response)
-
-
-class AsyncCacheClient(httpx.AsyncClient):
-    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
-        self.storage: AsyncBaseStorage | None = kwargs.pop("storage", None)
-        self.cache_options: CacheOptions | None = kwargs.pop("cache_options", None)
-        self.ignore_specification: bool = kwargs.pop("ignore_specification", False)
-        super().__init__(*args, **kwargs)
-
-    def _init_transport(
-        self,
-        verify: ssl.SSLContext | str | bool = True,
-        cert: t.Union[str, t.Tuple[str, str], t.Tuple[str, str, str], None] = None,
-        trust_env: bool = True,
-        http1: bool = True,
-        http2: bool = False,
-        limits: httpx.Limits = httpx.Limits(max_connections=100, max_keepalive_connections=20),
-        transport: httpx.AsyncBaseTransport | None = None,
-        **kwargs: t.Any,
-    ) -> httpx.AsyncBaseTransport:
-        if transport is not None:
-            return transport
-
-        return AsyncCacheTransport(
-            next_transport=httpx.AsyncHTTPTransport(
-                verify=verify,
-                cert=cert,
-                trust_env=trust_env,
-                http1=http1,
-                http2=http2,
-                limits=limits,
-            ),
-            storage=self.storage,
-            cache_options=self.cache_options,
-            ignore_specification=False,
-        )
 
-    def _init_proxy_transport(
-        self,
-        proxy: httpx.Proxy,
-        verify: ssl.SSLContext | str | bool = True,
-        cert: t.Union[str, t.Tuple[str, str], t.Tuple[str, str, str], None] = None,
-        trust_env: bool = True,
-        http1: bool = True,
-        http2: bool = False,
-        limits: httpx.Limits = httpx.Limits(max_connections=100, max_keepalive_connections=20),
-        **kwargs: t.Any,
-    ) -> httpx.AsyncBaseTransport:
-        return AsyncCacheTransport(
-            next_transport=httpx.AsyncHTTPTransport(
-                verify=verify,
-                cert=cert,
-                trust_env=trust_env,
-                http1=http1,
-                http2=http2,
-                limits=limits,
-                proxy=proxy,
-            ),
-            storage=self.storage,
-            cache_options=self.cache_options,
-            ignore_specification=self.ignore_specification,
-        )
+from ._async_httpx import AsyncCacheClient as AsyncCacheClient, AsyncCacheTransport as AsyncCacheTransport
+from ._sync_httpx import SyncCacheClient as SyncCacheClient, SyncCacheTransport as SyncCacheTransport

hishel/requests.py

@@ -6,9 +6,9 @@ from typing import Any, Iterator, Mapping, Optional, overload
 from typing_extensions import assert_never
 
 from hishel import Headers, Request, Response as Response
-from hishel._core._base._storages._base import SyncBaseStorage
-from hishel._core._spec import CacheOptions
+from hishel._core._storages._sync_base import SyncBaseStorage
 from hishel._core.models import extract_metadata_from_headers
+from hishel._policies import CachePolicy
 from hishel._sync_cache import SyncCacheProxy
 from hishel._utils import snake_to_header
 
@@ -27,7 +27,7 @@ except ImportError:  # pragma: no cover
 CHUNK_SIZE = 131072
 
 
-class IteratorStream(RawIOBase):
+class _IteratorStream(RawIOBase):
     def __init__(self, iterator: Iterator[bytes]):
         self.iterator = iterator
         self.leftover = b""
@@ -61,18 +61,18 @@ class IteratorStream(RawIOBase):
 
 
 @overload
-def requests_to_internal(
+def _requests_to_internal(
     model: requests.models.PreparedRequest,
 ) -> Request: ...
 
 
 @overload
-def requests_to_internal(
+def _requests_to_internal(
     model: requests.models.Response,
 ) -> Response: ...
 
 
-def requests_to_internal(
+def _requests_to_internal(
     model: requests.models.PreparedRequest | requests.models.Response,
 ) -> Request | Response:
     if isinstance(model, requests.models.PreparedRequest):
@@ -108,19 +108,24 @@ def requests_to_internal(
 
 
 @overload
-def internal_to_requests(model: Request) -> requests.models.PreparedRequest: ...
+def _internal_to_requests(model: Request) -> requests.models.PreparedRequest: ...
 @overload
-def internal_to_requests(model: Response) -> requests.models.Response: ...
-def internal_to_requests(model: Request | Response) -> requests.models.Response | requests.models.PreparedRequest:
+def _internal_to_requests(model: Response) -> requests.models.Response: ...
+def _internal_to_requests(
+    model: Request | Response,
+) -> requests.models.Response | requests.models.PreparedRequest:
     if isinstance(model, Response):
         response = requests.models.Response()
 
         assert isinstance(model.stream, Iterator)
-        stream = IteratorStream(model.stream)
+        stream = _IteratorStream(model.stream)
 
         urllib_response = HTTPResponse(
             body=stream,
-            headers={**model.headers, **{snake_to_header(k): str(v) for k, v in model.metadata.items()}},
+            headers={
+                **model.headers,
+                **{snake_to_header(k): str(v) for k, v in model.metadata.items()},
+            },
             status=model.status_code,
             preload_content=False,
             decode_content=False,
@@ -158,15 +163,13 @@ class CacheAdapter(HTTPAdapter):
         max_retries: int = 0,
         pool_block: bool = False,
         storage: SyncBaseStorage | None = None,
-        cache_options: CacheOptions | None = None,
-        ignore_specification: bool = False,
+        policy: CachePolicy | None = None,
     ):
         super().__init__(pool_connections, pool_maxsize, max_retries, pool_block)
         self._cache_proxy = SyncCacheProxy(
-            send_request=self.send_request,
+            request_sender=self._send_request,
             storage=storage,
-            cache_options=cache_options,
-            ignore_specification=ignore_specification,
+            policy=policy,
         )
         self.storage = self._cache_proxy.storage
 
@@ -179,9 +182,9 @@ class CacheAdapter(HTTPAdapter):
         cert: None | bytes | str | tuple[bytes | str, bytes | str] = None,
         proxies: Mapping[str, str] | None = None,
     ) -> requests.models.Response:
-        internal_request = requests_to_internal(request)
+        internal_request = _requests_to_internal(request)
         internal_response = self._cache_proxy.handle_request(internal_request)
-        response = internal_to_requests(internal_response)
+        response = _internal_to_requests(internal_response)
 
         # Set the original request on the response
         response.request = request
@@ -189,10 +192,13 @@ class CacheAdapter(HTTPAdapter):
 
         return response
 
-    def send_request(self, request: Request) -> Response:
-        requests_request = internal_to_requests(request)
-        response = super().send(requests_request, stream=True)
-        return requests_to_internal(response)
+    def _send_request(self, request: Request) -> Response:
+        requests_request = _internal_to_requests(request)
+        response = super().send(
+            requests_request,
+            stream=True,
+        )
+        return _requests_to_internal(response)
 
     def close(self) -> Any:
         self.storage.close()