hishel 0.1.5__py3-none-any.whl → 1.0.0__py3-none-any.whl

hishel/_sync_cache.py

@@ -0,0 +1,213 @@
+from __future__ import annotations
+
+import hashlib
+import logging
+import time
+from dataclasses import replace
+from typing import Iterable, Iterator, Awaitable, Callable
+
+from typing_extensions import assert_never
+
+from hishel import (
+    AnyState,
+    SyncBaseStorage,
+    SyncSqliteStorage,
+    CacheMiss,
+    CouldNotBeStored,
+    FromCache,
+    IdleClient,
+    NeedRevalidation,
+    NeedToBeUpdated,
+    Request,
+    Response,
+    StoreAndUse,
+)
+from hishel._core._spec import InvalidateEntries, vary_headers_match
+from hishel._core.models import Entry, ResponseMetadata
+from hishel._policies import CachePolicy, FilterPolicy, SpecificationPolicy
+from hishel._utils import make_sync_iterator
+
+logger = logging.getLogger("hishel.integrations.clients")
+
+
+class SyncCacheProxy:
+    """
+    A proxy for HTTP caching in clients.
+
+    This class is independent of any specific HTTP library and works only with internal models.
+    It delegates request execution to a user-provided callable, making it compatible with any
+    HTTP client. Caching behavior is determined by the policy object.
+
+    Args:
+        request_sender: Callable that sends HTTP requests and returns responses.
+        storage: Storage backend for cache entries. Defaults to SyncSqliteStorage.
+        policy: Caching policy to use. Can be SpecificationPolicy (respects RFC 9111) or
+            FilterPolicy (user-defined filtering). Defaults to SpecificationPolicy().
+    """
+
+    def __init__(
+        self,
+        request_sender: Callable[[Request], Response],
+        storage: SyncBaseStorage | None = None,
+        policy: CachePolicy | None = None,
+    ) -> None:
+        self.send_request = request_sender
+        self.storage = storage if storage is not None else SyncSqliteStorage()
+        self.policy = policy if policy is not None else SpecificationPolicy()
+
+    def handle_request(self, request: Request) -> Response:
+        if isinstance(self.policy, FilterPolicy):
+            return self._handle_request_with_filters(request)
+        return self._handle_request_respecting_spec(request)
+
+    def _get_key_for_request(self, request: Request) -> str:
+        if self.policy.use_body_key or request.metadata.get("hishel_body_key"):
+            assert isinstance(request.stream, (Iterator, Iterable))
+            collected = b"".join([chunk for chunk in request.stream])
+            hash_ = hashlib.sha256(collected).hexdigest()
+            request.stream = make_sync_iterator([collected])
+            return hash_
+        return hashlib.sha256(str(request.url).encode("utf-8")).hexdigest()
+
+    def _maybe_refresh_entry_ttl(self, entry: Entry) -> None:
+        if entry.request.metadata.get("hishel_refresh_ttl_on_access"):
+            self.storage.update_entry(
+                entry.id,
+                lambda current_entry: replace(
+                    current_entry,
+                    meta=replace(current_entry.meta, created_at=time.time()),
+                ),
+            )
+
+    def _handle_request_with_filters(self, request: Request) -> Response:
+        assert isinstance(self.policy, FilterPolicy)
+
+        for request_filter in self.policy.request_filters:
+            if request_filter.needs_body():
+                body = request.read()
+                if not request_filter.apply(request, body):
+                    logger.debug("Request filtered out by request filter")
+                    return self.send_request(request)
+            else:
+                if not request_filter.apply(request, None):
+                    logger.debug("Request filtered out by request filter")
+                    return self.send_request(request)
+
+        logger.debug("Trying to get cached response ignoring specification")
+        cache_key = self._get_key_for_request(request)
+        entries = self.storage.get_entries(cache_key)
+
+        logger.debug(f"Found {len(entries)} cached entries for the request")
+
+        for entry in entries:
+            if (
+                str(entry.request.url) == str(request.url)
+                and entry.request.method == request.method
+                and vary_headers_match(
+                    request,
+                    entry,
+                )
+            ):
+                logger.debug(
+                    "Found matching cached response for the request",
+                )
+                response_meta = ResponseMetadata(
+                    hishel_from_cache=True,
+                    hishel_created_at=entry.meta.created_at,
+                    hishel_revalidated=False,
+                    hishel_stored=False,
+                )
+                entry.response.metadata.update(response_meta)  # type: ignore
+                self._maybe_refresh_entry_ttl(entry)
+                return entry.response
+
+        response = self.send_request(request)
+        for response_filter in self.policy.response_filters:
+            if response_filter.needs_body():
+                body = response.read()
+                if not response_filter.apply(response, body):
+                    logger.debug("Response filtered out by response filter")
+                    return response
+            else:
+                if not response_filter.apply(response, None):
+                    logger.debug("Response filtered out by response filter")
+                    return response
+        response_meta = ResponseMetadata(
+            hishel_from_cache=False,
+            hishel_created_at=time.time(),
+            hishel_revalidated=False,
+            hishel_stored=True,
+        )
+        response.metadata.update(response_meta)  # type: ignore
+
+        logger.debug("Storing response in cache ignoring specification")
+        entry = self.storage.create_entry(
+            request,
+            response,
+            cache_key,
+        )
+        return entry.response
+
+    def _handle_request_respecting_spec(self, request: Request) -> Response:
+        assert isinstance(self.policy, SpecificationPolicy)
+        state: AnyState = IdleClient(options=self.policy.cache_options)
+
+        while state:
+            logger.debug(f"Handling state: {state.__class__.__name__}")
+            if isinstance(state, IdleClient):
+                state = self._handle_idle_state(state, request)
+            elif isinstance(state, CacheMiss):
+                state = self._handle_cache_miss(state)
+            elif isinstance(state, StoreAndUse):
+                return self._handle_store_and_use(state, request)
+            elif isinstance(state, CouldNotBeStored):
+                return state.response
+            elif isinstance(state, NeedRevalidation):
+                state = self._handle_revalidation(state)
+            elif isinstance(state, FromCache):
+                self._maybe_refresh_entry_ttl(state.entry)
+                return state.entry.response
+            elif isinstance(state, NeedToBeUpdated):
+                state = self._handle_update(state)
+            elif isinstance(state, InvalidateEntries):
+                state = self._handle_invalidate_entries(state)
+            else:
+                assert_never(state)
+
+        raise RuntimeError("Unreachable")
+
+    def _handle_idle_state(self, state: IdleClient, request: Request) -> AnyState:
+        stored_entries = self.storage.get_entries(self._get_key_for_request(request))
+        return state.next(request, stored_entries)
+
+    def _handle_cache_miss(self, state: CacheMiss) -> AnyState:
+        response = self.send_request(state.request)
+        return state.next(response)
+
+    def _handle_store_and_use(self, state: StoreAndUse, request: Request) -> Response:
+        entry = self.storage.create_entry(
+            request,
+            state.response,
+            self._get_key_for_request(request),
+        )
+        return entry.response
+
+    def _handle_revalidation(self, state: NeedRevalidation) -> AnyState:
+        revalidation_response = self.send_request(state.request)
+        return state.next(revalidation_response)
+
+    def _handle_update(self, state: NeedToBeUpdated) -> AnyState:
+        for entry in state.updating_entries:
+            self.storage.update_entry(
+                entry.id,
+                lambda entry: replace(
+                    entry,
+                    response=replace(entry.response, headers=entry.response.headers),
+                ),
+            )
+        return state.next()
+
+    def _handle_invalidate_entries(self, state: InvalidateEntries) -> AnyState:
+        for entry_id in state.entry_ids:
+            self.storage.remove_entry(entry_id)
+        return state.next()

hishel/_sync_httpx.py

@@ -0,0 +1,236 @@
+from __future__ import annotations
+
+import ssl
+import typing as t
+from typing import (
+    Iterable,
+    Iterator,
+    Iterator,
+    Union,
+    cast,
+    overload,
+)
+
+from httpx import RequestNotRead
+
+from hishel import SyncCacheProxy, Headers, Request, Response
+from hishel._core._storages._sync_base import SyncBaseStorage
+from hishel._core.models import RequestMetadata, extract_metadata_from_headers
+from hishel._policies import CachePolicy
+from hishel._utils import (
+    filter_mapping,
+    make_sync_iterator,
+)
+
+try:
+    import httpx
+except ImportError as e:
+    raise ImportError(
+        "httpx is required to use hishel.httpx module. "
+        "Please install hishel with the 'httpx' extra, "
+        "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
+
+
+@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._iter_stream()),
+            extensions=value.metadata,
+        )
+    elif isinstance(value, Response):
+        return httpx.Response(
+            status_code=value.status_code,
+            headers=value.headers,
+            stream=_IteratorStream(value._iter_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.
+    """
+    headers = Headers(
+        filter_mapping(
+            Headers({key: value for key, value in value.headers.items()}),
+            ["Transfer-Encoding"],
+        )
+    )
+    if isinstance(value, httpx.Request):
+        extension_metadata = RequestMetadata(
+            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"),
+            hishel_body_key=value.extensions.get("hishel_body_key"),
+        )
+        headers_metadata = extract_metadata_from_headers(value.headers)
+
+        for key, val in extension_metadata.items():
+            if key in value.extensions:
+                headers_metadata[key] = val  # type: ignore
+
+        try:
+            stream = make_sync_iterator([value.content])
+        except RequestNotRead:
+            stream = cast(Iterator[bytes], value.stream)
+
+        return Request(
+            method=value.method,
+            url=str(value.url),
+            headers=headers,
+            stream=stream,
+            metadata=headers_metadata,
+        )
+    elif isinstance(value, httpx.Response):
+        if value.is_stream_consumed and "content-encoding" in value.headers:
+            raise RuntimeError("Can't get the raw stream of a response with `Content-Encoding` header.")
+        stream = (
+            make_sync_iterator([value.content]) if value.is_stream_consumed else value.iter_raw(chunk_size=CHUNK_SIZE)
+        )
+
+        return Response(
+            status_code=value.status_code,
+            headers=headers,
+            stream=stream,
+            metadata={},
+        )
+
+
+class _IteratorStream(httpx.SyncByteStream, httpx.AsyncByteStream):
+    def __init__(self, iterator: Iterator[bytes] | Iterator[bytes]) -> None:
+        self.iterator = iterator
+
+    def __iter__(self) -> Iterator[bytes]:
+        assert isinstance(self.iterator, (Iterator, Iterable))
+        for chunk in self.iterator:
+            yield chunk
+
+
+class SyncCacheTransport(httpx.BaseTransport):
+    def __init__(
+        self,
+        next_transport: httpx.BaseTransport,
+        storage: SyncBaseStorage | None = None,
+        policy: CachePolicy | None = None,
+    ) -> None:
+        self.next_transport = next_transport
+        self._cache_proxy: SyncCacheProxy = SyncCacheProxy(
+            request_sender=self.request_sender,
+            storage=storage,
+            policy=policy,
+        )
+        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 request_sender(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):
+    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
+        self.storage: SyncBaseStorage | None = kwargs.pop("storage", None)
+        self.policy: CachePolicy | None = kwargs.pop("policy", 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,
+            policy=self.policy,
+        )
+
+    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,
+            policy=self.policy,
+        )