requests-cache 1.2.0__tar.gz → 1.3.0__tar.gz

requests_cache-1.3.0/.gitignore

@@ -0,0 +1,42 @@
+build/
+dist/
+downloads/
+example_cache/
+http_cache/
+benchmark_cache/
+scratch
+venv/
+
+*.db
+*.egg
+*.egg-info
+*.py[cod]
+*.sqlite
+*.sqlite-journal
+.venv
+Pipfile
+profile.json
+
+# JS
+node_modules/
+package-lock.json
+package.json
+
+# Editors
+.~*
+.idea/
+.vim/
+.vscode/
+
+# Test / coverage reports
+.coverage
+.coverage.*
+.COVERAGE.*
+.mypy_cache/
+.nox/
+test-reports/
+
+# Sphinx / Readthedocs
+docs/_build/
+docs/modules/
+docs/requirements.txt

{requests_cache-1.2.0 → requests_cache-1.3.0}/PKG-INFO

@@ -1,66 +1,58 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: requests-cache
-Version: 1.2.0
+Version: 1.3.0
 Summary: A persistent cache for python requests
-Home-page: https://github.com/requests-cache/requests-cache
-License: BSD-2-Clause
-Keywords: requests,python-requests,cache,http,http-client,web,webscraping,performance,sqlite,redis,mongodb,gridfs,dynamodb
-Author: Roman Haritonov
-Requires-Python: >=3.8
+Project-URL: homepage, https://github.com/requests-cache/requests-cache
+Project-URL: repository, https://github.com/requests-cache/requests-cache
+Project-URL: documentation, https://requests-cache.readthedocs.io
+Author: Jordan Cook, Roman Haritonov
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+Keywords: cache,dynamodb,http,http-client,mongodb,performance,python-requests,redis,requests,sqlite,web,webscraping
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: attrs>=21.2
+Requires-Dist: cattrs>=22.2
+Requires-Dist: platformdirs>=2.5
+Requires-Dist: requests>=2.22
+Requires-Dist: url-normalize>=2.0
+Requires-Dist: urllib3>=1.25.5
 Provides-Extra: all
-Provides-Extra: bson
-Provides-Extra: docs
+Requires-Dist: boto3>=1.15; extra == 'all'
+Requires-Dist: botocore>=1.18; extra == 'all'
+Requires-Dist: itsdangerous>=2.0; extra == 'all'
+Requires-Dist: orjson>=3.0; extra == 'all'
+Requires-Dist: pymongo>=3; extra == 'all'
+Requires-Dist: pyyaml>=6.0.1; extra == 'all'
+Requires-Dist: redis>=3; extra == 'all'
+Requires-Dist: ujson>=5.4; extra == 'all'
 Provides-Extra: dynamodb
-Provides-Extra: json
+Requires-Dist: boto3>=1.15; extra == 'dynamodb'
+Requires-Dist: botocore>=1.18; extra == 'dynamodb'
 Provides-Extra: mongodb
+Requires-Dist: pymongo>=3; extra == 'mongodb'
 Provides-Extra: redis
+Requires-Dist: redis>=3; extra == 'redis'
 Provides-Extra: security
+Requires-Dist: itsdangerous>=2.0; extra == 'security'
 Provides-Extra: yaml
-Requires-Dist: attrs (>=21.2)
-Requires-Dist: boto3 (>=1.15) ; extra == "dynamodb" or extra == "all"
-Requires-Dist: botocore (>=1.18) ; extra == "dynamodb" or extra == "all"
-Requires-Dist: bson (>=0.5) ; extra == "bson"
-Requires-Dist: cattrs (>=22.2)
-Requires-Dist: furo (>=2023.3,<2024.0) ; extra == "docs"
-Requires-Dist: itsdangerous (>=2.0) ; extra == "security" or extra == "all"
-Requires-Dist: linkify-it-py (>=2.0,<3.0) ; extra == "docs"
-Requires-Dist: myst-parser (>=1.0,<2.0) ; extra == "docs"
-Requires-Dist: platformdirs (>=2.5)
-Requires-Dist: pymongo (>=3) ; extra == "mongodb" or extra == "all"
-Requires-Dist: pyyaml (>=6.0.1) ; extra == "yaml" or extra == "all"
-Requires-Dist: redis (>=3) ; extra == "redis" or extra == "all"
-Requires-Dist: requests (>=2.22)
-Requires-Dist: sphinx (>=5.0.2,<6.0.0) ; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints (>=1.19) ; extra == "docs"
-Requires-Dist: sphinx-automodapi (>=0.14) ; extra == "docs"
-Requires-Dist: sphinx-copybutton (>=0.5) ; extra == "docs"
-Requires-Dist: sphinx-design (>=0.2) ; extra == "docs"
-Requires-Dist: sphinx-notfound-page (>=0.8) ; extra == "docs"
-Requires-Dist: sphinxcontrib-apidoc (>=0.3) ; extra == "docs"
-Requires-Dist: sphinxext-opengraph (>=0.9) ; extra == "docs"
-Requires-Dist: ujson (>=5.4) ; extra == "json" or extra == "all"
-Requires-Dist: url-normalize (>=1.4)
-Requires-Dist: urllib3 (>=1.25.5)
-Project-URL: Changelog, https://requests-cache.readthedocs.io/en/stable/project_info/history.html
-Project-URL: Documentation, https://requests-cache.readthedocs.io
-Project-URL: Issues, https://github.com/requests-cache/requests-cache/issues
-Project-URL: Repository, https://github.com/requests-cache/requests-cache
+Requires-Dist: pyyaml>=6.0.1; extra == 'yaml'
 Description-Content-Type: text/markdown
 
 [![](docs/_static/requests-cache-logo-header.png)](https://requests-cache.readthedocs.io)
 
-[![Build](https://github.com/requests-cache/requests-cache/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/requests-cache/requests-cache/actions)
+[![Build](https://github.com/requests-cache/requests-cache/actions/workflows/build.yml/badge.svg)](https://github.com/requests-cache/requests-cache/actions)
 [![Codecov](https://codecov.io/gh/requests-cache/requests-cache/branch/main/graph/badge.svg?token=FnybzVWbt2)](https://codecov.io/gh/requests-cache/requests-cache)
 [![Documentation](https://img.shields.io/readthedocs/requests-cache/latest)](https://requests-cache.readthedocs.io/en/stable/)
 [![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)
@@ -194,7 +186,7 @@ session = CachedSession(
     expire_after=timedelta(days=1),    # Otherwise expire responses after one day
     allowable_codes=[200, 400],        # Cache 400 responses as a solemn reminder of your failures
     allowable_methods=['GET', 'POST'], # Cache whatever HTTP methods you want
-    ignored_parameters=['api_key'],    # Don't match this request param, and redact if from the cache
+    ignored_parameters=['api_key'],    # Don't match this request param, and redact it from the cache
     match_headers=['Accept-Language'], # Cache a different response per language
     stale_if_error=True,               # In case of request errors, use stale cache data if possible
 )
@@ -209,4 +201,3 @@ To find out more about what you can do with requests-cache, see:
 * [API Reference](https://requests-cache.readthedocs.io/en/stable/reference.html)
 * [Project Info](https://requests-cache.readthedocs.io/en/stable/project_info.html)
 <!-- END-RTD-IGNORE -->
-

{requests_cache-1.2.0 → requests_cache-1.3.0}/README.md

@@ -1,6 +1,6 @@
 [![](docs/_static/requests-cache-logo-header.png)](https://requests-cache.readthedocs.io)
 
-[![Build](https://github.com/requests-cache/requests-cache/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/requests-cache/requests-cache/actions)
+[![Build](https://github.com/requests-cache/requests-cache/actions/workflows/build.yml/badge.svg)](https://github.com/requests-cache/requests-cache/actions)
 [![Codecov](https://codecov.io/gh/requests-cache/requests-cache/branch/main/graph/badge.svg?token=FnybzVWbt2)](https://codecov.io/gh/requests-cache/requests-cache)
 [![Documentation](https://img.shields.io/readthedocs/requests-cache/latest)](https://requests-cache.readthedocs.io/en/stable/)
 [![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)
@@ -134,7 +134,7 @@ session = CachedSession(
     expire_after=timedelta(days=1),    # Otherwise expire responses after one day
     allowable_codes=[200, 400],        # Cache 400 responses as a solemn reminder of your failures
     allowable_methods=['GET', 'POST'], # Cache whatever HTTP methods you want
-    ignored_parameters=['api_key'],    # Don't match this request param, and redact if from the cache
+    ignored_parameters=['api_key'],    # Don't match this request param, and redact it from the cache
     match_headers=['Accept-Language'], # Cache a different response per language
     stale_if_error=True,               # In case of request errors, use stale cache data if possible
 )

requests_cache-1.3.0/pyproject.toml

@@ -0,0 +1,187 @@
+[project]
+name = 'requests-cache'
+version = '1.3.0'
+description = 'A persistent cache for python requests'
+authors = [{name='Jordan Cook'}, {name='Roman Haritonov'}]
+license = 'BSD-2-Clause'
+readme = 'README.md'
+keywords = [
+    'requests',
+    'python-requests',
+    'cache',
+    'http',
+    'http-client',
+    'web',
+    'webscraping',
+    'performance',
+    'sqlite',
+    'redis',
+    'mongodb',
+    'dynamodb',
+]
+classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+    'Typing :: Typed',
+]
+requires-python = '>=3.8'
+
+# Required dependencies
+dependencies = [
+    'requests       >=2.22',   # Needs no introduction
+    'urllib3        >=1.25.5', # Use a slightly newer version than required by requests (for bugfixes)
+    'attrs          >=21.2',   # For response data models
+    'cattrs         >=22.2',   # For response serialization
+    'platformdirs   >=2.5',    # For features that use platform-specific system directories
+    'url-normalize  >=2.0',    # For more accurate request matching
+]
+
+[project.urls]
+homepage = 'https://github.com/requests-cache/requests-cache'
+repository = 'https://github.com/requests-cache/requests-cache'
+documentation = 'https://requests-cache.readthedocs.io'
+
+[project.optional-dependencies]
+# Optional backend and serialization dependencies
+dynamodb        = ['boto3>=1.15', 'botocore>=1.18']
+mongodb         = ['pymongo>=3']
+redis           = ['redis>=3']
+security        = ['itsdangerous>=2.0']
+yaml            = ['pyyaml>=6.0.1']
+all = [
+    'boto3          >=1.15',
+    'botocore       >=1.18',
+    'itsdangerous   >=2.0',
+    'orjson         >=3.0',
+    'pymongo        >=3',
+    'pyyaml         >=6.0.1',
+    'redis          >=3',
+    'ujson          >=5.4',
+]
+
+[dependency-groups]
+# Test dependencies and local development tools
+dev = [
+    'coverage               >=7.2',
+    'psutil                 >=5.0',
+    'pytest                 >=8.2',
+    'pytest-clarity         >=1.0.1',
+    'pytest-cov             >=3.0',
+    'pytest-pretty          >=1.2',
+    'pytest-rerunfailures   >=10.1',
+    'pytest-xdist           >=2.2',
+    'requests-mock          ~=1.12',
+    'responses              >=0.19',
+    'tenacity               ~=8.0',
+    'time-machine           ~=2.9; implementation_name != "pypy"',
+    'nox                    >=2024.4',
+    'prek                   >=0.2',
+    'rich                   >=10.0',
+]
+
+# Documentation dependencies
+docs = [
+    'furo                       ~=2025.7    ; python_version>="3.11"',
+    'linkify-it-py              >=2.0       ; python_version>="3.11"',
+    'myst-parser                >=3.0       ; python_version>="3.11"',
+    'sphinx                     ~=8.2.3     ; python_version>="3.11"',
+    'sphinx-autobuild           ~=2024.10   ; python_version>="3.11"',
+    'sphinx-autodoc-typehints   ~=3.2       ; python_version>="3.11"',
+    'sphinx-automodapi          ~=0.20      ; python_version>="3.11"',
+    'sphinx-copybutton          >=0.5       ; python_version>="3.11"',
+    'sphinx-design              >=0.6       ; python_version>="3.11"',
+    'sphinx-notfound-page       >=1.0       ; python_version>="3.11"',
+    'sphinx-llms-txt            >=0.5       ; python_version>="3.11"',
+    'sphinx-sitemap             >=2.8       ; python_version>="3.11"',
+    'sphinxcontrib-apidoc       >=0.3       ; python_version>="3.11"',
+    'sphinxext-opengraph        >=0.9       ; python_version>="3.11"',
+]
+
+[build-system]
+requires = ['hatchling>=1.0.0']
+build-backend = 'hatchling.build'
+
+[tool.hatch.build]
+only-include = ['requests_cache']
+force-include = {'README.md' = 'requests_cache/README.md'}
+
+# Include tests in sdist, except for sample data, which is too large to package
+[tool.hatch.build.targets.sdist]
+only-include = ['requests_cache', 'tests']
+exclude = [
+  "tests/sample_data",
+  "tests/integration/test_upgrade.py",
+]
+
+[tool.coverage.html]
+directory = 'test-reports'
+
+[tool.coverage.xml]
+output = 'test-reports/coverage.xml'
+
+[tool.coverage.run]
+branch = true
+source = ['requests_cache']
+omit = [
+    'requests_cache/__init__.py',
+    'requests_cache/backends/__init__.py',
+    'requests_cache/models/__init__.py',
+    'requests_cache/serializers/__init__.py',
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    'pragma: no cover',
+    'if TYPE_CHECKING:',
+    'if logger.level',
+    'except ImportError:',
+]
+
+[tool.mypy]
+python_version = 3.8
+ignore_missing_imports = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_unreachable = true
+show_error_codes = true
+show_column_numbers = true
+pretty = true
+
+[tool.ruff]
+fix = true
+unsafe-fixes = true
+line-length = 100
+output-format = 'grouped'
+target-version = 'py38'
+exclude = ['examples/']
+
+[tool.ruff.format]
+quote-style = 'single'
+
+[tool.ruff.lint]
+select = ['B', 'C4', 'C90', 'E', 'F']
+ignore = ['B023']
+
+[tool.ruff.lint.isort]
+known-first-party = ['tests']
+
+# Wrap lines to 100 chars, but don't error on unwrappable lines until 120 chars
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[tool.typos]
+files.extend-exclude = [
+    '.all-contributorsrc',
+    'CONTRIBUTORS.md',
+    'docs/sample_data',
+    'tests/sample_data',
+]

{requests_cache-1.2.0 → requests_cache-1.3.0}/requests_cache/__init__.py

@@ -1,9 +1,5 @@
 # ruff: noqa: E402,F401,F403
 
-# Version is defined in pyproject.toml.
-# It's copied here to make it easier for client code to check the installed version.
-__version__ = '1.2.0'
-
 from .backends import *
 from .cache_keys import *
 from .models import *

{requests_cache-1.2.0 → requests_cache-1.3.0}/requests_cache/_utils.py

@@ -1,4 +1,5 @@
 """Minor internal utility functions that don't really belong anywhere else"""
+
 from contextlib import contextmanager
 from inspect import signature
 from logging import getLogger
@@ -6,7 +7,7 @@ from typing import Any, Callable, Dict, Iterable, Iterator, List, Optional, Tupl
 
 from urllib3 import filepost
 
-FORM_BOUNDARY = '==requests-cache-form-boundary=='
+FORM_BOUNDARY = '--requests-cache-form-boundary--'
 
 KwargDict = Dict[str, Any]
 logger = getLogger('requests_cache')
@@ -51,6 +52,8 @@ def get_placeholder_class(original_exception: Optional[Exception] = None):
         raise original_exception or ImportError(msg)
 
     class Placeholder:
+        name = 'placeholder'
+
         def __init__(self, *args, **kwargs):
             _log_error()
 

{requests_cache-1.2.0 → requests_cache-1.3.0}/requests_cache/backends/__init__.py

@@ -1,8 +1,10 @@
 """Classes and functions for cache persistence. See :ref:`backends` for general usage info."""
+
 # ruff: noqa: F401
 from logging import getLogger
 from pathlib import Path
 from typing import Callable, Dict, Iterable, Optional, Type, Union
+from warnings import warn
 
 from .._utils import get_placeholder_class, get_valid_kwargs
 from .base import BaseCache, BaseStorage, DictStorage
@@ -42,9 +44,9 @@ except ImportError as e:
     SQLiteCache = SQLiteDict = get_placeholder_class(e)  # type: ignore
 
 try:
-    from .filesystem import FileCache, FileDict
+    from .filesystem import FileCache, FileDict, LRUFileDict
 except ImportError as e:
-    FileCache = FileDict = get_placeholder_class(e)  # type: ignore
+    FileCache = FileDict = LRUFileDict = get_placeholder_class(e)  # type: ignore
 
 
 BACKEND_CLASSES = {
@@ -73,8 +75,18 @@ def init_backend(
 
     # Already a backend instance
     if isinstance(backend, BaseCache):
-        if cache_name:
+        # Database names, file paths, etc. cannot be reliably updated after initialization, so
+        # warn if the user passes both `cache_name` and a backend instance
+        from ..policy import DEFAULT_CACHE_NAME
+
+        if cache_name and cache_name != DEFAULT_CACHE_NAME:
             backend.cache_name = str(cache_name)
+            warn(
+                '`cache_name` cannot be set after backend initialization; '
+                'please pass it to the backend class instead',
+                DeprecationWarning,
+                stacklevel=3,
+            )
         return backend
     # If no backend is specified, use SQLite as default, unless the environment doesn't support it
     elif not backend:

{requests_cache-1.2.0 → requests_cache-1.3.0}/requests_cache/backends/base.py

@@ -4,6 +4,7 @@
    :classes-only:
    :nosignatures:
 """
+
 from __future__ import annotations
 
 from abc import ABC
@@ -11,15 +12,7 @@ from collections import UserDict
 from datetime import datetime
 from logging import getLogger
 from pickle import PickleError
-from typing import (
-    TYPE_CHECKING,
-    Iterable,
-    Iterator,
-    List,
-    MutableMapping,
-    Optional,
-    TypeVar,
-)
+from typing import TYPE_CHECKING, Iterable, Iterator, List, MutableMapping, Optional, TypeVar
 from warnings import warn
 
 from requests import Request, Response
@@ -126,6 +119,7 @@ class BaseCache:
         return key_fn(
             request=request,
             ignored_parameters=self._settings.ignored_parameters,
+            content_root_key=self._settings.content_root_key,
             match_headers=match_headers or self._settings.match_headers,
             serializer=self.responses.serializer,
             **kwargs,
@@ -139,6 +133,7 @@ class BaseCache:
         key: Optional[str] = None,
         request: Optional[AnyRequest] = None,
         url: Optional[str] = None,
+        verify: bool = True,
     ):
         """Check if the specified request is cached
 
@@ -146,11 +141,12 @@ class BaseCache:
             key: Check for a specific cache key
             request: Check for a matching request, according to current request matching settings
             url: Check for a matching GET request with the specified URL
+            verify: Check for requests with or without SSL verification
         """
         if url:
             request = Request('GET', url)
         if request and not key:
-            key = self.create_key(request)
+            key = self.create_key(request, verify=verify)
         return key in self.responses or key in self.redirects
 
     def delete(
@@ -161,6 +157,7 @@ class BaseCache:
         older_than: ExpirationTime = None,
         requests: Optional[Iterable[AnyRequest]] = None,
         urls: Optional[Iterable[str]] = None,
+        verify: bool = True,
     ):
         """Remove responses from the cache according one or more conditions.
 
@@ -171,12 +168,13 @@ class BaseCache:
             older_than: Remove responses older than this value, relative to ``response.created_at``
             requests: Remove matching responses, according to current request matching settings
             urls: Remove matching GET requests for the specified URL(s)
+            verify: Set to ``False`` to remove responses without SSL verification
         """
         delete_keys: List[str] = list(keys) if keys else []
         if urls:
             requests = list(requests or []) + [Request('GET', url).prepare() for url in urls]
         if requests:
-            delete_keys += [self.create_key(request) for request in requests]
+            delete_keys += [self.create_key(request, verify=verify) for request in requests]
 
         for response in self.filter(
             valid=False, expired=expired, invalid=invalid, older_than=older_than

{requests_cache-1.2.0 → requests_cache-1.3.0}/requests_cache/backends/dynamodb.py

@@ -4,6 +4,7 @@
    :classes-only:
    :nosignatures:
 """
+
 from typing import Iterable, Optional
 
 import boto3
@@ -24,6 +25,7 @@ class DynamoDbCache(BaseCache):
 
     Args:
         table_name: DynamoDB table name
+        create_table: Whether or not to automatically create the dynamo backend table.
         connection: :boto3:`DynamoDB Resource <services/dynamodb/service-resource/index.html#service-resource>`
             object to use instead of creating a new one
         ttl: Use DynamoDB TTL to automatically remove expired items
@@ -33,6 +35,7 @@ class DynamoDbCache(BaseCache):
     def __init__(
         self,
         table_name: str = 'http_cache',
+        create_table: bool = True,
         *,
         ttl: bool = True,
         connection: Optional[ServiceResource] = None,
@@ -44,6 +47,7 @@ class DynamoDbCache(BaseCache):
         skwargs = {'serializer': serializer, **kwargs} if serializer else kwargs
         self.responses = DynamoDbDict(
             table_name,
+            create_table=create_table,
             ttl=ttl,
             connection=connection,
             decode_content=decode_content,
@@ -58,6 +62,7 @@ class DynamoDbDict(BaseStorage):
 
     Args:
         table_name: DynamoDB table name
+        create_table: Whether or not to automatically create the dynamo backend table.
         connection: :boto3:`DynamoDB Resource <services/dynamodb/service-resource/index.html#service-resource>`
             object to use instead of creating a new one
         ttl: Use DynamoDB TTL to automatically remove expired items
@@ -67,6 +72,7 @@ class DynamoDbDict(BaseStorage):
     def __init__(
         self,
         table_name: str,
+        create_table: bool = True,
         ttl: bool = True,
         connection: Optional[ServiceResource] = None,
         serializer: Optional[SerializerType] = dynamodb_document_serializer,
@@ -81,7 +87,8 @@ class DynamoDbDict(BaseStorage):
         self.ttl = ttl
 
         self._table = self.connection.Table(self.table_name)
-        self._create_table()
+        if create_table:
+            self._create_table()
         if ttl:
             self._enable_ttl()