hishel 1.0.0.dev3__tar.gz → 1.1.1__tar.gz

{hishel-1.0.0.dev3 → hishel-1.1.1}/CHANGELOG.md

@@ -2,6 +2,45 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.1 - 2025-11-01
+### ⚙️ Miscellaneous Tasks
+- Bump the python-packages group with 10 updates (#396)
+
+### 📦 Dependencies
+- Bump actions/upload-artifact from 4 to 5 (#395)
+- Bump actions/download-artifact from 4 to 6 (#394)
+- Bump astral-sh/setup-uv from 5 to 7 (#393)
+
+## 1.1.0 - 2025-10-31
+### ⚙️ Miscellaneous Tasks
+- Add in memory example
+
+### 🐛 Bug Fixes
+- Pass any response with non-expected status code on revalidation to client
+- Pass any response with non-expected status code on revalidation to client
+
+### 🚀 Features
+- Allow setting storage base with via `database_path` for sqlite storage
+
+## 1.0.0 - 2025-10-28
+### ⚙️ Miscellaneous Tasks
+- Add examples, improve docs
+
+## 1.0.0b1 - 2025-10-28
+### ♻️ Refactoring
+- Add policies
+
+### ⚙️ Miscellaneous Tasks
+- Improve sans-io diagram colors
+- Add graphql docs
+
+### 🐛 Bug Fixes
+- Body-sensitive responses caching
+- Filter out `Transfer-Encoding` header for asgi responses
+
+### 🚀 Features
+- Add global `use_body_key` setting
+
 ## 1.0.0.dev3 - 2025-10-26
 ### ♻️ Refactoring
 - Replace pairs with entries, simplify storage API

{hishel-1.0.0.dev3 → hishel-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hishel
-Version: 1.0.0.dev3
+Version: 1.1.1
 Summary:  Elegant HTTP Caching for Python
 Project-URL: Homepage, https://hishel.com
 Project-URL: Source, https://github.com/karpetrosyan/hishel
@@ -82,9 +82,10 @@ Description-Content-Type: text/markdown
 - 🔄 **Async & Sync** - Full support for both synchronous and asynchronous workflows
 - 🎨 **Type Safe** - Fully typed with comprehensive type hints
 - 🧪 **Well Tested** - Extensive test coverage and battle-tested
-- 🎛️ **Configurable** - Fine-grained control over caching behavior
-- � **Memory Efficient** - Streaming support prevents loading large payloads into memory
+- 🎛️ **Configurable** - Fine-grained control over caching behavior with flexible policies
+- 💨 **Memory Efficient** - Streaming support prevents loading large payloads into memory
 - 🌐 **Universal** - Works with any ASGI application (Starlette, Litestar, BlackSheep, etc.)
+- 🎯 **GraphQL Support** - Cache GraphQL queries with body-sensitive content caching
 
 ## 📦 Installation
 
@@ -175,12 +176,14 @@ from hishel.asgi import ASGICacheMiddleware
 app = ASGICacheMiddleware(app)
 
 # Or configure with options
-from hishel import AsyncSqliteStorage, CacheOptions
+from hishel import AsyncSqliteStorage, CacheOptions, SpecificationPolicy
 
 app = ASGICacheMiddleware(
     app,
     storage=AsyncSqliteStorage(),
-    cache_options=CacheOptions(shared=True)
+    policy=SpecificationPolicy(
+      cache_options=CacheOptions(shared=True)
+    ),
 )
 ```
 
@@ -225,21 +228,49 @@ async def get_data():
 
 ## 🎛️ Advanced Configuration
 
-### Custom Cache Options
+### Caching Policies
+
+Hishel supports two types of caching policies:
+
+**SpecificationPolicy** - RFC 9111 compliant HTTP caching (default):
 
 ```python
-from hishel import CacheOptions
+from hishel import CacheOptions, SpecificationPolicy
 from hishel.httpx import SyncCacheClient
 
 client = SyncCacheClient(
-    cache_options=CacheOptions(
-        shared=False,                              # Use as private cache (browser-like)
-        supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
-        allow_stale=True                           # Allow serving stale responses
+    policy=SpecificationPolicy(
+        cache_options=CacheOptions(
+            shared=False,                              # Use as private cache (browser-like)
+            supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
+            allow_stale=True                           # Allow serving stale responses
+        )
+    )
+)
+```
+
+**FilterPolicy** - Custom filtering logic for fine-grained control:
+
+```python
+from hishel import FilterPolicy, BaseFilter, Request
+from hishel.httpx import AsyncCacheClient
+
+class CacheOnlyAPIRequests(BaseFilter[Request]):
+    def needs_body(self) -> bool:
+        return False
+    
+    def apply(self, item: Request, body: bytes | None) -> bool:
+        return "/api/" in str(item.url)
+
+client = AsyncCacheClient(
+    policy=FilterPolicy(
+        request_filters=[CacheOnlyAPIRequests()]
     )
 )
 ```
 
+[Learn more about policies →](https://hishel.com/dev/policies/)
+
 ### Custom Storage Backend
 
 ```python
@@ -255,6 +286,60 @@ storage = SyncSqliteStorage(
 client = SyncCacheClient(storage=storage)
 ```
 
+### GraphQL and Body-Sensitive Caching
+
+Cache GraphQL queries and other POST requests by including the request body in the cache key.
+
+**Using per-request header:**
+
+```python
+from hishel import FilterPolicy
+from hishel.httpx import SyncCacheClient
+
+client = SyncCacheClient(
+    policy=FilterPolicy()
+)
+
+# Cache GraphQL queries - different queries get different cache entries
+graphql_query = """
+    query GetUser($id: ID!) {
+        user(id: $id) {
+            name
+            email
+        }
+    }
+"""
+
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}},
+    headers={"X-Hishel-Body-Key": "true"}  # Enable body-based caching
+)
+
+# Different query will be cached separately
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "456"}},
+    headers={"X-Hishel-Body-Key": "true"}
+)
+```
+
+**Using global configuration:**
+
+```python
+from hishel.httpx import SyncCacheClient
+from hishel import FilterPolicy
+
+# Enable body-based caching for all requests
+client = SyncCacheClient(policy=FilterPolicy(use_body_key=True))
+
+# All POST requests automatically include body in cache key
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}}
+)
+```
+
 ## 🏗️ Architecture
 
 Hishel uses a **sans-I/O state machine** architecture that separates HTTP caching logic from I/O operations:
@@ -266,13 +351,11 @@ Hishel uses a **sans-I/O state machine** architecture that separates HTTP cachin
 
 ## 🔮 Roadmap
 
-While Hishel currently supports HTTPX and Requests, we're actively working on:
+We're actively working on:
 
-- 🎯 Additional HTTP client integrations
-- 🎯 Server-side caching support
-- 🎯 More storage backends
-- 🎯 Advanced caching strategies
 - 🎯 Performance optimizations
+- 🎯 More integrations
+- 🎯 Partial responses support
 
 ## 📚 Documentation
 
@@ -284,6 +367,7 @@ Comprehensive documentation is available at [https://hishel.com/dev](https://his
 - [ASGI Integration](https://hishel.com/dev/asgi)
 - [FastAPI Integration](https://hishel.com/dev/fastapi)
 - [BlackSheep Integration](https://hishel.com/dev/integrations/blacksheep)
+- [GraphQL Integration](https://hishel.com/dev/integrations/graphql)
 - [Storage Backends](https://hishel.com/dev/storages)
 - [Request/Response Metadata](https://hishel.com/dev/metadata)
 - [RFC 9111 Specification](https://hishel.com/dev/specification)
@@ -326,6 +410,45 @@ Hishel is inspired by and builds upon the excellent work in the Python HTTP ecos
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.1 - 2025-11-01
+### ⚙️ Miscellaneous Tasks
+- Bump the python-packages group with 10 updates (#396)
+
+### 📦 Dependencies
+- Bump actions/upload-artifact from 4 to 5 (#395)
+- Bump actions/download-artifact from 4 to 6 (#394)
+- Bump astral-sh/setup-uv from 5 to 7 (#393)
+
+## 1.1.0 - 2025-10-31
+### ⚙️ Miscellaneous Tasks
+- Add in memory example
+
+### 🐛 Bug Fixes
+- Pass any response with non-expected status code on revalidation to client
+- Pass any response with non-expected status code on revalidation to client
+
+### 🚀 Features
+- Allow setting storage base with via `database_path` for sqlite storage
+
+## 1.0.0 - 2025-10-28
+### ⚙️ Miscellaneous Tasks
+- Add examples, improve docs
+
+## 1.0.0b1 - 2025-10-28
+### ♻️ Refactoring
+- Add policies
+
+### ⚙️ Miscellaneous Tasks
+- Improve sans-io diagram colors
+- Add graphql docs
+
+### 🐛 Bug Fixes
+- Body-sensitive responses caching
+- Filter out `Transfer-Encoding` header for asgi responses
+
+### 🚀 Features
+- Add global `use_body_key` setting
+
 ## 1.0.0.dev3 - 2025-10-26
 ### ♻️ Refactoring
 - Replace pairs with entries, simplify storage API

{hishel-1.0.0.dev3 → hishel-1.1.1}/README.md

@@ -41,9 +41,10 @@
 - 🔄 **Async & Sync** - Full support for both synchronous and asynchronous workflows
 - 🎨 **Type Safe** - Fully typed with comprehensive type hints
 - 🧪 **Well Tested** - Extensive test coverage and battle-tested
-- 🎛️ **Configurable** - Fine-grained control over caching behavior
-- � **Memory Efficient** - Streaming support prevents loading large payloads into memory
+- 🎛️ **Configurable** - Fine-grained control over caching behavior with flexible policies
+- 💨 **Memory Efficient** - Streaming support prevents loading large payloads into memory
 - 🌐 **Universal** - Works with any ASGI application (Starlette, Litestar, BlackSheep, etc.)
+- 🎯 **GraphQL Support** - Cache GraphQL queries with body-sensitive content caching
 
 ## 📦 Installation
 
@@ -134,12 +135,14 @@ from hishel.asgi import ASGICacheMiddleware
 app = ASGICacheMiddleware(app)
 
 # Or configure with options
-from hishel import AsyncSqliteStorage, CacheOptions
+from hishel import AsyncSqliteStorage, CacheOptions, SpecificationPolicy
 
 app = ASGICacheMiddleware(
     app,
     storage=AsyncSqliteStorage(),
-    cache_options=CacheOptions(shared=True)
+    policy=SpecificationPolicy(
+      cache_options=CacheOptions(shared=True)
+    ),
 )
 ```
 
@@ -184,21 +187,49 @@ async def get_data():
 
 ## 🎛️ Advanced Configuration
 
-### Custom Cache Options
+### Caching Policies
+
+Hishel supports two types of caching policies:
+
+**SpecificationPolicy** - RFC 9111 compliant HTTP caching (default):
 
 ```python
-from hishel import CacheOptions
+from hishel import CacheOptions, SpecificationPolicy
 from hishel.httpx import SyncCacheClient
 
 client = SyncCacheClient(
-    cache_options=CacheOptions(
-        shared=False,                              # Use as private cache (browser-like)
-        supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
-        allow_stale=True                           # Allow serving stale responses
+    policy=SpecificationPolicy(
+        cache_options=CacheOptions(
+            shared=False,                              # Use as private cache (browser-like)
+            supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
+            allow_stale=True                           # Allow serving stale responses
+        )
+    )
+)
+```
+
+**FilterPolicy** - Custom filtering logic for fine-grained control:
+
+```python
+from hishel import FilterPolicy, BaseFilter, Request
+from hishel.httpx import AsyncCacheClient
+
+class CacheOnlyAPIRequests(BaseFilter[Request]):
+    def needs_body(self) -> bool:
+        return False
+    
+    def apply(self, item: Request, body: bytes | None) -> bool:
+        return "/api/" in str(item.url)
+
+client = AsyncCacheClient(
+    policy=FilterPolicy(
+        request_filters=[CacheOnlyAPIRequests()]
     )
 )
 ```
 
+[Learn more about policies →](https://hishel.com/dev/policies/)
+
 ### Custom Storage Backend
 
 ```python
@@ -214,6 +245,60 @@ storage = SyncSqliteStorage(
 client = SyncCacheClient(storage=storage)
 ```
 
+### GraphQL and Body-Sensitive Caching
+
+Cache GraphQL queries and other POST requests by including the request body in the cache key.
+
+**Using per-request header:**
+
+```python
+from hishel import FilterPolicy
+from hishel.httpx import SyncCacheClient
+
+client = SyncCacheClient(
+    policy=FilterPolicy()
+)
+
+# Cache GraphQL queries - different queries get different cache entries
+graphql_query = """
+    query GetUser($id: ID!) {
+        user(id: $id) {
+            name
+            email
+        }
+    }
+"""
+
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}},
+    headers={"X-Hishel-Body-Key": "true"}  # Enable body-based caching
+)
+
+# Different query will be cached separately
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "456"}},
+    headers={"X-Hishel-Body-Key": "true"}
+)
+```
+
+**Using global configuration:**
+
+```python
+from hishel.httpx import SyncCacheClient
+from hishel import FilterPolicy
+
+# Enable body-based caching for all requests
+client = SyncCacheClient(policy=FilterPolicy(use_body_key=True))
+
+# All POST requests automatically include body in cache key
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}}
+)
+```
+
 ## 🏗️ Architecture
 
 Hishel uses a **sans-I/O state machine** architecture that separates HTTP caching logic from I/O operations:
@@ -225,13 +310,11 @@ Hishel uses a **sans-I/O state machine** architecture that separates HTTP cachin
 
 ## 🔮 Roadmap
 
-While Hishel currently supports HTTPX and Requests, we're actively working on:
+We're actively working on:
 
-- 🎯 Additional HTTP client integrations
-- 🎯 Server-side caching support
-- 🎯 More storage backends
-- 🎯 Advanced caching strategies
 - 🎯 Performance optimizations
+- 🎯 More integrations
+- 🎯 Partial responses support
 
 ## 📚 Documentation
 
@@ -243,6 +326,7 @@ Comprehensive documentation is available at [https://hishel.com/dev](https://his
 - [ASGI Integration](https://hishel.com/dev/asgi)
 - [FastAPI Integration](https://hishel.com/dev/fastapi)
 - [BlackSheep Integration](https://hishel.com/dev/integrations/blacksheep)
+- [GraphQL Integration](https://hishel.com/dev/integrations/graphql)
 - [Storage Backends](https://hishel.com/dev/storages)
 - [Request/Response Metadata](https://hishel.com/dev/metadata)
 - [RFC 9111 Specification](https://hishel.com/dev/specification)

{hishel-1.0.0.dev3 → hishel-1.1.1}/hishel/__init__.py

@@ -15,17 +15,20 @@ from hishel._core._spec import (
     NeedToBeUpdated as NeedToBeUpdated,
     State as State,
     StoreAndUse as StoreAndUse,
-    create_idle_state as create_idle_state,
 )
 from hishel._core.models import (
     Entry as Entry,
     EntryMeta as EntryMeta,
     Request as Request,
-    Response,
+    Response as Response,
+    ResponseMetadata as ResponseMetadata,
+    RequestMetadata as RequestMetadata,
 )
 from hishel._async_cache import AsyncCacheProxy as AsyncCacheProxy
 from hishel._sync_cache import SyncCacheProxy as SyncCacheProxy
 
+from hishel._policies import SpecificationPolicy, FilterPolicy, CachePolicy
+
 __all__ = (
     # New API
     ## States
@@ -41,12 +44,13 @@ __all__ = (
     "StoreAndUse",
     "CouldNotBeStored",
     "InvalidateEntries",
-    "create_idle_state",
     ## Models
     "Request",
     "Response",
     "Entry",
     "EntryMeta",
+    "RequestMetadata",
+    "ResponseMetadata",
     ## Headers
     "Headers",
     ## Storages
@@ -57,4 +61,8 @@ __all__ = (
     # Proxy
     "AsyncCacheProxy",
     "SyncCacheProxy",
+    # Policies
+    "CachePolicy",
+    "SpecificationPolicy",
+    "FilterPolicy",
 )