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

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

48 голосов
/ 29 января 2010

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

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?

Ответы [ 6 ]

49 голосов
/ 29 января 2010

Django изменился! Перед использованием кода в этом ответе, который был написан в 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):
    ***
30 голосов
/ 13 февраля 2014

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 .

10 голосов
/ 30 августа 2013

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

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)
3 голосов
/ 20 февраля 2013

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

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, e. г. @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)
0 голосов
/ 02 мая 2019

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

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

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

Для расширенного использования вам может потребоваться как собственный менеджер, так и пользовательский набор запросов. Это можно сделать, вызвав Manager.from_queryset (), который возвращает подкласс вашего базового менеджера с копией пользовательских методов 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()
0 голосов
/ 29 января 2010

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

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()

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

...