1.2.0 (2024-02-17)#

⚠️ Deprecations & removals:

  • Drop support for python 3.7

  • Remove methods deprecated in 1.0 from CachedSession and BaseCache

🕗 Expiration & headers:

  • Add support for X-HTTP-Method-Override and other headers that can override request method

⚙️ Session methods:

  • Add CachedSession.wrap() classmethod to add caching to an existing requests.Session object

💾 SQLite Backend:

  • Add vacuum parameter to SQLiteCache.delete() to optionally skip vacuuming after deletion (enabled by default to free up disk space)

  • Optimize SQLiteCache.delete() when deleting a single key

🧩 Compatibility:

  • Add support for RFC 7159 JSON body with decode_content=True (root element with any type)

  • Use timezone-aware UTC datetimes for all internal expiration values

  • Add support for python 3.12

    • Note: There is a known bug with multiprocess/multithreaded usage of the SQLite backend on python 3.12.

  • Add support for cattrs 23.2

🪲 Bugfixes:

  • Fix IncompleteRead error that could sometimes occur with streaming requests due to mismatch with Content-Length header

  • Handle a corner case with streaming requests, conditional requests, and redirects

  • When redacting ignored parameters from a cached response, keep the rest of the original URL and headers without normalizing

  • Add CachedHTTPResponse._request_url property for compatibility with urllib3

  • Fix form boundary used for cached multipart requests to comply with RFC 2046

  • If an explicit CA bundle path is passed via verify param, cache the response under the same key as verify=True

  • Handle JSON Content-Type charsets and MIME type variations (such as application/vnd.api+json) during request normalization and serialization

1.1.1 (2023-11-18)#

  • Backport fix from 1.2: Add compatibility with cattrs 23.2

1.1.0 (2023-06-30)#

⚙️ Session settings:

  • Add support for regular expressions with urls_expire_after

💾 SQLite Backend:

  • Add busy_timeout argument (see SQLite docs for details)

  • In WAL journaling mode (wal=True), default to ‘normal’ synchronous mode instead of ‘full’

  • Fix potential OperationalError: database is locked in multithreaded SQLite usage during bulk delete operations

  • Fix deadlock in multithreaded SQLite usage if a thread encounters an error during COMMIT

🪲 Bugfixes:

  • Fix loading cached JSON content with decode_content=True when the root element is a list

  • Fix BaseCache.recreate_keys() to normalize response bodies with b'None'

  • Fix BaseCache.contains() for multipart POST requests

  • Fix CachedResponse.history not being fully deserialized on python<=3.8

  • Fix request matching with Vary and redirects

  • Skip normalizing CachedResponse.url so it always matches the original request URL

  • Avoid unnecessary cache writes for revalidation requests if headers and expiration are unchanged

  • Add compatibility with urllib3 2.0

1.0.1 (2023-03-24)#

  • Ignore Cache-Control: must-revalidate and no-cache response headers with cache_control=False

1.0.0 (2023-03-01)#

See all unreleased issues and PRs

🕗 Expiration & headers:

  • Add support for Cache-Control: min-fresh

  • Add support for Cache-Control: max-stale

  • Add support for Cache-Control: only-if-cached

  • Add support for Cache-Control: stale-if-error

  • Add support for Cache-Control: stale-while-error

  • Add support for Vary

  • Revalidate for Cache-Control: no-cache request or response header

  • Revalidate for Cache-Control: max-age=0, must-revalidate response headers

  • Add an attribute CachedResponse.revalidated to indicate if a cached response was revalidated for the current request

⚙️ Session settings:

  • All settings that affect cache behavior can now be accessed and modified via CachedSession.settings

  • Add always_revalidate session setting to always revalidate before using a cached response (if a validator is available).

  • Add only_if_cached session setting to return only cached results without sending real requests

  • Add stale_while_revalidate session setting to return a stale response initially, while a non-blocking request is sent to refresh the response

  • Make behavior for stale_if_error partially consistent with Cache-Control: stale-if-error: Add support for time values (int, timedelta, etc.) in addition to True/False

⚙️ Request settings:

  • Add only_if_cached option to CachedSession.request() and send() to return only cached results without sending real requests

  • Add refresh option to CachedSession.request() and send() to revalidate with the server before using a cached response

  • Add force_refresh option to CachedSession.request() and send() to awlays make and cache a new request regardless of existing cache contents

  • Make behavior for expire_after=0 consistent with Cache-Control: max-age=0: if the response has a validator, save it to the cache but revalidate on use.

    • The constant requests_cache.DO_NOT_CACHE may be used to completely disable caching for a request

💾 Backends:

  • DynamoDB:

    • For better read performance and usage of read throughput:

      • The cache key is now used as the partition key

      • Redirects are now cached only in-memory and not persisted

      • Cache size (len()) now uses a fast table estimate instead of a full scan

    • Store responses in plain (human-readable) document format instead of fully serialized binary

    • Create default table in on-demand mode instead of provisioned

    • Add optional integration with DynamoDB TTL to improve performance for removing expired responses

      • This is enabled by default, but may be disabled

    • Decode JSON and text response bodies so the saved response can be fully human-readable/editable. May be disabled with decode_content=False.

  • Filesystem:

    • The default file format has been changed from pickle to JSON

    • Decode JSON and text response bodies so the saved response can be fully human-readable/editable. May be disabled with decode_content=False.

  • MongoDB:

    • Store responses in plain (human-readable) document format instead of fully serialized binary

    • Add optional integration with MongoDB TTL to improve performance for removing expired responses

      • Disabled by default. See ‘Backends: MongoDB’ docs for details.

    • Decode JSON and text response bodies so the saved response can be fully human-readable/editable. May be disabled with decode_content=False.

  • Redis:

    • Add ttl_offset argument to add a delay between cache expiration and deletion

  • SQLite:

    • Improve performance for removing expired responses with delete()

    • Improve performance (slightly) with a large number of threads and high request rate

    • Add count() method to count responses, with option to exclude expired responses (performs a fast indexed count instead of slower in-memory filtering)

    • Add size() method to get estimated size of the database (including in-memory databases)

    • Add sorted() method with sorting and other query options

    • Add wal parameter to enable write-ahead logging

  • SQLite, Redis, MongoDB, and GridFS:

    • Close open database connections when CachedSession is used as a contextmanager, or if CachedSession.close() is called

↔️ Request matching:

  • Add serializer name to cache keys to avoid errors due to switching serializers

  • Always skip both cache read and write for requests excluded by allowable_methods (previously only skipped write)

  • Ignore and redact common authentication headers and request parameters by default. This provides some default recommended values for ignored_parameters, to avoid accidentally storing common credentials in the cache. This will have no effect if ignored_parameters is already set.

  • Support distinct matching for requests that differ only by a parameter in ignored_parameters (e.g., for a request sent both with and without authentication)

  • Support distinct matching for requests that differ only by duplicate request params (e.g, a=1 vs ?a=1&a=2)

ℹ️ Convenience methods:

  • Add expired and invalid arguments to BaseCache.delete() (to replace remove_expired_responses())

  • Add urls and requests arguments to BaseCache.delete() (to replace delete_url())

  • Add older_than argument to BaseCache.delete() to delete responses older than a given value

  • Add requests argument to BaseCache.delete() to delete responses matching the given requests

  • Add BaseCache.contains() method to check for cached requests either by key or by requests.Request object

  • Add url argument to BaseCache.contains() method (to replace has_url())

  • Add BaseCache.filter() method to get responses from the cache with various filters

  • Add BaseCache.reset_expiration() method to reset expiration for existing responses

  • Add BaseCache.recreate_keys() method to recreate cache keys for all previously cached responses (e.g., to preserve cache data after an update that changes request matching behavior)

  • Update BaseCache.urls into a method that takes optional filter params, and returns sorted unique URLs

ℹ️ Response attributes and type hints:

  • Add OriginalResponse type, which adds type hints to requests.Response objects for extra attributes added by requests-cache:

    • cache_key

    • created_at

    • expires

    • from_cache

    • is_expired

    • revalidated

  • OriginalResponse.cache_key and expires will be populated for any new response that was written to the cache

  • Add request wrapper methods with return type hints for all HTTP methods (CachedSession.get(), head(), etc.)

  • Set CachedResponse.cache_key attribute for responses read from lower-level storage methods (items(), values(), etc.)

🧩 Compatibility fixes:

  • PyInstaller: Fix potential AttributeError due to undetected imports when requests-cache is bundled in a PyInstaller package

  • requests-oauthlib: Add support for header values as bytes for compatibility with OAuth1 features

  • redis-py: Fix forwarding connection parameters passed to RedisCache for redis-py 4.2 and python <=3.8

  • pymongo: Fix forwarding connection parameters passed to MongoCache for pymongo 4.1 and python <=3.8

  • cattrs: Add compatibility with cattrs 22.2

  • python:

    • Add tests and support for python 3.11

    • Add tests and support for pypy 3.9

🪲 Bugfixes:

  • Fix usage of memory backend with install_cache()

  • Fix an uncommon OperationalError: database is locked in SQLite backend

  • Fix issue on Windows with occasional missing CachedResponse.created_at timestamp

  • Add CachedRequest.path_url property for compatibility with RequestEncodingMixin

  • Fix potential AttributeError due to undetected imports when requests-cache is bundled in a PyInstaller package

  • Fix AttributeError when attempting to unpickle a CachedSession object, and instead disable pickling by raising a NotImplementedError

  • Raise an error for invalid expiration string values (except for headers containing httpdates)

    • Previously, this would be quietly ignored, and the response would be cached indefinitely

  • Fix behavior for stale_if_error if an error response code is added to allowable_codes

📦 Dependencies:

  • Replace appdirs with platformdirs

⚠️ Deprecations:

The following methods are deprecated, and will be removed in 1.2. The recommended replacements are listed below. If this causes problems for you, please open an issue to discuss.

  • CachedSession.remove_expired_responses(): BaseCache.delete(expired=True)

  • BaseCache.remove_expired_responses(): BaseCache.delete(expired=True)

  • BaseCache.delete_url(): BaseCache.delete(urls=[...])

  • BaseCache.delete_urls(): BaseCache.delete(urls=[...])

  • BaseCache.has_key(): BaseCache.contains()

  • BaseCache.has_url(): BaseCache.contains(url=...)

  • BaseCache.keys(): BaseCache.responses.keys() (for all keys), or BaseCache.filter() (for filtering options)

  • BaseCache.values(): BaseCache.responses.values() (for all values), or BaseCache.filter() (for filtering options)

  • BaseCache.response_count(): len(BaseCache.responses) (for all responses), or BaseCache.filter() (for filtering options)

⚠️ Breaking changes:

  • After initialization, cache settings can only be accessed and modified via CachedSession.settings. Previously, some settings could be modified by setting them on either CachedSession or BaseCache. In some cases this could silently fail or otherwise have undefined behavior.

  • BaseCache.urls has been replaced with a method that returns a list of URLs.

  • DynamoDB table structure has changed. If you are using the DynamoDB backend, you will need to create a new table when upgrading to 1.0. See DynamoDB backend docs for more details.

Minor breaking changes:

The following changes only affect advanced or undocumented usage, and are not expected to impact most users:

  • The arguments match_headers and ignored_parameters must be passed to CachedSession. Previously, these could also be passed to a BaseCache instance.

  • The CachedSession backend argument must be either an instance or string alias. Previously it would also accept a backend class.

  • All serializer-specific BaseStorage subclasses have been removed, and merged into their respective parent classes. This includes SQLitePickleDict, MongoPickleDict, and GridFSPickleDict.

    • All BaseStorage subclasses now have a serializer attribute, which will be unused if set to None.

  • The cache_control module (added in 0.7) has been split up into multiple modules in a new policy subpackage

0.9.8 (2023-01-13)#

  • Fix DeprecationWarning raised by BaseCache.urls

  • Reword ambiguous log message for BaseCache.delete

Backport fixes from 1.0:

  • For custom serializers, handle using a cattrs converter that doesn’t support omit_if_default

  • Raise an error for invalid expiration string values (except for headers containing httpdates)

0.9.7 (2022-10-26)#

Backport compatibility fixes from 1.0:

  • PyInstaller: Fix potential AttributeError due to undetected imports when requests-cache is bundled in a PyInstaller package

  • requests-oauthlib: Add support for header values as bytes for compatibility with OAuth1 features

  • cattrs: Add compatibility with cattrs 22.2

  • python: Add tests to ensure compatibility with python 3.11

  • Fix AttributeError when attempting to unpickle a CachedSession object, and instead disable pickling by raising a NotImplementedError

Add the following for forwards-compatibility with 1.0:

  • DeprecationWarnings to give an earlier notice for methods deprecated (not removed) in 1.0

  • requests_cache.policy subpackage (will replace requests_cache.cache_control module)

  • BaseCache.contains()

  • BaseCache.delete()

  • BaseCache.filter()

  • CachedSession.settings

0.9.6 (2022-08-24)#

Backport fixes from 1.0:

  • Remove potentially problematic row count from BaseCache.__str__()

  • Remove upper version constraints for all non-dev dependencies

  • Make dependency specification consistent between PyPI and Conda-Forge packages

0.9.5 (2022-06-29)#

Backport fixes from 1.0:

  • Fix usage of memory backend with install_cache()

  • Add CachedRequest.path_url property

  • Add compatibility with cattrs 22.1

0.9.4 (2022-04-22)#

Backport fixes from 1.0:

  • Fix forwarding connection parameters passed to RedisCache for redis-py 4.2 and python <=3.8

  • Fix forwarding connection parameters passed to MongoCache for pymongo 4.1 and python <=3.8

0.9.3 (2022-02-22)#

  • Fix handling BSON serializer differences between pymongo’s bson and standalone bson codec.

  • Handle CorruptGridFile error in GridFS backend

  • Fix cache path expansion for user directories (~/...) for SQLite and filesystem backends

  • Fix request normalization for request body with a list as a JSON root

  • Skip normalizing a JSON request body if it’s excessively large (>10MB) due to performance impact

  • Fix some thread safety issues:

    • Fix race condition in SQLite backend with dropping and recreating tables in multiple threads

    • Fix race condition in filesystem backend when one thread deletes a file after it’s opened but before it is read by a different thread

    • Fix multiple race conditions in GridFS backend

0.9.2 (2022-02-15)#

  • Fix serialization in filesystem backend with binary content that is also valid UTF-8

  • Fix some regression bugs introduced in 0.9.0:

    • Add support for params as a positional argument to CachedSession.request()

    • Add support for disabling expiration for a single request with CachedSession.request(..., expire_after=-1)

0.9.1 (2022-01-15)#

  • Add support for python 3.10.2 and 3.9.10 (regarding resolving ForwardRef types during deserialization)

  • Add support for key-only request parameters (regarding hashing request data for cache key creation)

  • Reduce verbosity of log messages when encountering an invalid JSON request body

0.9.0 (2022-01-01)#

See all issues and PRs for 0.9

🕗 Expiration & headers:

  • Use Cache-Control request headers by default

  • Add support for Cache-Control: immutable

  • Add support for immediate expiration + revalidation with Cache-Control: max-age=0 and Expires: 0

  • Reset expiration for cached response when a 304 Not Modified response is received

  • Support expire_after param for CachedSession.send()

💾 Backends:

  • Filesystem:

    • Add better error message if parent path exists but isn’t a directory

  • Redis:

    • Add optional integration with Redis TTL to improve performance for removing expired responses

    • This is enabled by default, but may be disabled

  • SQLite:

    • Add better error message if parent path exists but isn’t a directory

🚀 Performance:

  • Fix duplicate read operation for checking whether to read from redirects cache

  • Skip unnecessary contains check if a key is in the main responses cache

  • Make per-request expiration thread-safe for both CachedSession.request() and CachedSession.send()

  • Some micro-optimizations for request matching

🪲 Bugfixes:

  • Fix regression bug causing headers used for cache key to not guarantee sort order

  • Handle some additional corner cases when normalizing request data

  • Add support for BaseCache keyword arguments passed along with a backend instance

  • Fix issue with cache headers not being used correctly if cache_control=True is used with an expire_after value

  • Fix license metadata as shown on PyPI

  • Fix CachedResponse serialization behavior when using stdlib pickle in a custom serializer

0.8.1 (2021-09-15)#

  • Redact ignored_parameters from CachedResponse.url (if used for credentials or other sensitive info)

  • Fix an incorrect debug log message about skipping cache write

  • Add some additional aliases for DbDict, etc. so fully qualified imports don’t break

0.8.0 (2021-09-07)#

See all issues and PRs for 0.8

🕗 Expiration & headers:

  • Add support for conditional requests and cache validation using:

    • ETag + If-None-Match headers

    • Last-Modified + If-Modified-Since headers

    • 304 Not Modified responses

  • If a cached response is expired but contains a validator, a conditional request will by sent, and a new response will be cached and returned only if the remote content has not changed

💾 Backends:

  • Filesystem:

    • Add FileCache.cache_dir wrapper property

    • Add FileCache.paths() method

    • Add use_cache_dir option to use platform-specific user cache directory

    • Return pathlib.Path objects for all file paths

    • Use shorter hashes for file names

  • SQLite:

    • Add SQLiteCache.db_path wrapper property

    • Add use_memory option and support for in-memory databases

    • Add use_cache_dir option to use platform-specific user cache directory

    • Return pathlib.Path objects for all file paths

🚀 Performance:

  • Use cattrs by default for optimized serialization

  • Slightly reduce size of serialized responses

↔️ Request matching:

  • Allow create_key() to optionally accept parameters for requests.Request instead of a request object

  • Allow match_headers to optionally accept a list of specific headers to match

  • Add support for custom cache key callbacks with key_fn parameter

  • By default use blake2 instead of sha256 for generating cache keys

ℹ️ Cache convenience methods:

  • Add BaseCache.update() method as a shortcut for exporting to a different cache instance

  • Allow BaseCache.has_url() and delete_url() to optionally take parameters for requests.Request instead of just a URL

📦 Dependencies:

  • Add appdirs as a dependency for easier cross-platform usage of user cache directories

  • Update cattrs from optional to required dependency

  • Update itsdangerous from required to optional (but recommended) dependency

  • Require requests 2.22+ and urllib3 1.25.5+

⚠️ Backwards-compatible API changes:

The following changes are meant to make certain behaviors more obvious for new users, without breaking existing usage:

  • For consistency with Cache-Control: stale-if-error, rename old_data_on_error to stale_if_error

    • Going forward, any new options based on a standard HTTP caching feature will be named after that feature

  • For clarity about matching behavior, rename include_get_headers to match_headers

    • References in the docs to cache keys and related behavior are now described as ‘request matching’

  • For consistency with other backends, rename SQLite backend classes: backends.sqlite.Db* -> SQLiteCache, SQLiteDict, SQLitePickleDict

  • Add aliases for all previous parameter/class names for backwards-compatibility

⚠️ Deprecations & removals:

  • Drop support for python 3.6

  • Remove deprecated core module

  • Remove deprecated BaseCache.remove_old_entries() method

0.7.5 (2021-09-15)#

  • Fix incorrect location of redirects.sqlite when using filesystem backend

  • Fix issue in which redirects.sqlite would get included in response paths with filesystem backend

  • Add aliases for forwards-compatibility with 0.8+

  • Backport fixes from 0.8.1

0.7.4 (2021-08-16)#

  • Fix an issue with httpdate strings from Expires headers not getting converted to UTC

  • Fix a packaging issue with extra files added to top-level wheel directory

  • Fix some issues with parallelizing tests using pytest-xdist

0.7.3 (2021-08-10)#

  • SQLite backend:

    • Update DbCache.clear() to succeed even if the database is corrupted

    • Update DbDict.bulk_delete() to split the operation into multiple statements to support deleting more items than SQLite’s variable limit (999)

  • Filesystem backend:

    • When using JSON serializer, pretty-print JSON by default

    • Add an appropriate file extension to cache files (.json, .yaml, .pkl, etc.) by default; can be overridden or disabled with the extension parameter.

  • Add a BaseCache.delete_urls() method to bulk delete multiple responses from the cache based on request URL

0.7.2 (2021-07-21)#

  • Add support for Response.next (to get the next request in a redirect chain) when 302 responses are cached directly

  • Add a CachedResponse.cache_key attribute

  • Make CachedResponse a non-slotted class to allow client code to set arbitrary attributes on it

0.7.1 (2021-07-09)#

  • Fix a bug in which Cache-Control headers would be used unexpectedly

0.7.0 (2021-07-07)#

See all issues and PRs for 0.7

🕗 Expiration & headers:

  • Add optional support for the following request headers:

    • Cache-Control: max-age

    • Cache-Control: no-cache

    • Cache-Control: no-store

  • Add optional support for the following response headers:

    • Cache-Control: max-age

    • Cache-Control: no-store

    • Expires

  • Add cache_control option to CachedSession to enable setting expiration with cache headers

  • Add support for HTTP timestamps (RFC 5322) in expire_after parameters

  • Add support for bypassing the cache if expire_after=0

  • Add support for making a cache allowlist using URL patterns

💾 Backends:

  • Add a filesystem backend that stores responses as local files

  • DynamoDB:

    • Fix DynamoDbDict.__iter__ to return keys instead of values

    • Accept connection arguments for boto3.resource

  • MongoDB:

    • Remove usage of deprecated pymongo Collection.find_and_modify()

    • Accept connection arguments for pymongo.MongoClient

  • Redis:

    • Accept connection arguments for redis.Redis

  • SQLite:

    • Use persistent thread-local connections, and improve performance for bulk operations

    • Add use_temp option to store files in a temp directory

    • Accept connection arguments for sqlite3.connect

💾 Serialization:

  • Add data models for all serialized objects

  • Add a JSON serializer

  • Add a YAML serializer

  • Add a BSON serializer

  • Add optional support for cattrs

  • Add optional support for ultrajson

↔️ Request matching:

  • Add support for caching multipart form uploads

  • Update ignored_parameters to also exclude ignored request params, body params, or headers from cached response data (to avoid storing API keys or other credentials)

  • Update old_data_on_error option to also handle error response codes

  • Only log request exceptions if old_data_on_error is set

ℹ️ Convenience methods:

  • Add option to manually cache response objects with BaseCache.save_response()

  • Add BaseCache.keys() and values() methods

  • Add BaseCache.response_count() method to get an accurate count of responses (excluding invalid and expired)

  • Show summarized response details with str(CachedResponse)

  • Add more detailed repr methods for CachedSession, CachedResponse, and BaseCache

  • Update BaseCache.urls to only skip invalid responses, not delete them (for better performance)

📦 Dependencies:

  • Add minimum requests version of 2.17

  • Add attrs as a dependency for improved serialization models

  • Add cattrs as an optional dependency

  • Add some package extras to install optional dependencies (via pip install):

    • requests-cache[all] (to install everything)

    • requests-cache[bson]

    • requests-cache[json]

    • requests-cache[dynamodb]

    • requests-cache[mongodb]

    • requests-cache[redis]

📦 Compatibility and packaging:

  • requests-cache is now fully typed and PEP-561 compliant

  • Fix some compatibility issues with requests 2.17 and 2.18

  • Run pre-release tests for each supported version of requests

  • Packaging is now managed by Poetry

    • For users, installation still works the same.

    • For developers, see Contributing Guide for details

0.6.4 (2021-06-04)#

  • Fix a bug in which filter_fn() would get called on response.request instead of response

0.6.3 (2021-04-21)#

  • Fix false positive warning with include_get_headers

  • Fix handling of decode_content parameter for CachedResponse.raw.read()

  • Replace deprecated pymongo Collection.count() with estimated_document_count()

0.6.2 (2021-04-14)#

  • Explicitly include docs, tests, and examples in sdist

0.6.1 (2021-04-13)#

  • Handle errors due to invalid responses in BaseCache.urls

  • Add recently renamed BaseCache.remove_old_entries() back, as an alias with a DeprecationWarning

  • Make parent dirs for new SQLite databases

  • Add aws_access_key_id and aws_secret_access_key kwargs to DynamoDbDict

  • Update GridFSPickleDict.__delitem__ to raise a KeyError for missing items

  • Demote most logging.info statements to debug level

  • Exclude test directory from find_packages()

  • Make integration tests easier to run and/or fail more quickly in environments where Docker isn’t available

0.6.0 (2021-04-09)#

See all issues and PRs for 0.6

Thanks to Code Shelter and contributors for making this release possible!

🕗 Expiration:

  • Cached responses are now stored with an absolute expiration time, so CachedSession.expire_after no longer applies retroactively. To reset expiration for previously cached items, see below:

  • Add support for overriding original expiration in CachedSession.remove_expired_responses()

  • Add support for setting expiration for individual requests

  • Add support for setting expiration based on URL glob patterns

  • Add support for setting expiration as a datetime

  • Add support for explicitly disabling expiration with -1 (Since None may be ambiguous in some cases)

💾 Backends:

  • SQLite:

    • Allow passing user paths (~/path-to-cache) to database file with db_path param

    • Add timeout parameter

  • All: Make default table names consistent across backends ('http_cache')

💾 Serialization:

Note: Due to the following changes, responses cached with previous versions of requests-cache will be invalid. These old responses will be treated as expired, and will be refreshed the next time they are requested. They can also be manually converted or removed, if needed (see notes below).

  • Add example script to convert an existing cache from previous serialization format to new one

  • When running remove_expired_responses(), also remove responses that are invalid due to updated serialization format

  • Add CachedResponse class to wrap cached requests.Response objects, which makes additional cache information available to client code

  • Add CachedHTTPResponse class to wrap urllib3.response.HTTPResponse objects, available via CachedResponse.raw

    • Re-construct the raw response on demand to avoid storing extra data in the cache

    • Improve emulation of raw request behavior used for iteration, streaming requests, etc.

  • Add BaseCache.urls property to get all URLs persisted in the cache

  • Add optional support for itsdangerous for more secure serialization

Other features:

📗 Docs & Tests:

  • Add type annotations to main functions/methods in public API, and include in documentation on readthedocs

  • Add Contributing Guide, Security info, and more examples & detailed usage info in User Guide section.

  • Increase test coverage and rewrite most tests using pytest

  • Add containerized backends for both local and CI integration testing

🪲 Bugfixes:

  • Fix caching requests with data specified in json parameter

  • Fix caching requests with verify parameter

  • Fix duplicate cached responses due to some unhandled variations in URL format

  • Fix usage of backend-specific params when used in place of cache_name

  • Fix potential TypeError with DbPickleDict initialization

  • Fix usage of CachedSession.cache_disabled if used within another contextmanager

  • Fix non-thread-safe iteration in BaseCache

  • Fix get_cache(), clear(), and remove_expired_responses() so they will do nothing if requests-cache is not installed

  • Update usage of deprecated MongoClient save() method

  • Replace some old bugs with new and different bugs, just to keep life interesting

📦 Dependencies:

  • Add itsdangerous as a dependency for secure serialization

  • Add url-normalize as a dependency for better request normalization and reducing duplications

⚠️ Deprecations & removals:

  • Drop support for python 2.7, 3.4, and 3.5

  • Deprecate core module; all imports should be made from top-level package instead

    • e.g.: from requests_cache import CachedSession

    • Imports from requests_cache.core will raise a DeprecationWarning, and will be removed in a future release

  • Rename BaseCache.remove_old_entries() to remove_expired_responses(), to match its wrapper method CachedSession.remove_expired_responses()

0.5.2 (2019-08-14)#

  • Fix DeprecationWarning from collections #140

0.5.1 (2019-08-13)#

  • Remove Python 2.6 Testing from travis #133

  • Fix DeprecationWarning from collections #131

  • vacuum the sqlite database after clearing a table #134

  • Fix handling of unpickle errors #128

0.5.0 (2019-04-18)#

Project is now added to Code Shelter

  • Add gridfs support, thanks to @chengguangnan

  • Add dynamodb support, thanks to @ar90n

  • Add response filter #104, thanks to @christopher-dG

  • Fix bulk_commit #78

  • Fix remove_expired_responses missed in init.py #93

  • Fix deprecation warnings #122, thanks to mbarkhau

  • Drop support for python 2.6

0.4.13 (2016-12-23)#

  • Support PyMongo3, thanks to @craigls #72

  • Fix streaming releate issue #68

0.4.12 (2016-03-19)#

  • Fix ability to pass backend instance in install_cache #61

0.4.11 (2016-03-07)#

  • ignore_parameters feature, thanks to @themiurgo and @YetAnotherNerd (#52, #55)

  • More informative message for missing backend dependencies, thanks to @Garrett-R (#60)

0.4.10 (2015-04-28)#

  • Better transactional handling in sqlite #50, thanks to @rgant

  • Compatibility with streaming in requests >= 2.6.x

0.4.9 (2015-01-17)#

  • expire_after now also accepts timedelta, thanks to @femtotrader

  • Added Ability to include headers to cache key (include_get_headers option)

  • Added string representation for CachedSession

0.4.8 (2014-12-13)#

  • Fix bug in reading cached streaming response

0.4.7 (2014-12-06)#

  • Fix compatibility with Requests > 2.4.1 (json arg, response history)

0.4.6 (2014-10-13)#

  • Monkey patch now uses class instead lambda (compatibility with rauth)

  • Normalize (sort) parameters passed as builtin dict

0.4.5 (2014-08-22)#

  • Requests==2.3.0 compatibility, thanks to @gwillem

0.4.4 (2013-10-31)#

  • Check for backend availability in install_cache(), not at the first request

  • Default storage fallbacks to memory if sqlite is not available

0.4.3 (2013-09-12)#

  • Fix response.from_cache not set in hooks

0.4.2 (2013-08-25)#

  • Fix UnpickleableError for gzip responses

0.4.1 (2013-08-19)#

  • requests_cache.enabled() context manager

  • Compatibility with Requests 1.2.3 cookies handling

0.4.0 (2013-04-25)#

  • Redis backend. Thanks to @michaelbeaumont

  • Fix for changes in Requests 1.2.0 hooks dispatching

0.3.0 (2013-02-24)#

  • Support for Requests 1.x.x

  • CachedSession

  • Many backward incompatible changes

0.2.1 (2013-01-13)#

  • Fix broken PyPi package

0.2.0 (2013-01-12)#

  • Last backward compatible version for Requests 0.14.2

0.1.3 (2012-05-04)#

  • Thread safety for default sqlite backend

  • Take into account the POST parameters when cache is configured with ‘POST’ in allowable_methods

0.1.2 (2012-05-02)#

  • Reduce number of sqlite database write operations

  • fast_save option for sqlite backend

0.1.1 (2012-04-11)#

  • Fix: restore responses from response.history

  • Internal refactoring (MemoryCache -> BaseCache, reduce_response and restore_response moved to BaseCache)

  • connection option for MongoCache

0.1.0 (2012-04-10)#

  • initial PyPI release