hishel 1.0.0.dev1__py3-none-any.whl → 1.0.0.dev3__py3-none-any.whl

hishel-1.0.0.dev3.dist-info/RECORD

@@ -0,0 +1,23 @@
+hishel/__init__.py,sha256=HqU6RUrtlvEMTo5i7WbdSJvYoLQiyqkMJVbXrefd6Ww,1566
+hishel/_async_cache.py,sha256=He_wRJYMSy0aLinzlgQ76ohOos15Bbw3N2uu6cLGkZk,7216
+hishel/_async_httpx.py,sha256=e8JO37K6fF4UZlTGeMpsmMJtLLhGfdWQNLIhPahlbkU,7894
+hishel/_sync_cache.py,sha256=zYNrRoOeBUta-GO0yNRs7n-PQ4WglQLEzvbY5N9oZCU,6962
+hishel/_sync_httpx.py,sha256=eQlIwb3RrJNV3CEqs3xGQJByVOO3C_DXK8W5x60HZlQ,7726
+hishel/_utils.py,sha256=kD5ki4PKeYsNBMh3tAjsXggF2-_oeNz6aVlARxyl0H0,3842
+hishel/asgi.py,sha256=mbYFJHQJCRE6w0KcZiSe9qIHHPgRFuCwAwg9haJoMWI,14983
+hishel/fastapi.py,sha256=CVWCyXTxBPwG_XALo-Oldekv4lqMgH2-W-PPZ9rZjXg,10826
+hishel/httpx.py,sha256=99a8X9COPiPHSgGW61O2uMWMZB7dY93Ty9DTCJ9C18Q,467
+hishel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hishel/requests.py,sha256=Bi0_1O2xgFlWqG1g6OR1gpb5MY8CKJmgLPDEG6bhuXM,6533
+hishel/_core/_headers.py,sha256=hGaT6o1F-gs1pm5RpdGb0IMQL3uJYDH1xpwJLy28Cys,17514
+hishel/_core/_spec.py,sha256=yJsOmNU5dMXXBw80ZLnse9Tl4UGkHmiyyfjv1Q0eP9w,103871
+hishel/_core/models.py,sha256=YBXpk5GRWsB8ppksehTaIDJ_V5KAENKspSj-kLvJUPY,5169
+hishel/_core/_storages/_async_base.py,sha256=iZ6Mb30P0ho5h4UU5bgOrcsSMZ1427j9tht-tupZs68,2106
+hishel/_core/_storages/_async_sqlite.py,sha256=QNo5oWnnHAU0rTPJJbE9d6__xG_jWrG3-atoyE2j3q0,15555
+hishel/_core/_storages/_packing.py,sha256=mC8LMFQ5uPfFOgingKm2WKFO_DwcZ1OjTgI6xc0hfJI,3708
+hishel/_core/_storages/_sync_base.py,sha256=qfOvcFY5qvrzSh4ztV2Trlxft-BF7An5SFsLlEb8EeE,2075
+hishel/_core/_storages/_sync_sqlite.py,sha256=A-L6fDU1JvVDzHNzV396V3U3sFPLycrxSnD00DHrTvs,15048
+hishel-1.0.0.dev3.dist-info/METADATA,sha256=CLK-XP376Y4IuDGQgYxzRhJhfoi9Z281HlZccTOVXqE,12884
+hishel-1.0.0.dev3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hishel-1.0.0.dev3.dist-info/licenses/LICENSE,sha256=1qQj7pE0V2O9OIedvyOgLGLvZLaPd3nFEup3IBEOZjQ,1493
+hishel-1.0.0.dev3.dist-info/RECORD,,

hishel/_core/__init__.py

@@ -1,59 +0,0 @@
-from hishel._core._async._storages._sqlite import AsyncSqliteStorage
-from hishel._core._base._storages._base import (
-    AsyncBaseStorage as AsyncBaseStorage,
-    SyncBaseStorage as SyncBaseStorage,
-)
-from hishel._core._headers import Headers as Headers
-from hishel._core._spec import (
-    AnyState as AnyState,
-    CacheMiss as CacheMiss,
-    CacheOptions as CacheOptions,
-    CouldNotBeStored as CouldNotBeStored,
-    FromCache as FromCache,
-    IdleClient as IdleClient,
-    NeedRevalidation as NeedRevalidation,
-    NeedToBeUpdated as NeedToBeUpdated,
-    State as State,
-    StoreAndUse as StoreAndUse,
-    create_idle_state as create_idle_state,
-)
-from hishel._core._sync._storages._sqlite import SyncSqliteStorage
-from hishel._core.models import (
-    CompletePair as CompletePair,
-    IncompletePair as IncompletePair,
-    Pair as Pair,
-    PairMeta as PairMeta,
-    Request as Request,
-    Response,
-)
-
-__all__ = (
-    # New API
-    ## States
-    "AnyState",
-    "IdleClient",
-    "CacheMiss",
-    "FromCache",
-    "NeedRevalidation",
-    "AnyState",
-    "CacheOptions",
-    "NeedToBeUpdated",
-    "State",
-    "StoreAndUse",
-    "CouldNotBeStored",
-    "create_idle_state",
-    ## Models
-    "Request",
-    "Response",
-    "Pair",
-    "IncompletePair",
-    "CompletePair",
-    "PairMeta",
-    ## Headers
-    "Headers",
-    ## Storages
-    "SyncBaseStorage",
-    "AsyncBaseStorage",
-    "SyncSqliteStorage",
-    "AsyncSqliteStorage",
-)

hishel/_core/_base/_storages/_base.py

@@ -1,272 +0,0 @@
-from __future__ import annotations
-
-import abc
-import time
-import typing as tp
-import uuid
-from abc import ABC
-from pathlib import Path
-
-from hishel._core.models import CompletePair, IncompletePair, Request, Response
-
-
-class SyncBaseStorage(ABC):
-    @abc.abstractmethod
-    def create_pair(
-        self,
-        request: Request,
-        id: uuid.UUID | None = None,
-    ) -> IncompletePair:
-        """
-        Store a request in the backend under the given key.
-
-        Args:
-            request: The request object to store.
-
-        Returns:
-            The created IncompletePair object representing the stored request.
-
-        Raises:
-            NotImplementedError: Must be implemented in subclasses.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    def add_response(self, pair_id: uuid.UUID, response: Response, key: str | bytes) -> CompletePair:
-        """
-        Add a response to an existing request pair.
-
-        Args:
-            pair_id: The unique identifier of the request pair.
-            response: The response object to add.
-            key: The cache key associated with the request pair.
-
-        Returns:
-            The updated response object.
-
-        Raises:
-            NotImplementedError: Must be implemented in subclasses.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    def get_pairs(self, key: str) -> tp.List[CompletePair]:
-        """
-        Retrieve all responses associated with a given key.
-
-        Args:
-            key: The unique identifier for the request pairs.
-            complete_only: If True, only return pairs with responses. If False,
-                only return pairs without responses. If None, return all pairs.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    def update_pair(
-        self,
-        id: uuid.UUID,
-        new_pair: tp.Union[CompletePair, tp.Callable[[CompletePair], CompletePair]],
-    ) -> tp.Optional[CompletePair]:
-        """
-        Update an existing request pair.
-
-        Args:
-            id: The unique identifier of the request pair to update.
-            new_pair: The new pair data or a callable that takes the current pair
-                and returns the updated pair.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    def remove(self, id: uuid.UUID) -> None:
-        """
-        Remove a request pair from the storage.
-
-        Args:
-            id: The unique identifier of the request pair to remove.
-        """
-        raise NotImplementedError()
-
-    def close(self) -> None:
-        """
-        Close any resources held by the storage backend.
-        """
-        pass
-
-    def is_soft_deleted(self, pair: IncompletePair | CompletePair) -> bool:
-        """
-        Check if a pair is soft deleted based on its metadata.
-
-        Args:
-            pair: The request pair to check.
-
-        Returns:
-            True if the pair is soft deleted, False otherwise.
-        """
-        return pair.meta.deleted_at is not None and pair.meta.deleted_at > 0
-
-    def is_safe_to_hard_delete(self, pair: IncompletePair | CompletePair) -> bool:
-        """
-        Check if a pair is safe to hard delete based on its metadata.
-
-        If the pair has been soft deleted for more than 1 hour, it is considered safe to hard delete.
-
-        Args:
-            pair: The request pair to check.
-
-        Returns:
-            True if the pair is safe to hard delete, False otherwise.
-        """
-        return bool(pair.meta.deleted_at is not None and (pair.meta.deleted_at + 3600 < time.time()))
-
-    @tp.overload
-    def mark_pair_as_deleted(self, pair: CompletePair) -> CompletePair: ...
-    @tp.overload
-    def mark_pair_as_deleted(self, pair: IncompletePair) -> IncompletePair: ...
-    def mark_pair_as_deleted(self, pair: CompletePair | IncompletePair) -> CompletePair | IncompletePair:
-        """
-        Mark a pair as soft deleted by setting its deleted_at timestamp.
-
-        Args:
-            pair: The request pair to mark as deleted.
-        Returns:
-            The updated request pair with the deleted_at timestamp set.
-        """
-        pair.meta.deleted_at = time.time()
-        return pair
-
-
-class AsyncBaseStorage(ABC):
-    @abc.abstractmethod
-    async def create_pair(
-        self,
-        request: Request,
-        id: uuid.UUID | None = None,
-    ) -> IncompletePair:
-        """
-        Store a request in the backend under the given key.
-
-        Args:
-            request: The request object to store.
-
-        Returns:
-            The created IncompletePair object representing the stored request.
-
-        Raises:
-            NotImplementedError: Must be implemented in subclasses.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    async def add_response(self, pair_id: uuid.UUID, response: Response, key: str | bytes) -> CompletePair:
-        """
-        Add a response to an existing request pair.
-
-        Args:
-            pair_id: The unique identifier of the request pair.
-            response: The response object to add.
-            key: The cache key associated with the request pair.
-
-        Returns:
-            The updated response object.
-
-        Raises:
-            NotImplementedError: Must be implemented in subclasses.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    async def get_pairs(self, key: str) -> tp.List[CompletePair]:
-        """
-        Retrieve all responses associated with a given key.
-
-        Args:
-            key: The unique identifier for the request pairs.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    async def update_pair(
-        self,
-        id: uuid.UUID,
-        new_pair: tp.Union[CompletePair, tp.Callable[[CompletePair], CompletePair]],
-    ) -> tp.Optional[CompletePair]:
-        """
-        Update an existing request pair.
-
-        Args:
-            id: The unique identifier of the request pair to update.
-            new_pair: The new pair data or a callable that takes the current pair
-                and returns the updated pair.
-        """
-        raise NotImplementedError()
-
-    @abc.abstractmethod
-    async def remove(self, id: uuid.UUID) -> None:
-        """
-        Remove a request pair from the storage.
-
-        Args:
-            id: The unique identifier of the request pair to remove.
-        """
-        raise NotImplementedError()
-
-    async def close(self) -> None:
-        """
-        Close any resources held by the storage backend.
-        """
-        pass
-
-    def is_soft_deleted(self, pair: IncompletePair | CompletePair) -> bool:
-        """
-        Check if a pair is soft deleted based on its metadata.
-
-        Args:
-            pair: The request pair to check.
-
-        Returns:
-            True if the pair is soft deleted, False otherwise.
-        """
-        return pair.meta.deleted_at is not None and pair.meta.deleted_at > 0
-
-    def is_safe_to_hard_delete(self, pair: IncompletePair | CompletePair) -> bool:
-        """
-        Check if a pair is safe to hard delete based on its metadata.
-
-        If the pair has been soft deleted for more than 1 hour, it is considered safe to hard delete.
-
-        Args:
-            pair: The request pair to check.
-
-        Returns:
-            True if the pair is safe to hard delete, False otherwise.
-        """
-        return bool(pair.meta.deleted_at is not None and (pair.meta.deleted_at + 3600 < time.time()))
-
-    @tp.overload
-    def mark_pair_as_deleted(self, pair: CompletePair) -> CompletePair: ...
-    @tp.overload
-    def mark_pair_as_deleted(self, pair: IncompletePair) -> IncompletePair: ...
-    def mark_pair_as_deleted(self, pair: CompletePair | IncompletePair) -> CompletePair | IncompletePair:
-        """
-        Mark a pair as soft deleted by setting its deleted_at timestamp.
-
-        Args:
-            pair: The request pair to mark as deleted.
-        Returns:
-            The updated request pair with the deleted_at timestamp set.
-        """
-        pair.meta.deleted_at = time.time()
-        return pair
-
-
-def ensure_cache_dict(base_path: str | None = None) -> Path:
-    _base_path = Path(base_path) if base_path is not None else Path(".cache/hishel")
-    _gitignore_file = _base_path / ".gitignore"
-
-    _base_path.mkdir(parents=True, exist_ok=True)
-
-    if not _gitignore_file.is_file():
-        with open(_gitignore_file, "w", encoding="utf-8") as f:
-            f.write("# Automatically created by Hishel\n*")
-    return _base_path

hishel/_core/_base/_storages/_packing.py

@@ -1,165 +0,0 @@
-from __future__ import annotations
-
-import uuid
-from typing import TYPE_CHECKING, Any, Mapping, Optional, Union, overload
-
-import msgpack
-from typing_extensions import Literal, cast
-
-from hishel._core._headers import Headers
-from hishel._core.models import PairMeta, Request, Response
-
-
-def filter_out_hishel_metadata(data: Mapping[str, Any]) -> dict[str, Any]:
-    return {k: v for k, v in data.items() if not k.startswith("hishel_")}
-
-
-if TYPE_CHECKING:
-    from hishel import CompletePair, IncompletePair
-
-
-@overload
-def pack(
-    value: "CompletePair" | "IncompletePair",
-    /,
-    kind: Literal["pair"],
-) -> bytes: ...
-
-
-@overload
-def pack(
-    value: uuid.UUID,
-    /,
-    kind: Literal["entry_db_key_index"],
-) -> bytes: ...
-
-
-def pack(
-    value: Union["CompletePair", "IncompletePair", uuid.UUID],
-    /,
-    kind: Literal["pair", "entry_db_key_index"],
-) -> bytes:
-    from hishel import CompletePair, IncompletePair
-
-    if kind == "entry_db_key_index":
-        assert isinstance(value, uuid.UUID)
-        return value.bytes
-    elif kind == "pair":
-        assert isinstance(value, (CompletePair, IncompletePair))
-        cache_key_dict = {"cache_key": value.cache_key} if isinstance(value, CompletePair) else {}
-        return cast(
-            bytes,
-            msgpack.packb(
-                {
-                    "id": value.id.bytes,
-                    "request": {
-                        "method": value.request.method,
-                        "url": value.request.url,
-                        "headers": value.request.headers._headers,
-                        "extra": filter_out_hishel_metadata(value.request.metadata),
-                    },
-                    "response": (
-                        {
-                            "status_code": value.response.status_code,
-                            "headers": value.response.headers._headers,
-                            "extra": filter_out_hishel_metadata(value.response.metadata),
-                        }
-                    )
-                    if isinstance(value, CompletePair)
-                    else None,
-                    "meta": {
-                        "created_at": value.meta.created_at,
-                        "deleted_at": value.meta.deleted_at,
-                    },
-                    **cache_key_dict,
-                }
-            ),
-        )
-    assert False, f"Unexpected kind: {kind}"
-
-
-@overload
-def unpack(
-    value: bytes,
-    /,
-    kind: Literal["pair"],
-) -> Union["CompletePair", "IncompletePair"]: ...
-
-
-@overload
-def unpack(
-    value: bytes,
-    /,
-    kind: Literal["entry_db_key_index"],
-) -> uuid.UUID: ...
-
-
-@overload
-def unpack(
-    value: Optional[bytes],
-    /,
-    kind: Literal["pair"],
-) -> Optional[Union["CompletePair", "IncompletePair"]]: ...
-
-
-@overload
-def unpack(
-    value: Optional[bytes],
-    /,
-    kind: Literal["entry_db_key_index"],
-) -> Optional[uuid.UUID]: ...
-
-
-def unpack(
-    value: Optional[bytes],
-    /,
-    kind: Literal["pair", "entry_db_key_index"],
-) -> Union["CompletePair", "IncompletePair", uuid.UUID, None]:
-    from hishel import CompletePair, IncompletePair
-
-    if value is None:
-        return None
-    if kind == "entry_db_key_index":
-        return uuid.UUID(bytes=value)
-    elif kind == "pair":
-        data = msgpack.unpackb(value)
-        id = uuid.UUID(bytes=data["id"])
-        if data.get("response"):
-            return CompletePair(
-                id=id,
-                request=Request(
-                    method=data["request"]["method"],
-                    url=data["request"]["url"],
-                    headers=Headers(data["request"]["headers"]),
-                    metadata=data["request"]["extra"],
-                    stream=iter([]),
-                ),
-                response=(
-                    Response(
-                        status_code=data["response"]["status_code"],
-                        headers=Headers(data["response"]["headers"]),
-                        metadata=data["response"]["extra"],
-                        stream=iter([]),
-                    )
-                ),
-                meta=PairMeta(
-                    created_at=data["meta"]["created_at"],
-                    deleted_at=data["meta"]["deleted_at"],
-                ),
-                cache_key=data["cache_key"],
-            )
-        else:
-            return IncompletePair(
-                id=id,
-                request=Request(
-                    method=data["request"]["method"],
-                    url=data["request"]["url"],
-                    headers=Headers(data["request"]["headers"]),
-                    metadata=data["request"]["extra"],
-                    stream=iter([]),
-                ),
-                meta=PairMeta(
-                    created_at=data["meta"]["created_at"],
-                    deleted_at=data["meta"]["deleted_at"],
-                ),
-            )

hishel-1.0.0.dev1.dist-info/RECORD

@@ -1,19 +0,0 @@
-hishel/__init__.py,sha256=byj_IhCjFMaBcp6R8iyRlQV-3R4uTfH44PQzB4lVe1g,1447
-hishel/_async_cache.py,sha256=gE5CygC7FG9htBMfxul7carRRNph8zcMlSoOcB_LNTY,6792
-hishel/_sync_cache.py,sha256=lfkWHJFK527peESMaufjKSbXBriidc09tOwBwub2t34,6538
-hishel/_utils.py,sha256=hQURFuNdS7sjHeVGu12MQzJewjFdnVrdOki3CjBfZvs,6162
-hishel/httpx.py,sha256=vscNB426VIhh0f5qQVkGA_WpwVvaKxbI6gnsHrBA_D0,11226
-hishel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hishel/requests.py,sha256=eiWcwCId04DucnquCsU12tj9cDZcn-cjZ9MYniVuNeo,6429
-hishel/_core/__init__.py,sha256=byj_IhCjFMaBcp6R8iyRlQV-3R4uTfH44PQzB4lVe1g,1447
-hishel/_core/_headers.py,sha256=ii4x2L6GoQFpqpgg28OtFh7p2DoM9mhE4q6CjW6xUWc,17473
-hishel/_core/_spec.py,sha256=d2ZnTXttyT4zuVq9xHAO86VGJxAEBxD2a8WMyEgOuAo,102702
-hishel/_core/models.py,sha256=5qwo1WifrDeZdXag7M5rh0hJuVsm1N-sF3UagQ5LcLc,5519
-hishel/_core/_async/_storages/_sqlite.py,sha256=QPbNtNMA7vYjpt8bSPFIZ4u4c3UCH6eDfUWnH6WprTU,17787
-hishel/_core/_base/_storages/_base.py,sha256=xLJGTBlFK8DVrQMgRMtGXJnYRUmNB-iYkk7S-BtMx8s,8516
-hishel/_core/_base/_storages/_packing.py,sha256=NFMpSvYYTDBNkzwpjj5l4w-JOPLc19oAEDqDEQJ7VZI,4873
-hishel/_core/_sync/_storages/_sqlite.py,sha256=kvAcV2FttZstWEfCczBxj30-PYdj1y9lzh0x3hNusKY,17210
-hishel-1.0.0.dev1.dist-info/METADATA,sha256=IW6_UTqzUl-k8Pcyil_6brlEgd-gKomu1OyeZxrN3dU,9727
-hishel-1.0.0.dev1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hishel-1.0.0.dev1.dist-info/licenses/LICENSE,sha256=1qQj7pE0V2O9OIedvyOgLGLvZLaPd3nFEup3IBEOZjQ,1493
-hishel-1.0.0.dev1.dist-info/RECORD,,