hishel 0.0.23__tar.gz → 0.0.25__tar.gz

{hishel-0.0.23 → hishel-0.0.25}/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## 0.0.23 (12th February, 2024)
+## 0.0.25 (26th March, 2024)
+
+- Add `force_cache` property to the controller, allowing RFC9111 rules to be completely disabled. (#204)
+- Add `.gitignore` to cache directory created by `FIleStorage`. (#197)
+- Remove `stale_*` headers from the `CacheControl` class. (#199)
+
+## 0.0.24 (14th February, 2024)
+
+- Fix `botocore is not installed` exception when using any kind of storage. (#186)
+
+## 0.0.23 (14th February, 2024)
 
 - Make `S3Storage` to check staleness of all cache files with set interval. (#182)
 - Fix an issue where an empty file in `FileCache` could cause a parsing error. (#181)

{hishel-0.0.23 → hishel-0.0.25}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: hishel
-Version: 0.0.23
+Version: 0.0.25
 Summary: Persistent cache implementation for httpx and httpcore
 Project-URL: Homepage, https://hishel.com
 Project-URL: Source, https://github.com/karpetrosyan/hishel
@@ -175,7 +175,17 @@ Help us grow and continue developing good software for you ❤️
 
 # Changelog
 
-## 0.0.23 (12th February, 2024)
+## 0.0.25 (26th March, 2024)
+
+- Add `force_cache` property to the controller, allowing RFC9111 rules to be completely disabled. (#204)
+- Add `.gitignore` to cache directory created by `FIleStorage`. (#197)
+- Remove `stale_*` headers from the `CacheControl` class. (#199)
+
+## 0.0.24 (14th February, 2024)
+
+- Fix `botocore is not installed` exception when using any kind of storage. (#186)
+
+## 0.0.23 (14th February, 2024)
 
 - Make `S3Storage` to check staleness of all cache files with set interval. (#182)
 - Fix an issue where an empty file in `FileCache` could cause a parsing error. (#181)

{hishel-0.0.23 → hishel-0.0.25}/hishel/__init__.py

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

{hishel-0.0.23 → hishel-0.0.25}/hishel/_async/_mock.py

@@ -30,8 +30,7 @@ class MockAsyncConnectionPool(AsyncRequestInterface):
         exc_type: tp.Optional[tp.Type[BaseException]] = None,
         exc_value: tp.Optional[BaseException] = None,
         traceback: tp.Optional[TracebackType] = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
 
 class MockAsyncTransport(httpx.AsyncBaseTransport):

{hishel-0.0.23 → hishel-0.0.25}/hishel/_async/_storages.py

@@ -7,6 +7,8 @@ from pathlib import Path
 
 try:
     import boto3
+
+    from .._s3 import AsyncS3Manager
 except ImportError:  # pragma: no cover
     boto3 = None  # type: ignore
 
@@ -21,7 +23,6 @@ from typing_extensions import TypeAlias
 from hishel._serializers import BaseSerializer, clone_model
 
 from .._files import AsyncFileManager
-from .._s3 import AsyncS3Manager
 from .._serializers import JSONSerializer, Metadata
 from .._synchronization import AsyncLock
 from .._utils import float_seconds_to_int_milliseconds
@@ -82,10 +83,15 @@ class AsyncFileStorage(AsyncBaseStorage):
         super().__init__(serializer, ttl)
 
         self._base_path = Path(base_path) if base_path is not None else Path(".cache/hishel")
+        self._gitignore_file = self._base_path / ".gitignore"
 
         if not self._base_path.is_dir():
             self._base_path.mkdir(parents=True)
 
+        if not self._gitignore_file.is_file():
+            with open(self._gitignore_file, "w", encoding="utf-8") as f:
+                f.write("# Automatically created by Hishel\n*")
+
         self._file_manager = AsyncFileManager(is_binary=self._serializer.is_binary)
         self._lock = AsyncLock()
         self._check_ttl_every = check_ttl_every

{hishel-0.0.23 → hishel-0.0.25}/hishel/_controller.py

@@ -111,6 +111,7 @@ class Controller:
         clock: tp.Optional[BaseClock] = None,
         allow_stale: bool = False,
         always_revalidate: bool = False,
+        force_cache: bool = False,
         key_generator: tp.Optional[tp.Callable[[Request, tp.Optional[bytes]], str]] = None,
     ):
         self._cacheable_methods = []
@@ -131,6 +132,7 @@ class Controller:
         self._allow_heuristics = allow_heuristics
         self._allow_stale = allow_stale
         self._always_revalidate = always_revalidate
+        self._force_cache = force_cache
         self._key_generator = key_generator or generate_key
 
     def is_cachable(self, request: Request, response: Response) -> bool:
@@ -143,8 +145,9 @@ class Controller:
         lists the steps that this method simply follows.
         """
         method = request.method.decode("ascii")
+        force_cache = request.extensions.get("force_cache", None)
 
-        if request.extensions.get("force_cache", False):
+        if force_cache if force_cache is not None else self._force_cache:
             return True
 
         if response.status not in self._cacheable_status_codes:
@@ -279,7 +282,8 @@ class Controller:
             return None  # pragma: no cover
 
         # !!! this should be after the "vary" header validation.
-        if request.extensions.get("force_cache", False):
+        force_cache = request.extensions.get("force_cache", None)
+        if force_cache if force_cache is not None else self._force_cache:
             return response
 
         # the stored response does not contain the

hishel-0.0.25/hishel/_exceptions.py

@@ -0,0 +1,10 @@
+__all__ = ("CacheControlError", "ParseError", "ValidationError")
+
+
+class CacheControlError(Exception): ...
+
+
+class ParseError(CacheControlError): ...
+
+
+class ValidationError(CacheControlError): ...

{hishel-0.0.23 → hishel-0.0.25}/hishel/_headers.py

@@ -38,8 +38,6 @@ BOOLEAN_FIELDS = [
     "only_if_cached",
     "public",
     "proxy_revalidate",
-    "stale_if_error",
-    "stale_while_revalidate",
 ]
 
 LIST_FIELDS = ["no_cache", "private"]
@@ -146,8 +144,6 @@ class CacheControl:
         proxy_revalidate: bool = False,  # [RFC9111, Section 5.2.2.8]
         public: bool = False,  # [RFC9111, Section 5.2.2.9]
         s_maxage: Optional[int] = None,  # [RFC9111, Section 5.2.2.10]
-        stale_if_error: bool = False,  # [RFC5861, Section 4]
-        stale_while_revalidate: bool = False,  # [RFC5861, Section 3]
     ) -> None:
         self.immutable = immutable
         self.max_age = max_age
@@ -163,8 +159,6 @@ class CacheControl:
         self.proxy_revalidate = proxy_revalidate
         self.public = public
         self.s_maxage = s_maxage
-        self.stale_if_error = stale_if_error
-        self.stale_while_revalidate = stale_while_revalidate
 
     @classmethod
     def validate(cls, directives: Dict[str, Any]) -> Dict[str, Any]:

{hishel-0.0.23 → hishel-0.0.25}/hishel/_sync/_mock.py

@@ -30,8 +30,7 @@ class MockConnectionPool(RequestInterface):
         exc_type: tp.Optional[tp.Type[BaseException]] = None,
         exc_value: tp.Optional[BaseException] = None,
         traceback: tp.Optional[TracebackType] = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
 
 class MockTransport(httpx.BaseTransport):

{hishel-0.0.23 → hishel-0.0.25}/hishel/_sync/_storages.py

@@ -7,6 +7,8 @@ from pathlib import Path
 
 try:
     import boto3
+
+    from .._s3 import S3Manager
 except ImportError:  # pragma: no cover
     boto3 = None  # type: ignore
 
@@ -21,7 +23,6 @@ from typing_extensions import TypeAlias
 from hishel._serializers import BaseSerializer, clone_model
 
 from .._files import FileManager
-from .._s3 import S3Manager
 from .._serializers import JSONSerializer, Metadata
 from .._synchronization import Lock
 from .._utils import float_seconds_to_int_milliseconds
@@ -82,10 +83,15 @@ class FileStorage(BaseStorage):
         super().__init__(serializer, ttl)
 
         self._base_path = Path(base_path) if base_path is not None else Path(".cache/hishel")
+        self._gitignore_file = self._base_path / ".gitignore"
 
         if not self._base_path.is_dir():
             self._base_path.mkdir(parents=True)
 
+        if not self._gitignore_file.is_file():
+            with open(self._gitignore_file, "w", encoding="utf-8") as f:
+                f.write("# Automatically created by Hishel\n*")
+
         self._file_manager = FileManager(is_binary=self._serializer.is_binary)
         self._lock = Lock()
         self._check_ttl_every = check_ttl_every

{hishel-0.0.23 → hishel-0.0.25}/pyproject.toml

@@ -79,7 +79,7 @@ path = "CHANGELOG.md"
 strict = true
 show_error_codes = true
 warn_unused_ignores = false
-
+exclude = ['venv', '.venv']
 
 [[tool.mypy.overrides]]
 module = "tests.*"
@@ -112,6 +112,8 @@ exclude = [
     "tests/_sync",
 ]
 line-length = 120
+
+[tool.ruff.lint]
 select = [
     "E",
     "F",
@@ -119,5 +121,5 @@ select = [
     "I"
 ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 combine-as-imports = true

hishel-0.0.23/hishel/_exceptions.py

@@ -1,13 +0,0 @@
-__all__ = ("CacheControlError", "ParseError", "ValidationError")
-
-
-class CacheControlError(Exception):
-    ...
-
-
-class ParseError(CacheControlError):
-    ...
-
-
-class ValidationError(CacheControlError):
-    ...