hishel 1.0.0.dev0__tar.gz → 1.0.0.dev1__tar.gz

hishel-1.0.0.dev1/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 1.0.0dev1 - 2025-10-21
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Remove some redundant utils methods
+
+## 1.0.0.dev0 - 2025-10-19
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Use mike powered versioning
+- Improve docs versioning, deploy dev doc on ci
+
+## 0.1.5 - 2025-10-18
+### <!-- 0 -->🚀 Features
+- Set chunk size to 128KB for httpx to reduce SQLite read/writes
+- Better cache-control parsing
+- Add close method to storages API (#384)
+- Increase requests buffer size to 128KB, disable charset detection
+
+### <!-- 1 -->🐛 Bug Fixes
+- Fix some line breaks
+
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Remove some redundant files from repo
+
+## 0.1.4 - 2025-10-14
+### <!-- 0 -->🚀 Features
+- Add support for a sans-IO API (#366)
+- Allow already consumed streams with `CacheTransport` (#377)
+- Add sqlite storage for beta storages
+- Get rid of some locks from sqlite storage
+- Better async implemetation for sqlite storage
+
+### <!-- 1 -->🐛 Bug Fixes
+- Create an sqlite file in a cache folder
+- Fix beta imports
+
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Improve CI (#369)
+- Remove src folder (#373)
+- Temporary remove python3.14 from CI
+- Add sqlite tests for new storage
+- Move some tests to beta
+

{hishel-1.0.0.dev0 → hishel-1.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hishel
-Version: 1.0.0.dev0
+Version: 1.0.0.dev1
 Summary:  Elegant HTTP Caching for Python
 Project-URL: Homepage, https://hishel.com
 Project-URL: Source, https://github.com/karpetrosyan/hishel
@@ -24,12 +24,14 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP
 Requires-Python: >=3.9
-Requires-Dist: anyio>=4.9.0
-Requires-Dist: anysqlite>=0.0.5
-Requires-Dist: httpx>=0.28.0
 Requires-Dist: msgpack>=1.1.2
 Requires-Dist: typing-extensions>=4.14.1
+Provides-Extra: async
+Requires-Dist: anyio>=4.9.0; extra == 'async'
+Requires-Dist: anysqlite>=0.0.5; extra == 'async'
 Provides-Extra: httpx
+Requires-Dist: anyio>=4.9.0; extra == 'httpx'
+Requires-Dist: anysqlite>=0.0.5; extra == 'httpx'
 Requires-Dist: httpx>=0.28.1; extra == 'httpx'
 Provides-Extra: requests
 Requires-Dist: requests>=2.32.5; extra == 'requests'
@@ -249,73 +251,48 @@ Hishel is inspired by and builds upon the excellent work in the Python HTTP ecos
   <strong>Made with ❤️ by <a href="https://github.com/karpetrosyan">Kar Petrosyan</a></strong>
 </p>
 
-## [1.0.0dev0] - 2025-10-19
+# Changelog
 
-### ⚙️ Miscellaneous Tasks
+All notable changes to this project will be documented in this file.
 
-- *(docs)* Use mike powered versioning
-- *(docs)* Improve docs versioning, deploy dev doc on ci
-## [0.1.5] - 2025-10-18
+## 1.0.0dev1 - 2025-10-21
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Remove some redundant utils methods
 
-### 🚀 Features
+## 1.0.0.dev0 - 2025-10-19
+### <!-- 7 -->⚙️ Miscellaneous Tasks
+- Use mike powered versioning
+- Improve docs versioning, deploy dev doc on ci
 
-- *(perf)* Set chunk size to 128KB for httpx to reduce SQLite read/writes
+## 0.1.5 - 2025-10-18
+### <!-- 0 -->🚀 Features
+- Set chunk size to 128KB for httpx to reduce SQLite read/writes
 - Better cache-control parsing
 - Add close method to storages API (#384)
-- *(perf)* Increase requests buffer size to 128KB, disable charset detection
+- Increase requests buffer size to 128KB, disable charset detection
 
-### 🐛 Bug Fixes
-
-- *(docs)* Fix some line breaks
-
-### ⚙️ Miscellaneous Tasks
+### <!-- 1 -->🐛 Bug Fixes
+- Fix some line breaks
 
+### <!-- 7 -->⚙️ Miscellaneous Tasks
 - Remove some redundant files from repo
-## [0.1.4] - 2025-10-14
-
-### 🚀 Features
 
+## 0.1.4 - 2025-10-14
+### <!-- 0 -->🚀 Features
 - Add support for a sans-IO API (#366)
 - Allow already consumed streams with `CacheTransport` (#377)
 - Add sqlite storage for beta storages
 - Get rid of some locks from sqlite storage
 - Better async implemetation for sqlite storage
 
-### 🐛 Bug Fixes
-
+### <!-- 1 -->🐛 Bug Fixes
 - Create an sqlite file in a cache folder
 - Fix beta imports
 
-### ⚙️ Miscellaneous Tasks
-
+### <!-- 7 -->⚙️ Miscellaneous Tasks
 - Improve CI (#369)
-- *(internal)* Remove src folder (#373)
-- *(internal)* Temporary remove python3.14 from CI
-- *(tests)* Add sqlite tests for new storage
-- *(tests)* Move some tests to beta
-## [0.1.3] - 2025-07-06
-
-### 🚀 Features
-
-- Support providing a path prefix to S3 storage (#342)
-
-### 📚 Documentation
-
-- Update link to httpx transports page (#337)
-## [0.1.2] - 2025-04-04
-
-### 🐛 Bug Fixes
-
-- Requirements.txt to reduce vulnerabilities (#263)
-## [0.0.30] - 2024-07-12
-
-### 🐛 Bug Fixes
-
-- Requirements.txt to reduce vulnerabilities (#245)
-- Requirements.txt to reduce vulnerabilities (#255)
-## [0.0.27] - 2024-05-31
-
-### 🐛 Bug Fixes
+- Remove src folder (#373)
+- Temporary remove python3.14 from CI
+- Add sqlite tests for new storage
+- Move some tests to beta
 
-- *(redis)* Do not update metadata with negative ttl (#231)
-## [0.0.1] - 2023-07-22

hishel-1.0.0.dev1/hishel/_core/_async/_storages/_sqlite.py

@@ -0,0 +1,457 @@
+from __future__ import annotations
+
+import time
+import uuid
+from dataclasses import replace
+from typing import (
+    Any,
+    AsyncIterable,
+    AsyncIterator,
+    Callable,
+    List,
+    Literal,
+    Optional,
+    Union,
+)
+
+from hishel._core._base._storages._base import AsyncBaseStorage, ensure_cache_dict
+from hishel._core._base._storages._packing import pack, unpack
+from hishel._core.models import (
+    CompletePair,
+    IncompletePair,
+    Pair,
+    PairMeta,
+    Request,
+    Response,
+)
+
+# Batch cleanup configuration
+# How often to run cleanup (seconds). Default: 1 hour.
+BATCH_CLEANUP_INTERVAL = 3600
+# How long to wait after storage creation before allowing the first cleanup (seconds)
+BATCH_CLEANUP_START_DELAY = 5 * 60
+# Number of rows to process per chunk when cleaning
+BATCH_CLEANUP_CHUNK_SIZE = 200
+
+
+try:
+    import anysqlite
+
+    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 = time.time() - BATCH_CLEANUP_INTERVAL + BATCH_CLEANUP_START_DELAY
+            # When this storage instance was created. Used to delay the first cleanup.
+            self._start_time = time.time()
+            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] = []
+
+            now = time.time()
+            if now - self.last_cleanup >= BATCH_CLEANUP_INTERVAL:
+                try:
+                    await self._batch_cleanup()
+                except Exception:
+                    # don't let cleanup prevent reads; failures are non-fatal
+                    pass
+
+            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()
+
+            # Process entries in chunks to avoid loading the entire table into memory.
+            chunk_size = BATCH_CLEANUP_CHUNK_SIZE
+            offset = 0
+            while True:
+                await cursor.execute("SELECT id, data FROM entries LIMIT ? OFFSET ?", (chunk_size, offset))
+                rows = await cursor.fetchall()
+                if not rows:
+                    break
+
+                for row in rows:
+                    pair = unpack(row[1], kind="pair")
+                    if pair is None:
+                        continue
+
+                    # expired but not yet soft-deleted
+                    if await self._is_pair_expired(pair, cursor) and not self.is_soft_deleted(pair):
+                        should_mark_as_deleted.append(pair)
+
+                    # soft-deleted and safe to hard delete, or corrupted 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)
+
+                # advance pagination
+                offset += len(rows)
+
+            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
+except ImportError:
+
+    class AsyncSqliteStorage(AsyncBaseStorage):  # type: ignore[no-redef]
+        def __init__(self, *args: Any, **kwargs: Any) -> None:
+            raise ImportError(
+                "The 'anysqlite' library is required to use the `AsyncSqliteStorage` integration. "
+                "Install hishel with 'pip install hishel[async]'."
+            )