hishel 0.0.23__py3-none-any.whl → 0.0.25__py3-none-any.whl

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/_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/_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/_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/_exceptions.py

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

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/_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/_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.dist-info → hishel-0.0.25.dist-info}/METADATA

@@ -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.dist-info → hishel-0.0.25.dist-info}/RECORD

@@ -1,8 +1,8 @@
-hishel/__init__.py,sha256=nC3vY9bcbL4hoNFGweMIdW2_1XeW9Uqrkeh2oY14LsE,369
-hishel/_controller.py,sha256=Xw8JoqGZ5QTtR0u2pZTYMyi5ZASlGlBaKSVaoVEZTOI,15241
-hishel/_exceptions.py,sha256=QjHcJeNLXtSVhvVuqxSi9eRz0QpfQNrcCLnPGex7chw,210
+hishel/__init__.py,sha256=2FeYWinWo-PLSBIu_uD-zHIKwiv2vTnc8FdWLq6hfAY,369
+hishel/_controller.py,sha256=WHpztkcL-eL04lQK4ZTLEOfg-FzmS3nHx82K5bhtT9M,15482
+hishel/_exceptions.py,sha256=qbg55RNlzwhv5JreWY9Zog_zmmiKdn5degtqJKijuRs,198
 hishel/_files.py,sha256=7J5uX7Nnzd7QQWfYuDGh8v6XGLG3eUDBjoJZ4aTaY1c,2228
-hishel/_headers.py,sha256=8M4fAkAEmUab-wFCrLyFavHP8nu1VdKksjXyOLEZKAc,7619
+hishel/_headers.py,sha256=TWuHi7sRoeS2xxdNGujKmqWtgncUqfhNGCgHKYpRU-I,7329
 hishel/_lfu_cache.py,sha256=0KJCCnwigPsZ_xKmE7AjdjPRuMFmNcjGWS-mDnbtZVQ,2730
 hishel/_s3.py,sha256=GAqEADmvalUqRoVygAK6ju3OiL23XXrxiA3cg3AWbSs,2913
 hishel/_serializers.py,sha256=-KySCCgBqRCeN3SrfJJoiHvef6irnqwYkGj4jGMOjgI,11736
@@ -11,17 +11,17 @@ hishel/_utils.py,sha256=cgLGjBI7H-T_DkYBXiHiEEf8SGjGeZ6Cc2IHbLAZybU,2501
 hishel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hishel/_async/__init__.py,sha256=_oAltH4emAtUF7_9SSxz_KKGYzSXL34o_EGgGvoPG7E,187
 hishel/_async/_client.py,sha256=AkVSSbNTTHmK0gX6PRYVQ-3aDbuCX2Im4VKbLkwLiBU,1101
-hishel/_async/_mock.py,sha256=zmPUq-15Y0GrFBejdiO-SahNnPEbym38cpR_Dz5Qp4A,1523
+hishel/_async/_mock.py,sha256=995v9p5xiw3svGSOJATkLMqwodlhZhcwmGygLHM2VFw,1515
 hishel/_async/_pool.py,sha256=3hXRG3ljG8jChHoJeI7oVHqQsFPzKNDxaq24rknKPwc,6553
-hishel/_async/_storages.py,sha256=lCbNwy1aeHskbOEIuCFIZkaNdrKgI9QuszYshlWSG1A,19176
+hishel/_async/_storages.py,sha256=I64JwCX0w6YnQH-49R5ha7UcEe3y9HCfF-uydNrGb_Q,19428
 hishel/_async/_transports.py,sha256=_UYBbLstk2I3AruGceLiazN5trnY4rDyB8kdEWeurvc,10125
 hishel/_sync/__init__.py,sha256=_oAltH4emAtUF7_9SSxz_KKGYzSXL34o_EGgGvoPG7E,187
 hishel/_sync/_client.py,sha256=O-gwm9DsveKtSFUfqdbBB-3I1FmXr5rE-uQ7X5frwDA,1060
-hishel/_sync/_mock.py,sha256=jqy89epiAIE6mk3dVzIlom-ZJVFKXWwM6k5aThSUglE,1438
+hishel/_sync/_mock.py,sha256=im88tZr-XhP9BpzvIt3uOjndAlNcJvFP7Puv3H-6lKU,1430
 hishel/_sync/_pool.py,sha256=wQFEir0gTdwLYhFcpRqo0YjF8riypgB4TFfWNHCkfRE,6348
-hishel/_sync/_storages.py,sha256=sIqfkAjZTZoE7tmlB9yJTg0bXz-q4Ck5V3IOc7FT9FA,18619
+hishel/_sync/_storages.py,sha256=IYxvTVDPP5aPw-evD0AeDYbw1oiVtIuDaAAu8iQ_N7U,18871
 hishel/_sync/_transports.py,sha256=WNgWVNjMi0WyZ8e-5pJMGOVarQEksc4_4dQjU-G9pFY,9797
-hishel-0.0.23.dist-info/METADATA,sha256=LdprkzhyFR-Z3Oj8VgUWT6v06E5fVJtwjEv1vQ3o_Wo,9999
-hishel-0.0.23.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
-hishel-0.0.23.dist-info/licenses/LICENSE,sha256=1qQj7pE0V2O9OIedvyOgLGLvZLaPd3nFEup3IBEOZjQ,1493
-hishel-0.0.23.dist-info/RECORD,,
+hishel-0.0.25.dist-info/METADATA,sha256=tlRwjxem922nV72utLunYMZ_p5FVEARS6NgNuOGCoak,10388
+hishel-0.0.25.dist-info/WHEEL,sha256=uNdcs2TADwSd5pVaP0Z_kcjcvvTUklh2S7bxZMF8Uj0,87
+hishel-0.0.25.dist-info/licenses/LICENSE,sha256=1qQj7pE0V2O9OIedvyOgLGLvZLaPd3nFEup3IBEOZjQ,1493
+hishel-0.0.25.dist-info/RECORD,,

{hishel-0.0.23.dist-info → hishel-0.0.25.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.21.1
+Generator: hatchling 1.22.4
 Root-Is-Purelib: true
 Tag: py3-none-any