hishel 0.1.4__py3-none-any.whl → 1.0.0b1__py3-none-any.whl

hishel/beta/_core/_async/_storages/_sqlite.py

@@ -1,411 +0,0 @@
-from __future__ import annotations
-
-import time
-import uuid
-from dataclasses import replace
-from typing import (
-    AsyncIterable,
-    AsyncIterator,
-    Callable,
-    List,
-    Literal,
-    Optional,
-    Union,
-)
-
-import anysqlite
-
-from hishel.beta._core._base._storages._base import AsyncBaseStorage, ensure_cache_dict
-from hishel.beta._core._base._storages._packing import pack, unpack
-from hishel.beta._core.models import (
-    CompletePair,
-    IncompletePair,
-    Pair,
-    PairMeta,
-    Request,
-    Response,
-)
-
-
-class AsyncSqliteStorage(AsyncBaseStorage):
-    _STREAM_KIND = {"request": 0, "response": 1}
-    _COMPLETE_CHUNK_NUMBER = -1
-
-    def __init__(
-        self,
-        *,
-        connection: Optional[anysqlite.Connection] = None,
-        database_path: str = "hishel_cache.db",
-        default_ttl: Optional[float] = None,
-        refresh_ttl_on_access: bool = True,
-    ) -> None:
-        base_path = ensure_cache_dict()
-
-        self.connection = connection
-        self.database_path = base_path / database_path
-        self.default_ttl = default_ttl
-        self.refresh_ttl_on_access = refresh_ttl_on_access
-        self.last_cleanup = float("-inf")
-        self._initialized = False
-
-    async def _ensure_connection(self) -> anysqlite.Connection:
-        """Ensure connection is established and database is initialized."""
-        if self.connection is None:
-            self.connection = await anysqlite.connect(str(self.database_path))
-        if not self._initialized:
-            await self._initialize_database()
-            self._initialized = True
-        return self.connection
-
-    async def _initialize_database(self) -> None:
-        """Initialize the database schema."""
-        assert self.connection is not None
-        cursor = await self.connection.cursor()
-
-        # Table for storing request/response pairs
-        await cursor.execute("""
-            CREATE TABLE IF NOT EXISTS entries (
-                id BLOB PRIMARY KEY,
-                cache_key BLOB,
-                data BLOB NOT NULL,
-                created_at REAL NOT NULL,
-                deleted_at REAL
-            )
-        """)
-
-        # Table for storing stream chunks
-        await cursor.execute("""
-            CREATE TABLE IF NOT EXISTS streams (
-                entry_id BLOB NOT NULL,
-                kind INTEGER NOT NULL,
-                chunk_number INTEGER NOT NULL,
-                chunk_data BLOB NOT NULL,
-                PRIMARY KEY (entry_id, kind, chunk_number),
-                FOREIGN KEY (entry_id) REFERENCES entries(id) ON DELETE CASCADE
-            )
-        """)
-
-        # Indexes for performance
-        await cursor.execute("CREATE INDEX IF NOT EXISTS idx_entries_deleted_at ON entries(deleted_at)")
-        await cursor.execute("CREATE INDEX IF NOT EXISTS idx_entries_cache_key ON entries(cache_key)")
-        # Note: PRIMARY KEY (entry_id, kind, chunk_number) already provides an index
-        # for queries like: entry_id = ? AND kind = ? AND chunk_number = ?
-
-        await self.connection.commit()
-
-    async def create_pair(
-        self,
-        request: Request,
-        id: uuid.UUID | None = None,
-    ) -> IncompletePair:
-        pair_id = id if id is not None else uuid.uuid4()
-        pair_meta = PairMeta(
-            created_at=time.time(),
-        )
-
-        pair = IncompletePair(id=pair_id, request=request, meta=pair_meta)
-
-        packed_pair = pack(pair, kind="pair")
-
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        await cursor.execute(
-            "INSERT INTO entries (id, cache_key, data, created_at, deleted_at) VALUES (?, ?, ?, ?, ?)",
-            (pair_id.bytes, None, packed_pair, pair_meta.created_at, None),
-        )
-        await connection.commit()
-
-        assert isinstance(request.stream, AsyncIterable), "Request stream must be an AsyncIterable, not Iterable"
-
-        request = Request(
-            method=request.method,
-            url=request.url,
-            headers=request.headers,
-            metadata=request.metadata,
-            stream=self._save_stream(request.stream, pair_id.bytes, "request"),
-        )
-
-        return replace(pair, request=request)
-
-    async def add_response(
-        self,
-        pair_id: uuid.UUID,
-        response: Response,
-        key: str | bytes,
-    ) -> CompletePair:
-        if isinstance(key, str):
-            key = key.encode("utf-8")
-
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-
-        # Get the existing pair
-        await cursor.execute("SELECT data FROM entries WHERE id = ?", (pair_id.bytes,))
-        result = await cursor.fetchone()
-
-        if result is None:
-            raise ValueError(f"Entry with ID {pair_id} not found.")
-
-        pair = unpack(result[0], kind="pair")
-
-        assert isinstance(response.stream, (AsyncIterator, AsyncIterable))
-        response = replace(response, stream=self._save_stream(response.stream, pair_id.bytes, "response"))
-
-        await self._delete_stream(pair.id.bytes, cursor, type="response")
-        complete_pair = CompletePair(id=pair.id, request=pair.request, response=response, meta=pair.meta, cache_key=key)
-
-        # Update the entry with the complete pair and set cache_key
-        await cursor.execute(
-            "UPDATE entries SET data = ?, cache_key = ? WHERE id = ?",
-            (pack(complete_pair, kind="pair"), key, pair_id.bytes),
-        )
-        await connection.commit()
-
-        return complete_pair
-
-    async def get_pairs(self, key: str) -> List[CompletePair]:
-        final_pairs: List[CompletePair] = []
-
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        # Query entries directly by cache_key
-        await cursor.execute("SELECT id, data FROM entries WHERE cache_key = ?", (key.encode("utf-8"),))
-
-        for row in await cursor.fetchall():
-            pair_data = unpack(row[1], kind="pair")
-
-            if isinstance(pair_data, IncompletePair):
-                continue
-
-            final_pairs.append(pair_data)
-
-        pairs_with_streams: List[CompletePair] = []
-
-        for pair in final_pairs:
-            pairs_with_streams.append(
-                replace(
-                    pair,
-                    response=replace(
-                        pair.response,
-                        stream=self._stream_data_from_cache(pair.id.bytes, "response"),
-                    ),
-                    request=replace(
-                        pair.request,
-                        stream=self._stream_data_from_cache(pair.id.bytes, "request"),
-                    ),
-                )
-            )
-        return pairs_with_streams
-
-    async def update_pair(
-        self,
-        id: uuid.UUID,
-        new_pair: Union[CompletePair, Callable[[CompletePair], CompletePair]],
-    ) -> Optional[CompletePair]:
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        await cursor.execute("SELECT data FROM entries WHERE id = ?", (id.bytes,))
-        result = await cursor.fetchone()
-
-        if result is None:
-            return None
-
-        pair = unpack(result[0], kind="pair")
-
-        if isinstance(pair, IncompletePair):
-            return None
-
-        if isinstance(new_pair, CompletePair):
-            complete_pair = new_pair
-        else:
-            complete_pair = new_pair(pair)
-
-        if pair.id != complete_pair.id:
-            raise ValueError("Pair ID mismatch")
-
-        await cursor.execute("UPDATE entries SET data = ? WHERE id = ?", (pack(complete_pair, kind="pair"), id.bytes))
-
-        if pair.cache_key != complete_pair.cache_key:
-            await cursor.execute(
-                "UPDATE entries SET cache_key = ? WHERE id = ?",
-                (complete_pair.cache_key, complete_pair.id.bytes),
-            )
-
-        await connection.commit()
-
-        return complete_pair
-
-    async def remove(self, id: uuid.UUID) -> None:
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        await cursor.execute("SELECT data FROM entries WHERE id = ?", (id.bytes,))
-        result = await cursor.fetchone()
-
-        if result is None:
-            return None
-
-        pair = unpack(result[0], kind="pair")
-        await self._soft_delete_pair(pair, cursor)
-        await connection.commit()
-
-    async def _is_stream_complete(
-        self, kind: Literal["request", "response"], pair_id: uuid.UUID, cursor: anysqlite.Cursor
-    ) -> bool:
-        kind_id = self._STREAM_KIND[kind]
-        # Check if there's a completion marker (chunk_number = -1)
-        await cursor.execute(
-            "SELECT 1 FROM streams WHERE entry_id = ? AND kind = ? AND chunk_number = ? LIMIT 1",
-            (pair_id.bytes, kind_id, self._COMPLETE_CHUNK_NUMBER),
-        )
-        return await cursor.fetchone() is not None
-
-    async def _soft_delete_pair(self, pair: Union[CompletePair, IncompletePair], cursor: anysqlite.Cursor) -> None:
-        """
-        Mark the pair as deleted by setting the deleted_at timestamp.
-        """
-        marked_pair = self.mark_pair_as_deleted(pair)
-        await cursor.execute(
-            "UPDATE entries SET data = ?, deleted_at = ? WHERE id = ?",
-            (pack(marked_pair, kind="pair"), marked_pair.meta.deleted_at, pair.id.bytes),
-        )
-
-    async def _is_pair_expired(self, pair: Pair, cursor: anysqlite.Cursor) -> bool:
-        """
-        Check if the pair is expired.
-        """
-        ttl = pair.request.metadata["hishel_ttl"] if "hishel_ttl" in pair.request.metadata else self.default_ttl
-        created_at = pair.meta.created_at
-        if ttl is None:
-            return False
-        return created_at + ttl < time.time()
-
-    async def _batch_cleanup(
-        self,
-    ) -> None:
-        """
-        Cleanup expired pairs in the database.
-        """
-        should_mark_as_deleted: List[Union[CompletePair, IncompletePair]] = []
-        should_hard_delete: List[Union[CompletePair, IncompletePair]] = []
-
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        await cursor.execute("SELECT id, data FROM entries")
-
-        for row in await cursor.fetchall():
-            pair = unpack(row[1], kind="pair")
-            if pair is None:
-                continue
-            if await self._is_pair_expired(pair, cursor) and not self.is_soft_deleted(pair):
-                should_mark_as_deleted.append(pair)
-
-            if (self.is_soft_deleted(pair) and self.is_safe_to_hard_delete(pair)) or await self._is_corrupted(
-                pair, cursor
-            ):
-                should_hard_delete.append(pair)
-
-        for pair in should_mark_as_deleted:
-            await self._soft_delete_pair(pair, cursor)
-
-        for pair in should_hard_delete:
-            await self._hard_delete_pair(pair, cursor)
-
-        await connection.commit()
-
-    async def _is_corrupted(self, pair: IncompletePair | CompletePair, cursor: anysqlite.Cursor) -> bool:
-        # if pair was created more than 1 hour ago and still not completed
-        if pair.meta.created_at + 3600 < time.time() and isinstance(pair, IncompletePair):
-            return True
-
-        if isinstance(pair, CompletePair) and not await self._is_stream_complete("request", pair.id, cursor):
-            return True
-        return False
-
-    async def _hard_delete_pair(self, pair: CompletePair | IncompletePair, cursor: anysqlite.Cursor) -> None:
-        """
-        Permanently delete the pair from the database.
-        """
-        await cursor.execute("DELETE FROM entries WHERE id = ?", (pair.id.bytes,))
-
-        # Delete all streams (both request and response) for this entry
-        await self._delete_stream(pair.id.bytes, cursor)
-
-    async def _delete_stream(
-        self,
-        entry_id: bytes,
-        cursor: anysqlite.Cursor,
-        type: Literal["request", "response", "all"] = "all",
-    ) -> None:
-        """
-        Delete all streams (both request and response) associated with the given entry ID.
-        """
-        if type == "request":
-            await cursor.execute(
-                "DELETE FROM streams WHERE entry_id = ? AND kind = ?", (entry_id, self._STREAM_KIND["request"])
-            )
-        elif type == "response":
-            await cursor.execute(
-                "DELETE FROM streams WHERE entry_id = ? AND kind = ?", (entry_id, self._STREAM_KIND["response"])
-            )
-        elif type == "all":
-            await cursor.execute("DELETE FROM streams WHERE entry_id = ?", (entry_id,))
-
-    async def _save_stream(
-        self,
-        stream: AsyncIterator[bytes],
-        entry_id: bytes,
-        kind: Literal["response", "request"],
-    ) -> AsyncIterator[bytes]:
-        """
-        Wrapper around an async iterator that also saves the data to the cache in chunks.
-        """
-        kind_id = self._STREAM_KIND[kind]
-        chunk_number = 0
-        async for chunk in stream:
-            connection = await self._ensure_connection()
-            cursor = await connection.cursor()
-            await cursor.execute(
-                "INSERT INTO streams (entry_id, kind, chunk_number, chunk_data) VALUES (?, ?, ?, ?)",
-                (entry_id, kind_id, chunk_number, chunk),
-            )
-            await connection.commit()
-            chunk_number += 1
-            yield chunk
-
-        # Mark end of stream with chunk_number = -1
-        connection = await self._ensure_connection()
-        cursor = await connection.cursor()
-        await cursor.execute(
-            "INSERT INTO streams (entry_id, kind, chunk_number, chunk_data) VALUES (?, ?, ?, ?)",
-            (entry_id, kind_id, self._COMPLETE_CHUNK_NUMBER, b""),
-        )
-        await connection.commit()
-
-    async def _stream_data_from_cache(
-        self,
-        entry_id: bytes,
-        kind: Literal["response", "request"],
-    ) -> AsyncIterator[bytes]:
-        """
-        Get an async iterator that yields the stream data from the cache.
-        """
-        kind_id = self._STREAM_KIND[kind]
-        chunk_number = 0
-
-        connection = await self._ensure_connection()
-        while True:
-            cursor = await connection.cursor()
-            await cursor.execute(
-                "SELECT chunk_data FROM streams WHERE entry_id = ? AND kind = ? AND chunk_number = ?",
-                (entry_id, kind_id, chunk_number),
-            )
-            result = await cursor.fetchone()
-
-            if result is None:
-                break
-            chunk = result[0]
-            # chunk_number = -1 is the completion marker with empty data
-            if chunk == b"":
-                break
-            yield chunk
-            chunk_number += 1

hishel/beta/_core/_base/_storages/_base.py

@@ -1,260 +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.beta._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 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()
-
-    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