django 自定义QuerySet和管理器而不破坏DRY?

mi7gmzs6  于 2023-08-08  发布在  Go
关注(0)|答案(8)|浏览(159)

我试图找到一种方法来实现自定义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中实现它,但最终我复制了所有的方法定义。
我还发现this snippet可以工作,但我需要将额外的参数传递给for_user,所以它会崩溃,因为它严重依赖于重新定义get_query_set
有没有一种方法可以在不重新定义QuerySetManager子类中的所有方法的情况下做到这一点?

cwxwcias

cwxwcias1#

Django 1.7发布了一个新的简单的方法来创建组合查询集和模型管理器:

class InquiryQuerySet(models.QuerySet):
    def for_user(self, user):
        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方法创建管理器。

gab6jxml

gab6jxml2#

**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):
    ***

2nbm6dog

2nbm6dog3#

您可以使用mixin在管理器和查询集上提供方法。
这也避免了使用__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)

字符串

oo7oh9g9

oo7oh9g94#

现在可以在管理器上使用from_queryset()方法来更改其基础Queryset。
这允许您只定义一次Queryset方法和manager方法
从文档中
对于高级用法,您可能需要自定义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()

字符串

kx1ctssn

kx1ctssn5#

基于django 3.1.3源代码,我找到了一个简单的解决方案

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

字符串

cotxawn7

cotxawn76#

T. Stone的方法:

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基类,例如。g. @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)

pod7payv

pod7payv7#

在一些用例中,我们需要从管理器调用自定义QuerySet方法,而不是使用QuerySet的get_manager方法。
一个mixin基于一个被接受的解决方案评论中发布的解决方案就足够了。

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)


有了上面的内容,我们可以像下面这样访问相关对象(Book),而无需在管理器中为每个查询集方法定义新方法。

fiction_books = author.books.fiction()

rm5edbpk

rm5edbpk8#

下面的代码对我很有效。

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


但没有理由不适合一个二级经理。

相关问题