Пользовательский QuerySet и Manager, не нарушая DRY?

Я пытаюсь найти способ реализовать как пользовательский QuerySet и обычай Manager не нарушая СУХОЙ. Это то, что я до сих пор:

class MyInquiryManager(models.Manager):
    def for_user(self, user):
        return self.get_query_set().filter(
                    Q(assigned_to_user=user) |
                    Q(assigned_to_group__in=user.groups.all())
                )

class Inquiry(models.Model):   
    ts = models.DateTimeField(auto_now_add=True)
    status = models.ForeignKey(InquiryStatus)
    assigned_to_user = models.ForeignKey(User, blank=True, null=True)
    assigned_to_group = models.ForeignKey(Group, blank=True, null=True)
    objects = MyInquiryManager()

Это работает нормально, пока я не сделаю что-то вроде этого:

inquiries = Inquiry.objects.filter(status=some_status)
my_inquiry_count = inquiries.for_user(request.user).count()

Это быстро ломает все, потому что QuerySet не имеет такие же методы, как Manager, Я пытался создать кастом QuerySet класс, и реализуя его в MyInquiryManager, но я заканчиваю тем, что повторил все мои определения методов.

Я также нашел этот фрагмент, который работает, но мне нужно передать дополнительный аргумент for_user поэтому он ломается, потому что сильно зависит от переопределения get_query_set,

Есть ли способ сделать это без переопределения всех моих методов в обоих QuerySet и Manager подклассы?

Источник

8 ответов

Решение

Джанго изменился! Перед использованием кода в этом ответе, который был написан в 2009 году, обязательно ознакомьтесь с остальными ответами и документацией по Django, чтобы увидеть, есть ли более подходящее решение.

Я реализовал это путем добавления фактического get_active_for_account как метод обычая QuerySet, Затем, чтобы заставить его работать от менеджера, вы можете просто перехватить __getattr__ и вернуть его соответственно

Чтобы этот шаблон можно было использовать повторно, я извлек Manager биты в отдельный менеджер моделей:

custom_queryset / models.py

from django.db import models
from django.db.models.query import QuerySet

class CustomQuerySetManager(models.Manager):
    """A re-usable Manager to access a custom QuerySet"""
    def __getattr__(self, attr, *args):
        try:
            return getattr(self.__class__, attr, *args)
        except AttributeError:
            # don't delegate internal methods to the queryset
            if attr.startswith('__') and attr.endswith('__'):
                raise
            return getattr(self.get_query_set(), attr, *args)

    def get_query_set(self):
        return self.model.QuerySet(self.model, using=self._db)

После того, как вы получите это, на ваших моделях все, что вам нужно сделать, это определить QuerySet как пользовательский внутренний класс и установите менеджер на свой собственный менеджер:

your_app / models.py

from custom_queryset.models import CustomQuerySetManager
from django.db.models.query import QuerySet

class Inquiry(models.Model):
    objects = CustomQuerySetManager()

    class QuerySet(QuerySet):
        def active_for_account(self, account, *args, **kwargs):
            return self.filter(account=account, deleted=False, *args, **kwargs)

С этим шаблоном, любой из них будет работать:

>>> Inquiry.objects.active_for_account(user)
>>> Inquiry.objects.all().active_for_account(user)
>>> Inquiry.objects.filter(first_name='John').active_for_account(user)

UPD, если вы используете его с пользовательским пользователем (AbstractUser), вам нужно изменить
от

class CustomQuerySetManager(models.Manager):

в

from django.contrib.auth.models import UserManager

class CustomQuerySetManager(UserManager):
    ***
Источник

В Django 1.7 появился новый и простой способ создания комбинированного менеджера наборов запросов и моделей:

class InquiryQuerySet(models.QuerySet):
    def for_user(self):
        return self.filter(
            Q(assigned_to_user=user) |
            Q(assigned_to_group__in=user.groups.all())
        )

class Inquiry(models.Model):
    objects = InqueryQuerySet.as_manager()

Посмотрите Создание Менеджера с методами QuerySet для получения дополнительной информации.

Источник

Вы можете предоставить методы в менеджере и наборе запросов, используя миксин. Смотрите следующую технику:

http://hunterford.me/django-custom-model-manager-chaining/

Это также позволяет избежать использования __getattr__() подход.

from django.db.models.query import QuerySet

class PostMixin(object):
    def by_author(self, user):
        return self.filter(user=user)

    def published(self):
        return self.filter(published__lte=datetime.now())

class PostQuerySet(QuerySet, PostMixin):
    pass

class PostManager(models.Manager, PostMixin):
    def get_query_set(self):
        return PostQuerySet(self.model, using=self._db)
Источник

Теперь вы можете использовать метод from_queryset() вашего менеджера, чтобы изменить его базовый набор запросов.

Это позволяет вам определять методы Queryset и методы вашего менеджера только один раз.

из документов

Для расширенного использования вам может понадобиться и настраиваемый Manager, и настраиваемый QuerySet. Вы можете сделать это, вызвав Manager.from_queryset(), который возвращает подкласс вашего базового Manager с копией настраиваемых методов QuerySet:

class InqueryQueryset(models.Queryset):
    def custom_method(self):
        """ available on all default querysets"""

class BaseMyInquiryManager(models.Manager):
    def for_user(self, user):
        return self.get_query_set().filter(
                    Q(assigned_to_user=user) |
                    Q(assigned_to_group__in=user.groups.all())
                )

MyInquiryManager = BaseInquiryManager.from_queryset(InquiryQueryset)

class Inquiry(models.Model):   
    ts = models.DateTimeField(auto_now_add=True)
    status = models.ForeignKey(InquiryStatus)
    assigned_to_user = models.ForeignKey(User, blank=True, null=True)
    assigned_to_group = models.ForeignKey(Group, blank=True, null=True)
    objects = MyInquiryManager()
Источник

на основе исходного кода django я смог найти простое решение

      from django.db.models.manager import BaseManager

class MyQuerySet(models.query.QuerySet):
      def my_custom_query(self):
          return self.filter(...)

class MyManager(BaseManager.from_queryset(MyQuerySet)):
     ...

class MyModel(models.Model):
     objects = MyManager()
Источник

Немного улучшенная версия подхода Т. Стоуна:

def objects_extra(mixin_class):
    class MixinManager(models.Manager, mixin_class):
        class MixinQuerySet(QuerySet, mixin_class):
            pass

        def get_query_set(self):
            return self.MixinQuerySet(self.model, using=self._db)

    return MixinManager()

Декораторы классов делают использование таким простым:

class SomeModel(models.Model):
    ...
    @objects_extra
    class objects:
        def filter_by_something_complex(self, whatever parameters):
            return self.extra(...)
        ...

Обновление: поддержка нестандартных базовых классов Manager и QuerySet, например, @objects_extra (django.contrib.gis.db.models.GeoManager, django.contrib.gis.db.models.query.GeoQuerySet):

def objects_extra(Manager=django.db.models.Manager, QuerySet=django.db.models.query.QuerySet):
    def oe_inner(Mixin, Manager=django.db.models.Manager, QuerySet=django.db.models.query.QuerySet):
        class MixinManager(Manager, Mixin):
            class MixinQuerySet(QuerySet, Mixin):
                pass

            def get_query_set(self):
                return self.MixinQuerySet(self.model, using=self._db)

        return MixinManager()

    if issubclass(Manager, django.db.models.Manager):
        return lambda Mixin: oe_inner(Mixin, Manager, QuerySet)
    else:
        return oe_inner(Mixin=Manager)
Источник

Существуют случаи использования, когда нам нужно вызывать собственные методы QuerySet из менеджера вместо использования get_manager метод QuerySet.

Подмешивания будет достаточно на основе решения, опубликованного в одном из принятых комментариев к решению.

      class CustomQuerySetManagerMixin:
    """
    Allow Manager which uses custom queryset to access queryset methods directly.
    """
    def __getattr__(self, name):
        # don't delegate internal methods to queryset
        # NOTE: without this, Manager._copy_to_model will end up calling
        # __getstate__ on the *queryset* which causes the qs (as `all()`)
        #  to evaluate itself as if it was being pickled (`len(self)`)
        if name.startswith('__'):
            raise AttributeError
        return getattr(self.get_queryset(), name)

Например,

      class BookQuerySet(models.QuerySet):
    def published(self):
        return self.filter(published=True)

    def fiction(self):
        return self.filter(genre="fiction")

    def non_fiction(self):
        return self.filter(genre="non-fiction")

class BookManager(CustomQuerySetManagerMixin, models.Manager):
    def get_queryset(self):
        return BookQuerySet(self.model, using=self._db).published()

class Book(models.Model):
    title = models.CharField(max_length=200)
    genre = models.CharField(choices=[('fiction', _('Fiction')), ('non-fiction', _('Non-Fiction'))])
    published = models.BooleanField(default=False)
    author = models.ForeignKey(Author, on_delete=models.CASCADE, related_name="books")

    objects = BookManager()

class Author(models.Model):
    name = models.CharField(max_length=200)

С помощью вышесказанного мы можем получить доступ к связанным объектам (книге), как показано ниже, без определения новых методов в диспетчере для каждого метода набора запросов.

      fiction_books = author.books.fiction()
Источник

Следующее работает для меня.

def get_active_for_account(self,account,*args,**kwargs):
    """Returns a queryset that is 
    Not deleted
    For the specified account
    """
    return self.filter(account = account,deleted=False,*args,**kwargs)

Это на менеджере по умолчанию; поэтому я делал что-то вроде:

Model.objects.get_active_for_account(account).filter()

Но нет никаких причин, по которым он не должен работать для вторичного менеджера.

Источник
Другие вопросы по тегам