drf-caching

Handle views caching in Django Rest Framework.

This package uses uv for project management. To get started, ensure that uv is installed on your machine and updated to the 0.5.13 version. Detailed installation instructions for uv can be found here.

Installation

uv add drf-caching

Usage

To setup caching for a view, you can use the @cache_view decorator.

from drf_caching import cache_view, GetQuerysetKey, PaginationKey, QueryParamsKey

class MyView(APIView):
    @cache_view(
        GetQuerysetKey(),
        PaginationKey(),
        QueryParamsKey("ordering", "search"),
        timeout=60,
    )
    def get(self, request):
        return Response({"message": "Hello, world!"})

You can pass multiple keys to the decorator, and the cache key will be built using all of them. You can pass the following keyword arguments to the @cache_view decorator:

• timeout: the cache timeout in seconds (can also be set on a global level using the DRF_CACHING setting)

The following keys, available in the drf_caching.keys module, can be used:

• GetObjectKey: the cache key will be built using the view's get_object method
• GetQuerylistKey: the cache key will be built using the view's get_querylist method from django-rest-multiple-models
• GetQuerysetKey: the cache key will be built using the view's get_queryset method
• LookupFieldKey: the cache key will be built using the view's kwarg matching the lookup field
• RequestDataKey: the cache key will be built using the request's data
• RequestHeadersKey: the cache key will be built using the request's headers
• RequestKwargsKey: the cache key will be built using the request's kwargs
• RequestPaginationKey: the cache key will be built using the request's pagination parameters
• RequestQueryParamsKey: the cache key will be built using the request's query parameters
• RequestUserKey: the cache key will be built using the request's user

If no keys are passed, the cache key will be built using the view name and the request's format.

The settings can be customized as such:

DRF_CACHING = {
    "CACHE": "default",
    "HEADERS": ["age", "x-cache"],
    "TIMEOUT": 60,
}

To disable caching for a specific view, or even globally, you can set timeout or TIMEOUT to 0. To make it so that cache keys never expire for a specific view, or even globally, you can set timeout or TIMEOUT to None.

The following settings are available:

• CACHE: the cache to use (defaults to default)
• HEADERS: a list of lowercase headers to include in the cache key (by default the following headers are included: age, cache-control, etag, expires, x-cache)
• TIMEOUT: the default cache timeout in seconds

To create your own cache key, you can subclass the BaseKey and BaseKeyWithFields classes and implement the _get_data method.

from drf_caching import BaseKey, BaseKeyWithFields

class CustomKey(BaseKey):
    def _get_data(self, view_instance, view_method, request, *args, **kwargs):
        return {
            "key": "value"
        }

class CustomKeyWithFields(BaseKeyWithFields):
    def _get_data(self, view_instance, view_method, request, *args, **kwargs):
        return {
            field: ...
            for field in self.fields
        }

Development

uv sync --frozen --group=development
uv run --frozen pre-commit install --install-hooks
uv run --frozen pre-commit install --hook-type=commit-msg

Acknowledgments

This project was strongly inspired by drf-extensions.

Contributing

Contributions are welcome! To get started, please refer to our contribution guidelines.

Issues

If you encounter any problems while using this package, please open a new issue here.