API Reference

This section covers all the public interfaces of requests-cache.

Tip

It’s recommended to import from the top-level requests_cache package, as internal module paths may be subject to change. For example:

from requests_cache import CachedSession, RedisCache, json_serializer

Primary Modules

The following modules include the majority of the API relevant for most users:

• Session
  • CachedSession
  • CacheMixin
• Patcher
  • clear()
  • delete()
  • disabled()
  • enabled()
  • get_cache()
  • install_cache()
  • is_installed()
  • remove_expired_responses()
  • uninstall_cache()
• Backends
  • Base
  • DynamoDB
  • Filesystem
  • GridFS
  • MongoDB
  • Redis
  • SQLite
• Models
  • Base
  • Raw Response
  • Request
  • Response

Secondary Modules

The following modules are mainly for internal use, and are relevant for contributors and advanced users:

• Cache Keys
  • create_key()
  • filter_sort_dict()
  • filter_sort_json()
  • filter_sort_list()
  • filter_sort_multidict()
  • get_matched_headers()
  • normalize_body()
  • normalize_headers()
  • normalize_json_body()
  • normalize_params()
  • normalize_request()
  • normalize_url()
  • redact_response()
• Policy
  • Actions
  • Directives
  • Expiration
  • Settings
• Serializers
  • Cattrs
  • Pipeline
  • Preconf