Django Taggit视图报错FieldError: Related Field got invalid lookup: name

问题说明 #

在实现按标签筛选问题的视图时，触发了如下错误：

FieldError: Related Field got invalid lookup: name

该错误表示Django ORM无法识别对tags关联字段使用的name查找条件。

错误栈信息 #

[...]
 File "/workspace/Coach-Matrix/main_forum/views/filters.py", line 18, in get_queryset
    return Question.objects.filter(tags__name=tag.name)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/manager.py", line 85, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/query.py", line 1420, in filter
    return self._filter_or_exclude(False, args, kwargs)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/query.py", line 1438, in _filter_or_exclude
    clone._filter_or_exclude_inplace(negate, args, kwargs)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/sql/query.py", line 1445, in _filter_or_exclude_inplace
    self._query.add_q(Q(*args, **kwargs))
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/sql/query.py", line 1532, in add_q
    clause, _ = self._add_q(q_object, self.used_aliases)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/sql/query.py", line 1562, in _add_q
    child_clause, needed_inner = self.build_filter(
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/sql/query.py", line 1478, in build_filter
    condition = self.build_lookup(lookups, col, value)
  File "/workspace/.pip-modules/lib/python3.9/site-packages/django/db/models/sql/query.py", line 1292, in build_lookup
    raise FieldError(

Exception Type: FieldError at /questions/tag/tag4/
Exception Value: Related Field got invalid lookup: name

当前使用的视图代码 #

from django.views.generic.list import ListView
from ..models import Question
from django.shortcuts import get_object_or_404
from taggit.models import Tag

class FilterByTagView(ListView):
    model = Question
    template_name = 'filtered_questions.html'
    context_object_name = 'questions'

    def get_queryset(self):
        tag_slug = self.kwargs.get('tag_slug')
        # 通过slug获取Tag对象
        tag = get_object_or_404(Tag, slug=tag_slug)
        # 尝试用标签slug筛选问题
        return Question.objects.filter(tags__slug=tag.slug)

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        tag_slug = self.kwargs.get('tag_slug')
        context['tag'] = get_object_or_404(Tag, slug=tag_slug)
        return context

解决方法 #

问题根源 #

Django Taggit的tags字段不是直接的外键关联，而是通过TaggedItem中间表管理多对多关系，直接使用tags__name或tags__slug这种链式查找会导致ORM无法解析对应的字段。

两种可行的修复方案 #

方案一：直接通过Tag实例筛选

既然已经获取了Tag对象，直接将其作为过滤条件传入即可，Taggit会自动处理中间表的关联逻辑：

def get_queryset(self):
    tag_slug = self.kwargs.get('tag_slug')
    tag = get_object_or_404(Tag, slug=tag_slug)
    return Question.objects.filter(tags=tag)

方案二：使用Taggit的get_by_model方法（更高效）

利用Taggit提供的TaggedItemManager工具方法，无需先查询Tag实例，直接通过slug获取关联的Question对象：

from taggit.models import TaggedItem

def get_queryset(self):
    tag_slug = self.kwargs.get('tag_slug')
    return TaggedItem.objects.get_by_model(Question, tag_slug)

优化后的完整视图代码 #

from django.views.generic.list import ListView
from ..models import Question
from django.shortcuts import get_object_or_404
from taggit.models import Tag, TaggedItem

class FilterByTagView(ListView):
    model = Question
    template_name = 'filtered_questions.html'
    context_object_name = 'questions'

    def get_queryset(self):
        tag_slug = self.kwargs.get('tag_slug')
        # 选择下面其中一种方案即可
        # 方案一
        tag = get_object_or_404(Tag, slug=tag_slug)
        return Question.objects.filter(tags=tag)
        
        # 方案二
        # return TaggedItem.objects.get_by_model(Question, tag_slug)

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        tag_slug = self.kwargs.get('tag_slug')
        context['tag'] = get_object_or_404(Tag, slug=tag_slug)
        return context

内容的提问来源于stack exchange，提问作者Laurie Crean