Пользовательский QuerySet и Менеджер без нарушения DRY?
Я пытаюсь найти способ реализовать как пользовательский 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
?
Ответы
Ответ 1
Джанго изменился! Перед использованием кода в этом ответе, который был написан в 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):
***
Ответ 2
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.
Ответ 3
Вы можете предоставить методы для менеджера и набор запросов с помощью mixin. См. Следующий метод:
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)
Ответ 4
Несколько улучшенная версия подхода T. Stones:
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)
Ответ 5
Вы можете использовать метод from_queryset на вашем менеджере, чтобы изменить его базовый 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()
Ответ 6
Для меня работает следующее.
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()
Но нет причин, по которым он не должен работать для вторичного менеджера.