django-smart-cache 0.1.1

Biblioteca de cache incrivelmente poderosa para Django.

django-smart-cache

Biblioteca de cache inteligente e automática para Django e Django Rest Framework.

Visão Geral

O django-smart-cache oferece decorators e utilitários para adicionar cache automático em views e viewsets do Django/DRF, invalidando o cache sempre que modelos relacionados sofrem alterações. Ideal para APIs e páginas que precisam de alta performance sem perder a atualização dos dados.

• Cache automático para views e viewsets
• Invalidação automática ao alterar modelos relacionados
• Suporte a autenticação (cache por usuário/token)
• Fácil integração com projetos Django existentes

Instalação

Requisitos:

• Python >= 3.8
• Django == 2.2
• djangorestframework == 3.10

Instale via pip:

pip install django-smart-cache

Configuração

Adicione django_smart_cache ao seu INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "django_smart_cache.apps.DjangoSmartCacheConfig",
]

Importante: Para que o Django reconheça os decorators de cache e mapeie corretamente as models que invalidarão o cache, é necessário importar explicitamente as views ou viewsets que utilizam os decorators dentro do método ready do seu apps.py.

Exemplo:

# myapp/apps.py
from django.apps import AppConfig


class MyAppConfig(AppConfig):
    name = "myapp"

    def ready(self):
        from myapp import views
        from myapp.api import viewsets
        ...

Configure o cache do Django normalmente (exemplo com memória local):

CACHES = {
    "default": {
        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
        "LOCATION": "unique-snowflake",
    }
}

Como Usar

Cache em Viewsets (DRF)

from django_smart_cache.viewsets import cache_viewset


@cache_viewset(models=["myapp.MyModel"], timeout=60)
class MyViewSet(viewsets.ModelViewSet):
    ...

• models: lista de modelos que, ao serem alterados, invalidam o cache.
• timeout: tempo do cache em segundos (padrão: 900).

Cache em Views (função ou classe)

from django_smart_cache.views import cache_view


@cache_view(models=["myapp.MyModel"], timeout=60)
def minha_view(request):
    ...

Exemplo Completo

from rest_framework import viewsets, serializers
from django_smart_cache.viewsets import cache_viewset
from .models import MyModel


class MySerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = "__all__"


@cache_viewset(models=["myapp.MyModel"], timeout=60)
class MyViewSet(viewsets.ModelViewSet):
    serializer_class = MySerializer
    queryset = MyModel.objects.all()

Funcionamento Interno

• O decorator gera uma chave de cache única por usuário/token e parâmetros da requisição.
• O cache é invalidado automaticamente via signals (post_save, post_delete, m2m_changed) dos modelos informados.
• Suporta cache para métodos list e retrieve em viewsets, e qualquer view baseada em função/classe.

Testes

O projeto já inclui testes automatizados com pytest e pytest-django.

Para rodar os testes:

pytest

Desenvolvimento

• Código-fonte: src/django_smart_cache/
• Testes: src/tests/
• Exemplo de template: src/tests/templates/cached_template.html

Autor

Alan Gomes ([e-mail])

Licença

MIT