debian-django-cachalot/cachalot/monkey_patch.py

177 lines
5.3 KiB
Python

# coding: utf-8
from __future__ import unicode_literals
from collections import Iterable
from functools import wraps
from time import time
from django.db.backends.utils import CursorWrapper
from django.db.models.query import EmptyResultSet
from django.db.models.signals import post_migrate
from django.db.models.sql.compiler import (
SQLCompiler, SQLInsertCompiler, SQLUpdateCompiler, SQLDeleteCompiler)
from django.db.transaction import Atomic, get_connection
from django.test import TransactionTestCase
from .api import invalidate_all, invalidate_tables
from .cache import cachalot_caches
from .settings import cachalot_settings
from .utils import (
_get_query_cache_key, _invalidate_tables,
_get_table_cache_keys, _get_tables_from_sql)
WRITE_COMPILERS = (SQLInsertCompiler, SQLUpdateCompiler, SQLDeleteCompiler)
def _unset_raw_connection(original):
def inner(compiler, *args, **kwargs):
compiler.connection.raw = False
out = original(compiler, *args, **kwargs)
compiler.connection.raw = True
return out
return inner
def _get_result_or_execute_query(execute_query_func, cache_key,
table_cache_keys):
cache = cachalot_caches.get_cache()
data = cache.get_many(table_cache_keys + [cache_key])
new_table_cache_keys = set(table_cache_keys)
new_table_cache_keys.difference_update(data)
if new_table_cache_keys:
now = time()
d = {}
for k in new_table_cache_keys:
d[k] = now
cache.set_many(d, None)
elif cache_key in data:
timestamp, result = data.pop(cache_key)
table_times = data.values()
if table_times and timestamp > max(table_times):
return result
result = execute_query_func()
if isinstance(result, Iterable) \
and not isinstance(result, (tuple, list)):
result = list(result)
cache.set(cache_key, (time(), result), None)
return result
def _patch_compiler(original):
@wraps(original)
@_unset_raw_connection
def inner(compiler, *args, **kwargs):
execute_query_func = lambda: original(compiler, *args, **kwargs)
if not cachalot_settings.CACHALOT_ENABLED \
or isinstance(compiler, WRITE_COMPILERS) \
or (not cachalot_settings.CACHALOT_CACHE_RANDOM
and '?' in compiler.query.order_by):
return execute_query_func()
try:
cache_key = _get_query_cache_key(compiler)
except EmptyResultSet:
return execute_query_func()
return _get_result_or_execute_query(
execute_query_func, cache_key, _get_table_cache_keys(compiler))
inner.original = original
return inner
def _patch_write_compiler(original):
@wraps(original)
def inner(compiler, *args, **kwargs):
_invalidate_tables(cachalot_caches.get_cache(), compiler)
return original(compiler, *args, **kwargs)
inner.original = original
return inner
def _patch_orm():
SQLCompiler.execute_sql = _patch_compiler(SQLCompiler.execute_sql)
for compiler in WRITE_COMPILERS:
compiler.execute_sql = _patch_write_compiler(compiler.execute_sql)
def _patch_cursor():
def _patch_cursor_execute(original):
@wraps(original)
def inner(cursor, sql, *args, **kwargs):
out = original(cursor, sql, *args, **kwargs)
if getattr(cursor.db, 'raw', True) \
and cachalot_settings.CACHALOT_INVALIDATE_RAW:
sql = sql.lower()
if 'update' in sql or 'insert' in sql or 'delete' in sql:
tables = _get_tables_from_sql(cursor.db, sql)
invalidate_tables(tables, db_alias=cursor.db.alias)
return out
inner.original = original
return inner
CursorWrapper.execute = _patch_cursor_execute(CursorWrapper.execute)
CursorWrapper.executemany = _patch_cursor_execute(CursorWrapper.executemany)
def _patch_atomic():
def patch_enter(original):
@wraps(original)
def inner(self):
cachalot_caches.enter_atomic()
original(self)
inner.original = original
return inner
def patch_exit(original):
@wraps(original)
def inner(self, exc_type, exc_value, traceback):
needs_rollback = get_connection(self.using).needs_rollback
original(self, exc_type, exc_value, traceback)
cachalot_caches.exit_atomic(exc_type is None
and not needs_rollback)
inner.original = original
return inner
Atomic.__enter__ = patch_enter(Atomic.__enter__)
Atomic.__exit__ = patch_exit(Atomic.__exit__)
def _patch_tests():
def patch_transaction_test_case(original):
@wraps(original)
def inner(*args, **kwargs):
out = original(*args, **kwargs)
invalidate_all()
return out
inner.original = original
return inner
TransactionTestCase._fixture_setup = patch_transaction_test_case(
TransactionTestCase._fixture_setup)
def _invalidate_on_migration(sender, **kwargs):
db_alias = kwargs['using']
invalidate_all(db_alias=db_alias)
def patch():
post_migrate.connect(_invalidate_on_migration)
_patch_cursor()
_patch_tests()
_patch_atomic()
_patch_orm()