hishel 0.0.27__tar.gz → 0.0.29__tar.gz

{hishel-0.0.27 → hishel-0.0.29}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.0.29 (23th June, 2024)
+
+- Documentation hotfix. (#244)
+
+## 0.0.28 (23th June, 2024)
+
+- Add `revalidated` response extension. (#242)
+
 ## 0.0.27 (31th May, 2024)
 
 - Fix `RedisStorage` when using without ttl. (#231)

{hishel-0.0.27 → hishel-0.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hishel
-Version: 0.0.27
+Version: 0.0.29
 Summary: Persistent cache implementation for httpx and httpcore
 Project-URL: Homepage, https://hishel.com
 Project-URL: Source, https://github.com/karpetrosyan/hishel
@@ -57,8 +57,8 @@ Description-Content-Type: text/markdown
       <img src="https://img.shields.io/codecov/c/github/karpetrosyan/hishel" alt="license">
   </a>
 
-  <a href="https://static.pepy.tech/badge/hishel/month">
-      <img src="https://static.pepy.tech/badge/hishel/month" alt="Downloads">
+  <a href="https://github.com/karpetrosyan/hishel">
+      <img src="https://img.shields.io/pypi/dm/hishel.svg" alt="Downloads">
   </a>
 </p>
 
@@ -175,6 +175,14 @@ Help us grow and continue developing good software for you ❤️
 
 # Changelog
 
+## 0.0.29 (23th June, 2024)
+
+- Documentation hotfix. (#244)
+
+## 0.0.28 (23th June, 2024)
+
+- Add `revalidated` response extension. (#242)
+
 ## 0.0.27 (31th May, 2024)
 
 - Fix `RedisStorage` when using without ttl. (#231)

{hishel-0.0.27 → hishel-0.0.29}/README.md

@@ -19,8 +19,8 @@
       <img src="https://img.shields.io/codecov/c/github/karpetrosyan/hishel" alt="license">
   </a>
 
-  <a href="https://static.pepy.tech/badge/hishel/month">
-      <img src="https://static.pepy.tech/badge/hishel/month" alt="Downloads">
+  <a href="https://github.com/karpetrosyan/hishel">
+      <img src="https://img.shields.io/pypi/dm/hishel.svg" alt="Downloads">
   </a>
 </p>
 

{hishel-0.0.27 → hishel-0.0.29}/hishel/__init__.py

@@ -14,4 +14,4 @@ def install_cache() -> None:  # pragma: no cover
     httpx.Client = CacheClient  # type: ignore
 
 
-__version__ = "0.0.27"
+__version__ = "0.0.29"

{hishel-0.0.27 → hishel-0.0.29}/hishel/_async/_pool.py

@@ -100,7 +100,12 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
             if isinstance(res, Response):
                 # Simply use the response if the controller determines it is ready for use.
                 return await self._create_hishel_response(
-                    key=key, response=stored_response, request=request, metadata=metadata, cached=True
+                    key=key,
+                    response=stored_response,
+                    request=request,
+                    metadata=metadata,
+                    cached=True,
+                    revalidated=False,
                 )
 
             if request_cache_control.only_if_cached:
@@ -115,7 +120,12 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
                     # If there is a connection error, we can use the stale response if allowed.
                     if self._controller._allow_stale and allowed_stale(response=stored_response):
                         return await self._create_hishel_response(
-                            key=key, response=stored_response, request=request, metadata=metadata, cached=True
+                            key=key,
+                            response=stored_response,
+                            request=request,
+                            metadata=metadata,
+                            cached=True,
+                            revalidated=False,
                         )
                     raise  # pragma: no cover
                 # Merge headers with the stale response.
@@ -130,6 +140,7 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
                     request=request,
                     metadata=metadata,
                     cached=revalidation_response.status == 304,
+                    revalidated=True,
                 )
 
         regular_response = await self._pool.handle_async_request(request)
@@ -141,7 +152,9 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
             )
             await self._storage.store(key, response=regular_response, request=request, metadata=metadata)
 
-        return await self._create_hishel_response(key=key, response=regular_response, request=request, cached=False)
+        return await self._create_hishel_response(
+            key=key, response=regular_response, request=request, cached=False, revalidated=False
+        )
 
     async def _create_hishel_response(
         self,
@@ -149,6 +162,7 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
         response: Response,
         request: Request,
         cached: bool,
+        revalidated: bool,
         metadata: Metadata | None = None,
     ) -> Response:
         if cached:
@@ -159,6 +173,7 @@ class AsyncCacheConnectionPool(AsyncRequestInterface):
             response.extensions["cache_metadata"] = metadata  # type: ignore[index]
         else:
             response.extensions["from_cache"] = False  # type: ignore[index]
+        response.extensions["revalidated"] = revalidated  # type: ignore[index]
         return response
 
     async def aclose(self) -> None:

{hishel-0.0.27 → hishel-0.0.29}/hishel/_async/_storages.py

@@ -225,16 +225,14 @@ class AsyncSQLiteStorage(AsyncBaseStorage):
     def __init__(
         self,
         serializer: tp.Optional[BaseSerializer] = None,
-        connection: tp.Optional["anysqlite.Connection"] = None,
+        connection: tp.Optional[anysqlite.Connection] = None,
         ttl: tp.Optional[tp.Union[int, float]] = None,
     ) -> None:
         if anysqlite is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `sqlite` extension as shown.\n"
-                    "```pip install hishel[sqlite]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `sqlite` extension as shown.\n"
+                "```pip install hishel[sqlite]```"
             )
         super().__init__(serializer, ttl)
 
@@ -249,7 +247,7 @@ class AsyncSQLiteStorage(AsyncBaseStorage):
                 if not self._connection:  # pragma: no cover
                     self._connection = await anysqlite.connect(".hishel.sqlite", check_same_thread=False)
                 await self._connection.execute(
-                    ("CREATE TABLE IF NOT EXISTS cache(key TEXT, data BLOB, date_created REAL)")
+                    "CREATE TABLE IF NOT EXISTS cache(key TEXT, data BLOB, date_created REAL)"
                 )
                 await self._connection.commit()
                 self._setup_completed = True
@@ -363,16 +361,14 @@ class AsyncRedisStorage(AsyncBaseStorage):
     def __init__(
         self,
         serializer: tp.Optional[BaseSerializer] = None,
-        client: tp.Optional["redis.Redis"] = None,  # type: ignore
+        client: tp.Optional[redis.Redis] = None,  # type: ignore
         ttl: tp.Optional[tp.Union[int, float]] = None,
     ) -> None:
         if redis is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `redis` extension as shown.\n"
-                    "```pip install hishel[redis]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `redis` extension as shown.\n"
+                "```pip install hishel[redis]```"
             )
         super().__init__(serializer, ttl)
 
@@ -599,11 +595,9 @@ class AsyncS3Storage(AsyncBaseStorage):  # pragma: no cover
 
         if boto3 is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `s3` extension as shown.\n"
-                    "```pip install hishel[s3]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `s3` extension as shown.\n"
+                "```pip install hishel[s3]```"
             )
 
         self._bucket_name = bucket_name

{hishel-0.0.27 → hishel-0.0.29}/hishel/_async/_transports.py

@@ -141,6 +141,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
                     response=res,
                     request=httpcore_request,
                     cached=True,
+                    revalidated=False,
                     metadata=metadata,
                 )
 
@@ -166,6 +167,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
                             response=stored_response,
                             request=httpcore_request,
                             cached=True,
+                            revalidated=False,
                             metadata=metadata,
                         )
                     raise  # pragma: no cover
@@ -191,6 +193,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
                     response=final_httpcore_response,
                     request=httpcore_request,
                     cached=revalidation_response.status_code == 304,
+                    revalidated=True,
                     metadata=metadata,
                 )
 
@@ -217,6 +220,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
             response=httpcore_regular_response,
             request=httpcore_request,
             cached=False,
+            revalidated=False,
         )
 
     async def _create_hishel_response(
@@ -225,6 +229,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
         response: httpcore.Response,
         request: httpcore.Request,
         cached: bool,
+        revalidated: bool,
         metadata: Metadata | None = None,
     ) -> Response:
         if cached:
@@ -235,6 +240,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
             response.extensions["cache_metadata"] = metadata  # type: ignore[index]
         else:
             response.extensions["from_cache"] = False  # type: ignore[index]
+        response.extensions["revalidated"] = revalidated  # type: ignore[index]
         return Response(
             status_code=response.status,
             headers=response.headers,
@@ -246,7 +252,7 @@ class AsyncCacheTransport(httpx.AsyncBaseTransport):
         await self._storage.aclose()
         await self._transport.aclose()
 
-    async def __aenter__(self) -> "Self":
+    async def __aenter__(self) -> Self:
         return self
 
     async def __aexit__(

{hishel-0.0.27 → hishel-0.0.29}/hishel/_lfu_cache.py

@@ -68,5 +68,4 @@ class LFUCache(Generic[K, V]):
             del self.cache[key]
 
     def __iter__(self) -> Iterator[K]:
-        for key in self.cache:
-            yield key
+        yield from self.cache

{hishel-0.0.27 → hishel-0.0.29}/hishel/_serializers.py

@@ -224,11 +224,9 @@ class YAMLSerializer(BaseSerializer):
         """
         if yaml is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `yaml` extension as shown.\n"
-                    "```pip install hishel[yaml]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `yaml` extension as shown.\n"
+                "```pip install hishel[yaml]```"
             )
         response_dict = {
             "status": response.status,
@@ -278,11 +276,9 @@ class YAMLSerializer(BaseSerializer):
         """
         if yaml is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `yaml` extension as shown.\n"
-                    "```pip install hishel[yaml]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `yaml` extension as shown.\n"
+                "```pip install hishel[yaml]```"
             )
 
         full_json = yaml.safe_load(data)

{hishel-0.0.27 → hishel-0.0.29}/hishel/_sync/_pool.py

@@ -100,7 +100,12 @@ class CacheConnectionPool(RequestInterface):
             if isinstance(res, Response):
                 # Simply use the response if the controller determines it is ready for use.
                 return self._create_hishel_response(
-                    key=key, response=stored_response, request=request, metadata=metadata, cached=True
+                    key=key,
+                    response=stored_response,
+                    request=request,
+                    metadata=metadata,
+                    cached=True,
+                    revalidated=False,
                 )
 
             if request_cache_control.only_if_cached:
@@ -115,7 +120,12 @@ class CacheConnectionPool(RequestInterface):
                     # If there is a connection error, we can use the stale response if allowed.
                     if self._controller._allow_stale and allowed_stale(response=stored_response):
                         return self._create_hishel_response(
-                            key=key, response=stored_response, request=request, metadata=metadata, cached=True
+                            key=key,
+                            response=stored_response,
+                            request=request,
+                            metadata=metadata,
+                            cached=True,
+                            revalidated=False,
                         )
                     raise  # pragma: no cover
                 # Merge headers with the stale response.
@@ -130,6 +140,7 @@ class CacheConnectionPool(RequestInterface):
                     request=request,
                     metadata=metadata,
                     cached=revalidation_response.status == 304,
+                    revalidated=True,
                 )
 
         regular_response = self._pool.handle_request(request)
@@ -141,7 +152,9 @@ class CacheConnectionPool(RequestInterface):
             )
             self._storage.store(key, response=regular_response, request=request, metadata=metadata)
 
-        return self._create_hishel_response(key=key, response=regular_response, request=request, cached=False)
+        return self._create_hishel_response(
+            key=key, response=regular_response, request=request, cached=False, revalidated=False
+        )
 
     def _create_hishel_response(
         self,
@@ -149,6 +162,7 @@ class CacheConnectionPool(RequestInterface):
         response: Response,
         request: Request,
         cached: bool,
+        revalidated: bool,
         metadata: Metadata | None = None,
     ) -> Response:
         if cached:
@@ -159,6 +173,7 @@ class CacheConnectionPool(RequestInterface):
             response.extensions["cache_metadata"] = metadata  # type: ignore[index]
         else:
             response.extensions["from_cache"] = False  # type: ignore[index]
+        response.extensions["revalidated"] = revalidated  # type: ignore[index]
         return response
 
     def close(self) -> None:

{hishel-0.0.27 → hishel-0.0.29}/hishel/_sync/_storages.py

@@ -225,16 +225,14 @@ class SQLiteStorage(BaseStorage):
     def __init__(
         self,
         serializer: tp.Optional[BaseSerializer] = None,
-        connection: tp.Optional["sqlite3.Connection"] = None,
+        connection: tp.Optional[sqlite3.Connection] = None,
         ttl: tp.Optional[tp.Union[int, float]] = None,
     ) -> None:
         if sqlite3 is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `sqlite` extension as shown.\n"
-                    "```pip install hishel[sqlite]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `sqlite` extension as shown.\n"
+                "```pip install hishel[sqlite]```"
             )
         super().__init__(serializer, ttl)
 
@@ -249,7 +247,7 @@ class SQLiteStorage(BaseStorage):
                 if not self._connection:  # pragma: no cover
                     self._connection = sqlite3.connect(".hishel.sqlite", check_same_thread=False)
                 self._connection.execute(
-                    ("CREATE TABLE IF NOT EXISTS cache(key TEXT, data BLOB, date_created REAL)")
+                    "CREATE TABLE IF NOT EXISTS cache(key TEXT, data BLOB, date_created REAL)"
                 )
                 self._connection.commit()
                 self._setup_completed = True
@@ -363,16 +361,14 @@ class RedisStorage(BaseStorage):
     def __init__(
         self,
         serializer: tp.Optional[BaseSerializer] = None,
-        client: tp.Optional["redis.Redis"] = None,  # type: ignore
+        client: tp.Optional[redis.Redis] = None,  # type: ignore
         ttl: tp.Optional[tp.Union[int, float]] = None,
     ) -> None:
         if redis is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `redis` extension as shown.\n"
-                    "```pip install hishel[redis]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `redis` extension as shown.\n"
+                "```pip install hishel[redis]```"
             )
         super().__init__(serializer, ttl)
 
@@ -599,11 +595,9 @@ class S3Storage(BaseStorage):  # pragma: no cover
 
         if boto3 is None:  # pragma: no cover
             raise RuntimeError(
-                (
-                    f"The `{type(self).__name__}` was used, but the required packages were not found. "
-                    "Check that you have `Hishel` installed with the `s3` extension as shown.\n"
-                    "```pip install hishel[s3]```"
-                )
+                f"The `{type(self).__name__}` was used, but the required packages were not found. "
+                "Check that you have `Hishel` installed with the `s3` extension as shown.\n"
+                "```pip install hishel[s3]```"
             )
 
         self._bucket_name = bucket_name

{hishel-0.0.27 → hishel-0.0.29}/hishel/_sync/_transports.py

@@ -141,6 +141,7 @@ class CacheTransport(httpx.BaseTransport):
                     response=res,
                     request=httpcore_request,
                     cached=True,
+                    revalidated=False,
                     metadata=metadata,
                 )
 
@@ -166,6 +167,7 @@ class CacheTransport(httpx.BaseTransport):
                             response=stored_response,
                             request=httpcore_request,
                             cached=True,
+                            revalidated=False,
                             metadata=metadata,
                         )
                     raise  # pragma: no cover
@@ -191,6 +193,7 @@ class CacheTransport(httpx.BaseTransport):
                     response=final_httpcore_response,
                     request=httpcore_request,
                     cached=revalidation_response.status_code == 304,
+                    revalidated=True,
                     metadata=metadata,
                 )
 
@@ -217,6 +220,7 @@ class CacheTransport(httpx.BaseTransport):
             response=httpcore_regular_response,
             request=httpcore_request,
             cached=False,
+            revalidated=False,
         )
 
     def _create_hishel_response(
@@ -225,6 +229,7 @@ class CacheTransport(httpx.BaseTransport):
         response: httpcore.Response,
         request: httpcore.Request,
         cached: bool,
+        revalidated: bool,
         metadata: Metadata | None = None,
     ) -> Response:
         if cached:
@@ -235,6 +240,7 @@ class CacheTransport(httpx.BaseTransport):
             response.extensions["cache_metadata"] = metadata  # type: ignore[index]
         else:
             response.extensions["from_cache"] = False  # type: ignore[index]
+        response.extensions["revalidated"] = revalidated  # type: ignore[index]
         return Response(
             status_code=response.status,
             headers=response.headers,
@@ -246,7 +252,7 @@ class CacheTransport(httpx.BaseTransport):
         self._storage.close()
         self._transport.close()
 
-    def __enter__(self) -> "Self":
+    def __enter__(self) -> Self:
         return self
 
     def __exit__(