CacheControl 0.14.0__tar.gz → 0.14.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/PKG-INFO +11 -10
  2. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/__init__.py +2 -1
  3. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/adapter.py +15 -8
  4. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/cache.py +1 -0
  5. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/caches/file_cache.py +11 -48
  6. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/controller.py +13 -1
  7. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/filewrapper.py +2 -2
  8. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/heuristics.py +4 -1
  9. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/pyproject.toml +8 -7
  10. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/conftest.py +1 -1
  11. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/issue_263.py +0 -3
  12. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_adapter.py +23 -1
  13. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_cache_control.py +5 -4
  14. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_redirects.py +1 -0
  15. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_serialization.py +0 -1
  16. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_storage_filecache.py +1 -0
  17. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/LICENSE.txt +0 -0
  18. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/README.rst +0 -0
  19. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/_cmd.py +0 -0
  20. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/caches/__init__.py +0 -0
  21. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/caches/redis_cache.py +0 -0
  22. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/py.typed +0 -0
  23. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/serialize.py +0 -0
  24. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/cachecontrol/wrapper.py +0 -0
  25. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/__init__.py +0 -0
  26. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_chunked_response.py +0 -0
  27. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_etag.py +0 -0
  28. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_expires_heuristics.py +0 -0
  29. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_max_age.py +0 -0
  30. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_regressions.py +0 -0
  31. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_server_http_version.py +0 -0
  32. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_storage_redis.py +0 -0
  33. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/test_vary.py +0 -0
  34. {cachecontrol-0.14.0 → cachecontrol-0.14.2}/tests/utils.py +0 -0
@@ -1,35 +1,36 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.3
2
2
  Name: CacheControl
3
- Version: 0.14.0
3
+ Version: 0.14.2
4
4
  Summary: httplib2 caching for requests
5
5
  Keywords: requests,http,caching,web
6
6
  Author-email: Eric Larson <ericlarson@ionrock.com>, Frost Ming <me@frostming.com>, William Woodruff <william@yossarian.net>
7
- Requires-Python: >=3.7
7
+ Requires-Python: >=3.8
8
8
  Description-Content-Type: text/x-rst
9
9
  Classifier: Development Status :: 4 - Beta
10
10
  Classifier: Environment :: Web Environment
11
11
  Classifier: License :: OSI Approved :: Apache Software License
12
12
  Classifier: Operating System :: OS Independent
13
- Classifier: Programming Language :: Python :: 3.7
14
13
  Classifier: Programming Language :: Python :: 3.8
15
14
  Classifier: Programming Language :: Python :: 3.9
16
15
  Classifier: Programming Language :: Python :: 3.10
17
16
  Classifier: Programming Language :: Python :: 3.11
18
17
  Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
19
  Classifier: Topic :: Internet :: WWW/HTTP
20
20
  Requires-Dist: requests >= 2.16.0
21
21
  Requires-Dist: msgpack >= 0.5.2, < 2.0.0
22
- Requires-Dist: CacheControl[filecache,redis] ; extra == "dev"
22
+ Requires-Dist: CacheControl[filecache, redis] ; extra == "dev"
23
23
  Requires-Dist: build ; extra == "dev"
24
+ Requires-Dist: cherrypy ; extra == "dev"
25
+ Requires-Dist: codespell[tomli] ; extra == "dev"
26
+ Requires-Dist: furo ; extra == "dev"
24
27
  Requires-Dist: mypy ; extra == "dev"
25
- Requires-Dist: tox ; extra == "dev"
26
- Requires-Dist: pytest-cov ; extra == "dev"
27
28
  Requires-Dist: pytest ; extra == "dev"
28
- Requires-Dist: cherrypy ; extra == "dev"
29
+ Requires-Dist: pytest-cov ; extra == "dev"
30
+ Requires-Dist: ruff ; extra == "dev"
29
31
  Requires-Dist: sphinx ; extra == "dev"
30
- Requires-Dist: furo ; extra == "dev"
31
32
  Requires-Dist: sphinx-copybutton ; extra == "dev"
32
- Requires-Dist: black ; extra == "dev"
33
+ Requires-Dist: tox ; extra == "dev"
33
34
  Requires-Dist: types-redis ; extra == "dev"
34
35
  Requires-Dist: types-requests ; extra == "dev"
35
36
  Requires-Dist: filelock >= 3.8.0 ; extra == "filecache"
@@ -6,9 +6,10 @@
6
6
 
7
7
  Make it easy to import from cachecontrol without long namespaces.
8
8
  """
9
+
9
10
  __author__ = "Eric Larson"
10
11
  __email__ = "eric@ionrock.org"
11
- __version__ = "0.14.0"
12
+ __version__ = "0.14.2"
12
13
 
13
14
  from cachecontrol.adapter import CacheControlAdapter
14
15
  from cachecontrol.controller import CacheController
@@ -5,6 +5,7 @@ from __future__ import annotations
5
5
 
6
6
  import functools
7
7
  import types
8
+ import weakref
8
9
  import zlib
9
10
  from typing import TYPE_CHECKING, Any, Collection, Mapping
10
11
 
@@ -77,7 +78,7 @@ class CacheControlAdapter(HTTPAdapter):
77
78
 
78
79
  return resp
79
80
 
80
- def build_response(
81
+ def build_response( # type: ignore[override]
81
82
  self,
82
83
  request: PreparedRequest,
83
84
  response: HTTPResponse,
@@ -128,22 +129,28 @@ class CacheControlAdapter(HTTPAdapter):
128
129
  response._fp = CallbackFileWrapper( # type: ignore[assignment]
129
130
  response._fp, # type: ignore[arg-type]
130
131
  functools.partial(
131
- self.controller.cache_response, request, response
132
+ self.controller.cache_response, request, weakref.ref(response)
132
133
  ),
133
134
  )
134
135
  if response.chunked:
135
- super_update_chunk_length = response._update_chunk_length
136
+ super_update_chunk_length = response.__class__._update_chunk_length
136
137
 
137
- def _update_chunk_length(self: HTTPResponse) -> None:
138
- super_update_chunk_length()
138
+ def _update_chunk_length(
139
+ weak_self: weakref.ReferenceType[HTTPResponse],
140
+ ) -> None:
141
+ self = weak_self()
142
+ if self is None:
143
+ return
144
+
145
+ super_update_chunk_length(self)
139
146
  if self.chunk_left == 0:
140
147
  self._fp._close() # type: ignore[union-attr]
141
148
 
142
- response._update_chunk_length = types.MethodType( # type: ignore[method-assign]
143
- _update_chunk_length, response
149
+ response._update_chunk_length = functools.partial( # type: ignore[method-assign]
150
+ _update_chunk_length, weakref.ref(response)
144
151
  )
145
152
 
146
- resp: Response = super().build_response(request, response) # type: ignore[no-untyped-call]
153
+ resp: Response = super().build_response(request, response)
147
154
 
148
155
  # See if we should invalidate the cache.
149
156
  if request.method in self.invalidating_methods and resp.ok:
@@ -6,6 +6,7 @@
6
6
  The cache object API for implementing caches. The default is a thread
7
7
  safe in-memory dictionary.
8
8
  """
9
+
9
10
  from __future__ import annotations
10
11
 
11
12
  from threading import Lock
@@ -5,8 +5,9 @@ from __future__ import annotations
5
5
 
6
6
  import hashlib
7
7
  import os
8
+ import tempfile
8
9
  from textwrap import dedent
9
- from typing import IO, TYPE_CHECKING, Union
10
+ from typing import IO, TYPE_CHECKING
10
11
  from pathlib import Path
11
12
 
12
13
  from cachecontrol.cache import BaseCache, SeparateBodyBaseCache
@@ -18,47 +19,6 @@ if TYPE_CHECKING:
18
19
  from filelock import BaseFileLock
19
20
 
20
21
 
21
- def _secure_open_write(filename: str, fmode: int) -> IO[bytes]:
22
- # We only want to write to this file, so open it in write only mode
23
- flags = os.O_WRONLY
24
-
25
- # os.O_CREAT | os.O_EXCL will fail if the file already exists, so we only
26
- # will open *new* files.
27
- # We specify this because we want to ensure that the mode we pass is the
28
- # mode of the file.
29
- flags |= os.O_CREAT | os.O_EXCL
30
-
31
- # Do not follow symlinks to prevent someone from making a symlink that
32
- # we follow and insecurely open a cache file.
33
- if hasattr(os, "O_NOFOLLOW"):
34
- flags |= os.O_NOFOLLOW
35
-
36
- # On Windows we'll mark this file as binary
37
- if hasattr(os, "O_BINARY"):
38
- flags |= os.O_BINARY
39
-
40
- # Before we open our file, we want to delete any existing file that is
41
- # there
42
- try:
43
- os.remove(filename)
44
- except OSError:
45
- # The file must not exist already, so we can just skip ahead to opening
46
- pass
47
-
48
- # Open our file, the use of os.O_CREAT | os.O_EXCL will ensure that if a
49
- # race condition happens between the os.remove and this line, that an
50
- # error will be raised. Because we utilize a lockfile this should only
51
- # happen if someone is attempting to attack us.
52
- fd = os.open(filename, flags, fmode)
53
- try:
54
- return os.fdopen(fd, "wb")
55
-
56
- except:
57
- # An error occurred wrapping our FD in a file object
58
- os.close(fd)
59
- raise
60
-
61
-
62
22
  class _FileCacheMixin:
63
23
  """Shared implementation for both FileCache variants."""
64
24
 
@@ -122,15 +82,18 @@ class _FileCacheMixin:
122
82
  Safely write the data to the given path.
123
83
  """
124
84
  # Make sure the directory exists
125
- try:
126
- os.makedirs(os.path.dirname(path), self.dirmode)
127
- except OSError:
128
- pass
85
+ dirname = os.path.dirname(path)
86
+ os.makedirs(dirname, self.dirmode, exist_ok=True)
129
87
 
130
88
  with self.lock_class(path + ".lock"):
131
89
  # Write our actual file
132
- with _secure_open_write(path, self.filemode) as fh:
133
- fh.write(data)
90
+ (fd, name) = tempfile.mkstemp(dir=dirname)
91
+ try:
92
+ os.write(fd, data)
93
+ finally:
94
+ os.close(fd)
95
+ os.chmod(name, self.filemode)
96
+ os.replace(name, path)
134
97
 
135
98
  def _delete(self, key: str, suffix: str) -> None:
136
99
  name = self._fn(key) + suffix
@@ -5,12 +5,14 @@
5
5
  """
6
6
  The httplib2 algorithms ported for use with requests.
7
7
  """
8
+
8
9
  from __future__ import annotations
9
10
 
10
11
  import calendar
11
12
  import logging
12
13
  import re
13
14
  import time
15
+ import weakref
14
16
  from email.utils import parsedate_tz
15
17
  from typing import TYPE_CHECKING, Collection, Mapping
16
18
 
@@ -322,7 +324,7 @@ class CacheController:
322
324
  def cache_response(
323
325
  self,
324
326
  request: PreparedRequest,
325
- response: HTTPResponse,
327
+ response_or_ref: HTTPResponse | weakref.ReferenceType[HTTPResponse],
326
328
  body: bytes | None = None,
327
329
  status_codes: Collection[int] | None = None,
328
330
  ) -> None:
@@ -331,6 +333,16 @@ class CacheController:
331
333
 
332
334
  This assumes a requests Response object.
333
335
  """
336
+ if isinstance(response_or_ref, weakref.ReferenceType):
337
+ response = response_or_ref()
338
+ if response is None:
339
+ # The weakref can be None only in case the user used streamed request
340
+ # and did not consume or close it, and holds no reference to requests.Response.
341
+ # In such case, we don't want to cache the response.
342
+ return
343
+ else:
344
+ response = response_or_ref
345
+
334
346
  # From httplib2: Don't cache 206's since we aren't going to
335
347
  # handle byte range requests
336
348
  cacheable_status_codes = status_codes or self.cacheable_status_codes
@@ -38,10 +38,10 @@ class CallbackFileWrapper:
38
38
  self.__callback = callback
39
39
 
40
40
  def __getattr__(self, name: str) -> Any:
41
- # The vaguaries of garbage collection means that self.__fp is
41
+ # The vagaries of garbage collection means that self.__fp is
42
42
  # not always set. By using __getattribute__ and the private
43
43
  # name[0] allows looking up the attribute value and raising an
44
- # AttributeError when it doesn't exist. This stop thigns from
44
+ # AttributeError when it doesn't exist. This stop things from
45
45
  # infinitely recursing calls to getattr in the case where
46
46
  # self.__fp hasn't been set.
47
47
  #
@@ -68,7 +68,10 @@ class OneDayCache(BaseHeuristic):
68
68
 
69
69
  if "expires" not in response.headers:
70
70
  date = parsedate(response.headers["date"])
71
- expires = expire_after(timedelta(days=1), date=datetime(*date[:6], tzinfo=timezone.utc)) # type: ignore[index,misc]
71
+ expires = expire_after(
72
+ timedelta(days=1),
73
+ date=datetime(*date[:6], tzinfo=timezone.utc), # type: ignore[index,misc]
74
+ )
72
75
  headers["expires"] = datetime_to_header(expires)
73
76
  headers["cache-control"] = "public"
74
77
  return headers
@@ -24,17 +24,17 @@ classifiers = [
24
24
  "Environment :: Web Environment",
25
25
  "License :: OSI Approved :: Apache Software License",
26
26
  "Operating System :: OS Independent",
27
- "Programming Language :: Python :: 3.7",
28
27
  "Programming Language :: Python :: 3.8",
29
28
  "Programming Language :: Python :: 3.9",
30
29
  "Programming Language :: Python :: 3.10",
31
30
  "Programming Language :: Python :: 3.11",
32
31
  "Programming Language :: Python :: 3.12",
32
+ "Programming Language :: Python :: 3.13",
33
33
  "Topic :: Internet :: WWW/HTTP",
34
34
  ]
35
35
  keywords = ["requests", "http", "caching", "web"]
36
36
  dependencies = ["requests >= 2.16.0", "msgpack >= 0.5.2, < 2.0.0"]
37
- requires-python = ">=3.7"
37
+ requires-python = ">=3.8"
38
38
 
39
39
  [project.urls]
40
40
  Homepage = "https://pypi.org/project/CacheControl/"
@@ -50,15 +50,16 @@ redis = ["redis>=2.10.5"]
50
50
  dev = [
51
51
  "CacheControl[filecache,redis]",
52
52
  "build",
53
+ "cherrypy",
54
+ "codespell[tomli]",
55
+ "furo",
53
56
  "mypy",
54
- "tox",
55
- "pytest-cov",
56
57
  "pytest",
57
- "cherrypy",
58
+ "pytest-cov",
59
+ "ruff",
58
60
  "sphinx",
59
- "furo",
60
61
  "sphinx-copybutton",
61
- "black",
62
+ "tox",
62
63
  "types-redis",
63
64
  "types-requests",
64
65
  ]
@@ -160,5 +160,5 @@ def pytest_configure(config):
160
160
  def pytest_unconfigure(config):
161
161
  try:
162
162
  cherrypy.server.stop()
163
- except:
163
+ except: # noqa: E722
164
164
  pass
@@ -13,9 +13,6 @@ clogger.addHandler(logging.StreamHandler())
13
13
  clogger.setLevel(logging.DEBUG)
14
14
 
15
15
 
16
- from pprint import pprint
17
-
18
-
19
16
  class NoAgeHeuristic(BaseHeuristic):
20
17
  def update_headers(self, response):
21
18
  if "cache-control" in response.headers:
@@ -2,10 +2,13 @@
2
2
  #
3
3
  # SPDX-License-Identifier: Apache-2.0
4
4
 
5
+ import gc
6
+ import weakref
5
7
  from unittest import mock
6
- import pytest
7
8
 
9
+ import pytest
8
10
  from requests import Session
11
+
9
12
  from cachecontrol.adapter import CacheControlAdapter
10
13
  from cachecontrol.cache import DictCache
11
14
  from cachecontrol.wrapper import CacheControl
@@ -65,3 +68,22 @@ class TestSessionActions:
65
68
 
66
69
  sess.close()
67
70
  assert cache.close.called
71
+
72
+ def test_do_not_leak_response(self, url, sess):
73
+ resp = sess.get(url + "stream", stream=True)
74
+ resp.raise_for_status()
75
+ r1_weak = weakref.ref(resp.raw)
76
+
77
+ # This is a mis-use of requests, becase we should either consume
78
+ # the body, or call .close().
79
+ # But requests without cachecontrol handle this anyway, because
80
+ # urllib3.response.HTTPResponse has a __del__ finalizer on it that closes it
81
+ # once there are no more references to it.
82
+ # We should not break this.
83
+
84
+ resp = None
85
+ # Below this point, it should be closed because there are no more references
86
+ # to the session response.
87
+
88
+ r1 = r1_weak()
89
+ assert r1 is None or r1.closed
@@ -5,8 +5,9 @@
5
5
  """
6
6
  Unit tests that verify our caching methods work correctly.
7
7
  """
8
+
9
+ import os
8
10
  import time
9
- from tempfile import mkdtemp
10
11
  from unittest.mock import ANY, Mock
11
12
 
12
13
  import pytest
@@ -142,7 +143,7 @@ class TestCacheControllerResponse:
142
143
  result = cc.update_cached_response(req, resp)
143
144
  assert result is resp
144
145
 
145
- def test_update_cached_response_with_valid_headers_separate_body(self):
146
+ def test_update_cached_response_with_valid_headers_separate_body(self, tmp_path):
146
147
  """
147
148
  If the local cache has the given URL ``update_cached_response()`` will:
148
149
 
@@ -151,7 +152,7 @@ class TestCacheControllerResponse:
151
152
 
152
153
  This is the version for a cache that stores a separate body.
153
154
  """
154
- cache = SeparateBodyFileCache(mkdtemp())
155
+ cache = SeparateBodyFileCache(os.fsdecode(tmp_path))
155
156
  self.update_cached_response_with_valid_headers_test(cache)
156
157
 
157
158
  def test_update_cached_response_with_valid_headers(self):
@@ -175,7 +176,7 @@ class TestCacheControllerResponse:
175
176
 
176
177
  This is the shared utility for any cache object.
177
178
  """
178
- # Cache starts out prepopulated wih an entry:
179
+ # Cache starts out prepopulated with an entry:
179
180
  etag = "jfd9094r808"
180
181
  cc = CacheController(cache)
181
182
  url = "http://localhost:123/x"
@@ -5,6 +5,7 @@
5
5
  """
6
6
  Test for supporting redirect caches as needed.
7
7
  """
8
+
8
9
  import requests
9
10
 
10
11
  from cachecontrol import CacheControl
@@ -2,7 +2,6 @@
2
2
  #
3
3
  # SPDX-License-Identifier: Apache-2.0
4
4
 
5
- import pickle
6
5
  from unittest.mock import Mock
7
6
 
8
7
  import msgpack
@@ -5,6 +5,7 @@
5
5
  """
6
6
  Unit tests that verify FileCache storage works correctly.
7
7
  """
8
+
8
9
  import os
9
10
  import string
10
11
 
File without changes
File without changes