在Django中创建自定义字段查找

时间:2010-02-04 20:59:29

标签: python django django-queryset

如何在Django中创建自定义field lookups

过滤查询集时,django会提供一组您可以使用的查找:__contains__iexact__in等。我希望能够为我的经理提供新的查找,例如,有人可以说:

twentysomethings = Person.objects.filter(age__within5=25)

并获取年龄在20到30之间的所有Person个对象。我是否需要继承QuerySetManager类才能执行此操作?如何实施?

4 个答案:

答案 0 :(得分:12)

更灵活的方法是编写自定义QuerySet以及自定义管理器。使用ozan的代码:

class PersonQuerySet(models.query.QuerySet):
    def in_age_range(self, min, max):
        return self.filter(age__gte=min, age__lt=max)

class PersonManager(models.Manager):
    def get_query_set(self):
         return PersonQuerySet(self.model)

    def __getattr__(self, name):
        return getattr(self.get_query_set(), name)

class Person(models.Model):
    age = #...

    objects = PersonManager()

这允许您链接自定义查询。所以这两个查询都是有效的:

Person.objects.in_age_range(20,30)

Person.objects.exclude(somefield = some_value).in_age_range(20, 30)

答案 1 :(得分:6)

不是创建字段查找,而是最好的做法是创建一个管理器方法,可能看起来有点像这样:

class PersonManger(models.Manager):
    def in_age_range(self, min, max):
        return self.filter(age__gte=min, age__lt=max)

class Person(models.Model):
    age = #...

    objects = PersonManager()

那么用法就是这样:

twentysomethings = Person.objects.in_age_range(20, 30)

答案 2 :(得分:6)

首先,请允许我说,没有任何Django机制能够公开促进您的需求。

(编辑 - 实际上自Django 1.7以来:https://docs.djangoproject.com/en/1.7/howto/custom-lookups/

也就是说,如果真的想要完成此操作,请继承QuerySet并覆盖_filter_or_exclude()方法。然后创建一个只返回自定义QuerySet(或猴子补丁Django的QuerySet,yuck)的自定义管理器。我们在neo4django中执行此操作,以便在构建特定于Neo4j的Query对象时尽可能多地重用Django ORM查询集代码。

根据扎克的回答改编一些(粗略地)这样的东西。我已经将字段查找解析的实际错误处理留作了读者的练习:)

class PersonQuerySet(models.query.QuerySet):
    def _filter_or_exclude(self, negate, *args, **kwargs):
        cust_lookups = filter(lambda s: s[0].endswith('__within5'), kwargs.items())
        for lookup in cust_lookups:
            kwargs.pop(lookup[0])
            lookup_prefix = lookup[0].rsplit('__',1)[0]
            kwargs.update({lookup_prefix + '__gte':lookup[1]-5,
                           lookup_prefix + '__lt':lookup[1]+5})
        return super(PersonQuerySet, self)._filter_or_exclude(negate, *args, **kwargs)

class PersonManager(models.Manager):
    def get_query_set(self):
         return PersonQuerySet(self.model)

class Person(models.Model):
    age = #...

    objects = PersonManager()

最后的评论 - 显然,如果你想链接自定义字段查找,这将变得非常毛茸茸。另外,我通常会在功能上更多地编写这个并使用itertools来表现,但是认为将其删除更为明确。玩得开心!

答案 3 :(得分:1)

从Django 1.7开始,有一种简单的方法可以实现它。您的示例实际上与the documentation中的示例非常相似:

from django.db.models import Lookup

class AbsoluteValueLessThan(Lookup):
    lookup_name = 'lt'

    def as_sql(self, qn, connection):
        lhs, lhs_params = qn.compile(self.lhs.lhs)
        rhs, rhs_params = self.process_rhs(qn, connection)
        params = lhs_params + rhs_params + lhs_params + rhs_params
        return '%s < %s AND %s > -%s' % (lhs, rhs, lhs, rhs), params

AbsoluteValue.register_lookup(AbsoluteValueLessThan)

注册时,您只需使用Field.register_lookup(AbsoluteValueLessThan)