epok-toolkit 1.6.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

epok_toolkit/cache/__init__.py

@@ -0,0 +1 @@
+from .cacher import cache_full, cache_get, CachedViewSet, TimeToLive

epok_toolkit/cache/cacher.py

@@ -0,0 +1,130 @@
+# utils/cacher.py
+from rest_framework import viewsets
+from rest_framework_extensions.cache.mixins import CacheResponseMixin
+from rest_framework_extensions.cache.decorators import cache_response
+from django.views.decorators.cache import cache_page
+from colorstreak import log
+from functools import wraps
+from django.utils.decorators import method_decorator
+# --- clave por usuario + params + página ----------------------
+from rest_framework_extensions.key_constructor.constructors import DefaultKeyConstructor
+from rest_framework_extensions.key_constructor.bits import UserKeyBit, QueryParamsKeyBit, PaginationKeyBit
+
+
+"""
+cacher.py — utilidades de caché centralizadas
+============================================
+
+Este módulo agrupa, en un solo lugar, las dos capas de caché que aplicamos en
+nuestra API DRF:
+
+    📦  cache_get   → capa de *serialización*  (drf extensions @cache_response)
+    🚀  cache_full  → capa de *vista completa* (Django @cache_page)
+
+Para no repetir la misma lógica en cada vista, exportamos:
+
+    •  `CachedViewSet`  ->  incluye CacheResponseMixin listo para usar.
+    •  Decoradores      ->  `cache_get`,  `cache_full`.
+    •  `TimeToLive`     ->  constantes de segundos ligadas a colores/emoji.
+
+Leyenda TTL (la misma del CSV)
+------------------------------
+    🔴  1 min   (60 s)      | cambios frecuentes
+    🟡  2 --> 5 min (~300 s)     | lecturas comunes
+    🟢  10 --> 30 min (~1800 s)  | datos casi estáticos
+
+Emojis ↔ capas
+--------------
+    🗄️   consultas ORM   (cacheops / get_or_set)
+    📦   serialización   (cache_response)
+    🚀   vista completa  (cache_page)
+    🌐   CDN / navegador (Cache‑Control)
+
+"""
+
+
+
+class TimeToLive:
+    """
+    Constantes de TTL ligadas a la paleta del CSV:
+
+        🔴 RED    | 1 min  (60 s)
+        🟡 YELLOW | 5 min  (300 s)
+        🟢 GREEN  | 30 min (1800 s)
+    """
+    RED    = 60          # 1 minuto
+    YELLOW = 60 * 5      # 5 minutos
+    GREEN  = 60 * 30     # 30 minutos
+
+
+class UserQueryKey(DefaultKeyConstructor):
+    user = UserKeyBit()
+    query_params = QueryParamsKeyBit()
+    pagination = PaginationKeyBit()
+
+_DEFAULT_KEY  = UserQueryKey().get_key
+_DEFAULT_TTL  = TimeToLive.RED
+
+
+
+class CachedViewSet(CacheResponseMixin, viewsets.ModelViewSet):
+    """
+    Herédame si vas a usar cache_get o cache_full.
+    Nada más que eso; no impone TTL.
+    """
+    pass
+
+
+
+
+def cache_get(ttl=_DEFAULT_TTL, key_func=_DEFAULT_KEY):
+    """
+    Capa: Serialización 📦
+    Devuelve un decorador que cachea la serialización DRF *una sola vez*,
+    evitando envolver la vista nuevamente en cada petición.
+
+    Ejemplo:
+        @cache_get(ttl=TimeToLive.RED)
+        def view(...): ...
+    """
+    def decorator(view_fn):
+        # Pre‑construimos la función cacheada UNA vez
+        cached_fn = cache_response(ttl, key_func=key_func)(view_fn)
+
+        @wraps(view_fn)
+        def wrapped(*args, **kwargs):
+            log.debug(
+                f"[📦 cache_get] {view_fn.__qualname__} | ttl={ttl}s"
+            )
+            # Llamamos directamente a la versión ya decorada,
+            # para no crear cadenas de closures ni excepciones duplicadas.
+            return cached_fn(*args, **kwargs)
+
+        return wrapped
+
+    return decorator
+
+
+def cache_full(ttl=_DEFAULT_TTL, key_prefix=""):
+    """
+    Capa: Respuesta HTTP 🚀
+    Devuelve un decorador que cachea la vista completa vía cache_page
+    *al momento de ejecutar la vista*.
+
+    Ejemplo:
+        @cache_full(ttl=TimeToLive.GREEN, key_prefix="ticket_pdf")
+        def view(...): ...
+    """
+    def decorator(view_fn):
+        # Adapt the function-level cache_page decorator to a bound‑method
+        page_deco = cache_page(ttl, key_prefix=key_prefix)
+        decorated_fn = method_decorator(page_deco)(view_fn)
+
+        @wraps(view_fn)
+        def wrapped(self, request, *args, **kwargs):
+            log.debug(f"[🚀 cache_full] {view_fn.__qualname__} | ttl={ttl}s | prefix={key_prefix}")
+            return decorated_fn(self, request, *args, **kwargs)
+
+        return wrapped
+
+    return decorator

{epok_toolkit-1.6.0.dist-info → epok_toolkit-1.7.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: epok-toolkit
-Version: 1.6.0
-Summary: A toolkit for building Django applications with Celery support
+Version: 1.7.1
+Summary: Una herramienta para la gestión de tareas y procesos en Django con Celery.
 Author-email: Fernando Leon Franco <fernanlee2131@gmail.com>
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -14,6 +14,7 @@ License-File: LICENSE
 Requires-Dist: Django>=5.0.2
 Requires-Dist: celery[redis]>=5.5.3
 Requires-Dist: django-celery-beat>=2.6.0
+Requires-Dist: colorstreak>=0.1.0
 Dynamic: license-file
 
 # EPOK Toolkit

{epok_toolkit-1.6.0.dist-info → epok_toolkit-1.7.1.dist-info}/RECORD

@@ -1,6 +1,8 @@
 epok_toolkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 epok_toolkit/apps.py,sha256=O3q3CcucJOHjlYIS0VgbKsbtim2hpng_FxpKEG_MlWs,486
 epok_toolkit/default_settings.py,sha256=hxsRmsAcjk4ar-pRz_X6AI17mJ3192Ljbx-xBuP5rdY,452
+epok_toolkit/cache/__init__.py,sha256=q1-pMbXk-r80a3woyq01E84Tt6kB-UH5u06XoQROaM0,68
+epok_toolkit/cache/cacher.py,sha256=R179_Hrlw1k0tsry9EN0zGl4-Of02L-VzE-xqFuXjaU,4107
 epok_toolkit/email/__init__.py,sha256=pyJwysyVoq6DuYAG72fulsKFoOuAfjw3aBH7FhmYGHc,35
 epok_toolkit/email/email_async.py,sha256=oC0WowWNUpTpXdxo6hJag5gWUaStxI6VBEArEKQxXko,1521
 epok_toolkit/email/engine.py,sha256=IIifqRI9z76pHdrO5oSSZ25aP5txOTAgrj1JuVVPlMY,2387
@@ -16,8 +18,8 @@ epok_toolkit/pdf/fuentes/Kollektif-Italic.ttf,sha256=1CXPyw43il9u0tQ_7aRzsEaVtg3
 epok_toolkit/pdf/fuentes/Kollektif.ttf,sha256=7wTLkVVNUm1giLjIZcWRUH5r2r3o0GjdKic4V1A-pNQ,51128
 epok_toolkit/pdf/plantillas/Ticket_congrats.png,sha256=OSQhVR0j_nLHE6kSJ33BTR-77HM1fNAfJBe2EuX6wVk,157141
 epok_toolkit/pdf/plantillas/Ticket_congrats2.png,sha256=1RBogBdo-8WSMpD3H73HoLgJtr5EC5oVKfOCIWOxPSo,373605
-epok_toolkit-1.6.0.dist-info/licenses/LICENSE,sha256=iLDbGXdLSIOT5OsxzHCvtmxHtonE21GiFlS3LNkug4A,128
-epok_toolkit-1.6.0.dist-info/METADATA,sha256=jMrP_7XOpAwTpD2wv4TewTqL3ZLd0rfML_7xCWFI04Q,739
-epok_toolkit-1.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-epok_toolkit-1.6.0.dist-info/top_level.txt,sha256=Wo72AqIFcfWwBGM5F5iGFw9PrO3WBnTSprFZIJk_pNg,13
-epok_toolkit-1.6.0.dist-info/RECORD,,
+epok_toolkit-1.7.1.dist-info/licenses/LICENSE,sha256=iLDbGXdLSIOT5OsxzHCvtmxHtonE21GiFlS3LNkug4A,128
+epok_toolkit-1.7.1.dist-info/METADATA,sha256=ty3DKZsCJ_239FAUKBJAIK46nbU9ZPZhfP5MRUIbFnM,786
+epok_toolkit-1.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+epok_toolkit-1.7.1.dist-info/top_level.txt,sha256=Wo72AqIFcfWwBGM5F5iGFw9PrO3WBnTSprFZIJk_pNg,13
+epok_toolkit-1.7.1.dist-info/RECORD,,