dj-corekit 0.1.0

Small Django utilities built on Django core.

dj-corekit

Small Django utilities built on Django core.

Install

pip install dj-corekit

Cache Page

Function view:

from dj_corekit.cache import cache_page


@cache_page(
    timeout=300,
    key_func=lambda request: f"product:{request.GET.get('id')}",
    headers=lambda request, response: {
        "X-Cache-Scope": "product",
        "Cache-Control": "public, max-age=300",
    },
)
def product_detail(request):
    ...

Class-based view with Django's method_decorator:

from django.utils.decorators import method_decorator
from django.views import View
from dj_corekit.cache import cache_page


@method_decorator(
    cache_page(timeout=300, key_func=lambda request: "product:list"),
    name="dispatch",
)
class ProductListView(View):
    ...

Class-based view with the mixin:

from django.views import View
from dj_corekit.cache import CachePageMixin


class ProductDetailView(CachePageMixin, View):
    cache_timeout = 300
    cache_headers = {"X-Cache-Scope": "product"}

    def get_cache_key(self, request):
        return f"product:{self.kwargs['pk']}"

key_func returns the full Django cache key. The response is stored through django.core.cache.caches[cache_alias].

Only 200 responses are cached. TemplateResponse objects are cached after rendering. Set request.do_not_cache = True or return False from only_if to bypass caching.

API

cache_page(
    timeout,
    key_func,
    *,
    headers=None,
    cache_alias="default",
    only_if=None,
)

class CachePageMixin:
    cache_timeout = 300
    cache_headers = None
    cache_alias = "default"
    cache_only_if = None

    def get_cache_key(self, request):
        ...

• timeout: seconds, or a callable receiving the response.
• key_func: callable receiving the request and returning the full cache key.
• headers: dict or callable receiving (request, response) and returning a header dict. These headers are applied before the response is cached.
• cache_alias: Django cache alias, default "default".
• only_if: callable receiving the request. Return False to bypass cache.

Development

python -m pip install -e ".[dev]"
python -m pytest
ruff check .
ruff format --check .
tox