【问题标题】:How to override the queryset giving the filters in list_filter?如何覆盖在 list_filter 中提供过滤器的查询集?
【发布时间】:2012-09-13 09:52:59
【问题描述】:

给定以下模型

class AnotherModel(models.Model):
    n = models.IntegerField()

class MyModel(models.Model):
    somefield = models.ForeignKey(AnotherModel)

和管理员

class MyModelAdmin(admin.ModelAdmin):        
    list_filter = ('somefield',)

如何过滤 AnotherModel 的实例以在我的管理过滤器中仅显示具有给定 n 值的实例?

我需要类似的东西:

过滤器

通过某个领域

全部

[给定n的AnotherModel实例列表]

【问题讨论】:

    标签: django admin


    【解决方案1】:

    ModelAdmin.querysetModelAdmin.formfield_for_foreignkey。来自文档:

    ModelAdmin 上的 queryset 方法返回管理站点可以编辑的所有模型实例的 QuerySet。覆盖此方法的一个用例是显示登录用户拥有的对象:

    class MyModelAdmin(admin.ModelAdmin):
        def queryset(self, request):
            qs = super(MyModelAdmin, self).queryset(request)
            if request.user.is_superuser:
                return qs
            return qs.filter(author=request.user)
    

    ModelAdmin 上的 formfield_for_foreignkey 方法允许您覆盖外键字段的默认表单字段。例如,要根据用户返回此外键字段的对象子集:

    class MyModelAdmin(admin.ModelAdmin):
        def formfield_for_foreignkey(self, db_field, request, **kwargs):
            if db_field.name == "car":
                kwargs["queryset"] = Car.objects.filter(owner=request.user)
            return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)
    

    这使用 HttpRequest 实例过滤 Car 外键字段以仅显示 User 实例拥有的汽车。

    [更新]

    抱歉,我没有阅读“过滤器”部分。在 Django >= 1.4 中,您可以在 list_filter argument list 中传递 django.contrib.admin.SimpleListFilter 的子类,您可以使用它来覆盖查找和查询集方法。

    from datetime import date
    
    from django.contrib import admin
    from django.utils.translation import ugettext_lazy as _
    
    class DecadeBornListFilter(admin.SimpleListFilter):
        # Human-readable title which will be displayed in the
        # right admin sidebar just above the filter options.
        title = _('decade born')
    
        # Parameter for the filter that will be used in the URL query.
        parameter_name = 'decade'
    
        def lookups(self, request, model_admin):
            """
            Returns a list of tuples. The first element in each
            tuple is the coded value for the option that will
            appear in the URL query. The second element is the
            human-readable name for the option that will appear
            in the right sidebar.
            """
            return (
                ('80s', _('in the eighties')),
                ('90s', _('in the nineties')),
            )
    
        def queryset(self, request, queryset):
            """
            Returns the filtered queryset based on the value
            provided in the query string and retrievable via
            `self.value()`.
            """
            # Compare the requested value (either '80s' or '90s')
            # to decide how to filter the queryset.
            if self.value() == '80s':
                return queryset.filter(birthday__gte=date(1980, 1, 1),
                                    birthday__lte=date(1989, 12, 31))
            if self.value() == '90s':
                return queryset.filter(birthday__gte=date(1990, 1, 1),
                                    birthday__lte=date(1999, 12, 31))
    
    class PersonAdmin(admin.ModelAdmin):
        list_filter = (DecadeBornListFilter,)
    

    【讨论】:

    • 我需要过滤过滤器的查询集,而不是模型本身。我将编辑我的问题以使其更清楚。
    • 使用 Django 1.10,您需要覆盖 get_queryset() 而不是 queryset()。
    • @AksharRaaj,你确定吗?我正在查看文档中的示例,截至Django 2.1,方法名称仍然是queryset,而不是“get_queryset”。我错过了什么吗?
    • 肯定 Django 1.10.5
    • docs for 1.10 say otherwise。请注意,这是一个过滤器,而不是基于类的视图。
    【解决方案2】:

    编辑 - 此方法已被指出存在问题,见下文

    你可以这样做:

    假设您有一个名为 Animal 的模型,该模型具有一个名为 Species 的模型的 ForeignKey 字段。在特定的管理列表中,您希望仅允许在动物过滤器选项中显示某些物种。

    首先,在 Animal 的 ModelAdmin 中指定一个名为 SpeciesFilter 的自定义 ListFilter:

    class AnimalAdmin(ModelAdmin):
        list_filter = (('species', SpeciesFilter),)
    

    然后定义 SpeciesFilter:

    from django.contrib.admin.filters import RelatedFieldListFilter
    
    class SpeciesFilter(RelatedFieldListFilter):
        def __init__(self, field, request, *args, **kwargs):
            """Get the species you want to limit it to.
            This could be determined by the request,
            But in this example we'll just specify an
            arbitrary species"""
            species = Species.objects.get(name='Tarantula')
    
            #Limit the choices on the field
            field.rel.limit_choices_to = {'species': species}
    
            #Let the RelatedFieldListFilter do its magic 
            super(SpeciesFilter, self).__init__(field, request, *args, **kwargs)
    

    应该可以的。

    【讨论】:

    • 这可能会导致意想不到的结果! (我用 Django 1.5 尝试过。)过滤器查找以某种方式被缓存。因此RelatedFieldListFilter 不适用于动态查找(例如,如果它们因用户而异)。所有用户都将获得相同的过滤器。 documented SimpleListFilter 没有这样的问题。请参阅this answer 了解如何操作。
    • 感谢 yofee 指出这一点 - 我认为这是因为 field 和 field.rel 对象将在请求之间持续存在,因此这可能会影响管理员以外的地方。我考虑制作这两个对象的副本,以便我们可以在这个地方更改它们,但它似乎效果不佳。正如yofee所说,不要使用这种方法!
    【解决方案3】:

    我发现了另一种类似于@seddonym 的方法,但不会影响缓存。它基于this Django code,但使用未记录的方法field_choices,在未来的Django 版本中可能会发生变化。 @seddonym 案例的代码是:

    from django.contrib.admin.filters import RelatedFieldListFilter
    
    class SpeciesFilter(RelatedFieldListFilter):
        def field_choices(self, field, request, model_admin):
            return field.get_choices(include_blank=False, limit_choices_to={'name': 'Tarantula'})
    

    或者在我的情况下,工作代码是:

    from django.contrib.admin.filters import RelatedFieldListFilter
    
    class UnitFilter(RelatedFieldListFilter):
        def field_choices(self, field, request, model_admin):
            return field.get_choices(include_blank=False, limit_choices_to={'pk__in': request.user.administrated_units.all()})
    
    

    【讨论】:

      【解决方案4】:

      我必须从 db 表中创建查找字段。我创建了如下自定义过滤器类,并仅显示登录用户的相关值并进行相应过滤:

      class ShiftFilter_Org(admin.SimpleListFilter):
      title = 'Organisation'
      parameter_name = 'org'
      
      def lookups(self, request, model_admin):
      """Get the organisations you want to limit"""
          qs_org = Organisation.objects.filter(users=request.user)
          list_org = []
          for og in qs_org:
              list_org.append(
                  (og.id, og.name)
              )
          return (
              sorted(list_org, key=lambda tp:tp[1])
          )
      
      def queryset(self, request, queryset):
          if self.value():
              return queryset.filter(org=self.value())
      

      更多信息请访问Getting the most out of Django Admin filters

      【讨论】:

        猜你喜欢
        • 2017-02-12
        • 2013-05-01
        • 2014-07-17
        • 1970-01-01
        • 2021-09-02
        • 1970-01-01
        • 2022-01-05
        • 2014-07-07
        • 2020-05-21
        相关资源
        最近更新 更多