django_model_cached_property - Кешування property для окремих об'єктів моделей в Django

cache, model_cached_property, invalidate, redis, Python 3, Django

Представляю реліз стабільної батареї django_model_cached_property для кешування property для окремих об'єктів моделей Django.

Я вже розповідав, що evileg_core містить такий функціонал, але ось вирішив вивести це кешування в окремий пакет. Це пов'язано з тим, що я не встигаю підтримувати такий великий пакет, а окремий невеликий функціонал використовую і в інших проектах. Тому мені здалося логічним розбити великий проект на самостійні проекти, щоб було простіше займатися підтримкою принаймні найбільш затребуваного функціоналу хоча б у рамках своїх проектів. Також сподіваюся, що цей пакет виявиться дуже корисним для інших розробників.

Призначення

Пакет використовується для кешування результату методів об'єктів моделей на період, який довше за існування інстансу обхекта під час обробки запиту користувача. Це необхідно для того, щоб кешувати важкі запити до бази даних, результати яких теоретично не повинні змінюватися досить часто, але при цьому їх виклик кожного разу при запиті користувача може зменшити швидкість роботи користувача з Django додатком. Це може бути корисно, наприклад, для інформації про те, чи лайкнув користувач якийсь об'єкт, а також кількість тих, хто лайкнув, у тому випадку якщо використовуються Generic зв'язки в базі даних. На жаль, такі зв'язки працюють не так швидко, як хотілося б. Тому правильне кешування може дуже прискорити роботу сайту.

А тепер розповім, як користуватися цим функціоналом

Встановити

pip install -U django-model-cached-property

Встановіть і налаштуйте вимоги

Встановіть redis для кешування.

sudo apt install redis-server

Налаштуйте setup.py вашого проекту django.

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    }
}

Використання

Пакет містить дві функції:

• model_cached_property - це декоратор для методів класу, який буде кешувати результати виклику властивості для окремих записів.
• invalidate_model_cached_property - це функція для визнання недійсним методу властивості запису моделі.

model_cached_property

Ви можете використовувати цей декоратор наступним чином.

from django_model_cached_property import model_cached_property

class Article(models.Model):

    @model_cached_property
    def comments_count(self):
        return self.comments.count()

Це означає, що ви кешуєте кількість коментарів для кожного запису статті у вашому проекті Django.

Ви можете налаштувати тайм-аут кешу 3000 секунд наступним чином.

class Article(models.Model):

    @model_cached_property(timeout=3000)
    def comments_count(self):
        return self.comments.count()

За замовчуванням час очікування кешування становить 60 секунд, ви можете налаштувати його глобально в settings.py .

MODEL_CACHED_PROPERTY_TIMEOUT = 300000

Крім того, ви можете використовувати кешування властивості моделі з вхідними аргументами.

І в цьому випадку кешування буде оцінено для всіх вхідних наборів аргументів.

Наприклад, кешування автентифікованим користувачем.

class Article(models.Model):

    @model_cached_property
    def __user_in_bookmarks(self, user):
        return self.bookmarks.filter(user=user).exists()

    def user_in_bookmarks(self, user):
        return self.__user_in_bookmarks(user) if user.is_authenticated else False

invalidate_model_cached_property

Ця функція робить недійсними всі ключі кешу властивості для одного запису моделі в базі даних.

Наприклад

article = get_object_or_404(Article, pk=12)
invalidate_model_cached_property(article, article.comments_count)

У цьому випадку ви скасуєте всі кешовані ключі для статті з первинним ключем 2.

ПОПЕРЕДЖЕННЯ - Обмеження

Обмеження цієї функції кешування полягає в тому, що ви можете використовувати її лише з унікальними вхідними аргументами.
Це означає, що не працюватиме з об’єктом AnonymousUser, тому що в кожному запиті інформація про об’єкт AnonymousUser буде різною, хоча він буде викликатися одним і тим же користувачем.
Тому використовуйте його лише для унікальної інформації.

Висновок

Дорогі користувачі сайту EVILEG, якщо Вам не буде важко, будь ласка, оцініть зірочкою репозиторій проекту на GitHub