python - django-filter 乱用空字段
问题描述
我设置了django-filter来过滤我的一些列表。这是其中之一,带有自定义表单:
class BookingListFiltersForm(forms.Form):
state__in = forms.MultipleChoiceField(
choices=Booking.STATE_CHOICES, required=False,
label=_("État"), widget=forms.CheckboxSelectMultiple)
source__in = forms.ModelMultipleChoiceField(
queryset=Platform.objects.all(), required=False,
label=_("Source"), widget=ModelSelect2Multiple(
url='autocomplete:platform'))
class BookingManagerFilter(filters.FilterSet):
payments__date = filters.DateFilter(method='payments__date_filter')
payments__method = filters.ChoiceFilter(
method='payments__method_filter',
choices=BookingPayment.METHOD_CHOICES,
)
class Meta:
model = Booking
fields = {
'period': [
'endswith', 'endswith__gte', 'endswith__lte',
'startswith', 'startswith__gte', 'startswith__lte',
],
'state': ['in'],
'source': ['in'],
'booking_date': ['date', 'date__lte', 'date__gte'],
'accommodation': ['in'],
'guest': ['exact']
}
def get_form_class(self):
return BookingListFiltersForm
def payments__date_filter(self, queryset, name, value):
return queryset.filter(**{name: value})
def payments__method_filter(self, queryset, name, value):
return queryset.filter(**{name: value})
表单是通过 GET 方法提交的。当“source__in”字段为空时,查询字符串看起来像这样“?state__in=1”。在这种情况下,我的页面中没有结果(这是出乎意料的,如果未填写某个字段,我希望结果不会在该字段上过滤)。
我查看了调试工具栏以获取有关已执行 SQL 查询的更多信息。令人惊讶的是,我没有找到相关查询集的 SQL 查询!(例如,如果查询字符串为“?state__in=1&source__in=2”,结果符合预期,我可以在调试工具栏中找到相关查询)
所以我尝试使用print(str(filters.qs.query))
. 新的惊喜,这引发了一个EmptyResultSet
异常:
Traceback:
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/core/handlers/exception.py" in inner
35. response = get_response(request)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/core/handlers/base.py" in _get_response
128. response = self.process_exception_by_middleware(e, request)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/core/handlers/base.py" in _get_response
126. response = wrapped_callback(request, *callback_args, **callback_kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/views/generic/base.py" in view
69. return self.dispatch(request, *args, **kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/utils/decorators.py" in _wrapper
62. return bound_func(*args, **kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/contrib/auth/decorators.py" in _wrapped_view
21. return view_func(request, *args, **kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/utils/decorators.py" in bound_func
58. return func.__get__(self, type(self))(*args2, **kwargs2)
File "/home/tony/Workspace/cocoonr/utils/views/manager.py" in dispatch
29. return super().dispatch(*args, **kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/views/generic/base.py" in dispatch
89. return handler(request, *args, **kwargs)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/views/generic/list.py" in get
142. self.object_list = self.get_queryset()
File "/home/tony/Workspace/cocoonr/booking/views/manager.py" in get_queryset
73. queryset = super().get_queryset()
File "/home/tony/Workspace/cocoonr/utils/views/common.py" in get_queryset
118. print(self.filters.qs.query)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/db/models/sql/query.py" in __str__
252. sql, params = self.sql_with_params()
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/db/models/sql/query.py" in sql_with_params
260. return self.get_compiler(DEFAULT_DB_ALIAS).as_sql()
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/db/models/sql/compiler.py" in as_sql
461. where, w_params = self.compile(self.where) if self.where is not None else ("", [])
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/db/models/sql/compiler.py" in compile
393. sql, params = node.as_sql(self, self.connection)
File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/db/models/sql/where.py" in as_sql
98. raise EmptyResultSet
Exception Type: EmptyResultSet at /manager/booking/bookings/
Exception Value:
现在我被卡住了,我不知道出了什么问题以及如何进一步调试。
为了测试,我尝试传递以下查询字符串:“?state__in=1&source__in=”。在这种情况下,过滤工作正常,但过滤表单显示错误“« »不是有效值”字段“source__in”。
此外,这里是相关的 mixin utils/views/common.py
:
class ListFilterMixin:
filters_class = None
default_filters = None
@cached_property
def filters(self):
return self.get_filters()
def get_filters(self):
if self.filters_class:
qstring = self.request.GET
if not qstring and self.default_filters:
qstring = QueryDict(self.default_filters)
return self.filters_class(
qstring, self.get_unfiltered_queryset(), request=self.request)
else:
return None
def get_queryset(self):
print(self.filters.qs.query) # <--- Line 118
# ...
def get_unfiltered_queryset(self):
return super().get_queryset()
和视图类booking/views/manager.py
:
class BookingListView(ListView):
"""List of all bookings."""
model = Booking
default_filters = 'state__in=1'
filters_class = BookingManagerFilter
paginate_by = 30
ordering = '-pk'
def get_queryset(self):
queryset = super().get_queryset() # <--- Line 73
# ...
此外,因此您拥有完整的继承树,请注意ListView
上面使用的是utils.views.manager.ListView
:
class ListView(BulkActionsMixin, ManagerMixin, BaseListView):
pass
并且BaseListView
是utils.views.common.ListView
:
class ListView(ListFilterMixin, AgencyMixin, ContextMixin, BaseListView):
pass
最后一个BaseListView
是django.views.generic.list.ListView
。
按照 Kamil 的建议使用ipdb
调试,我注意到一个奇怪的事情,这可能是导致这种行为的原因:
ipdb> next
> /home.tony/.venvs/cocoonr/lib/python3.6/site-packages/django_filters/filters.py(167)filter()
166 def filter(self, qs, value):
--> 167 if value != self.null_value:
168 return super().filter(qs, value)
ipdb> self.null_value
'null'
ipdb> value
<QuerySet []>
ipdb> self.field_name
'source'
ipdb> self.lookup_expr
'in'
ipdb>
因此,后续代码认为source__in
不为空并添加source__in=empty_queryset
到过滤器中。我猜 django 然后猜测结果无法评估为非空查询集并保存无用的查询。
这是一个错误django-filters
还是我做错了什么?
解决方案
我认为文档回答了您的问题:
目前无法通过空字符串进行过滤,因为空值被解释为跳过的过滤器。
GET http://localhost/api/my-model?myfield=
在文档中,您还有可能解决方案的示例。我把其中一个放在这里
解决方案 1:魔法值
您可以覆盖过滤器类的 filter() 方法来专门检查魔术值。这类似于 ChoiceFilter 的空值处理。
GET http://localhost/api/my-model?myfield=EMPTY
class MyCharFilter(filters.CharFilter): empty_value = 'EMPTY' def filter(self, qs, value): if value != self.empty_value: return super(MyCharFilter, self).filter(qs, value) qs = self.get_method(qs)(**{'%s__%s' % (self.name, self.lookup_expr): ""}) return qs.distinct() if self.distinct else qs
现在我觉得没有足够的信息来解决你的问题。我在你的问题下留下了评论。如果您可以提供额外的信息,它将极大地帮助您了解正在发生的事情。
这里有一些提示可以帮助您跟踪此错误:
- 安装ipdb。它将帮助您逐步执行代码并检查每个变量。
import ipdb;ipdb.set_trace()
在行前删除断点File "/home/tony/.venvs/cocoonr/lib/python3.6/site-packages/django/views/generic/list.py" in get 142. self.object_list = self.get_queryset()
你可以做这样的事情
class BookingManagerFilter(filters.FilterSet):
# your previous code here
def filter_queryset(self, queryset):
import ipdb;ipdb.set_trace()
return super(BookingManagerFilter, self)filter_queryset(queryset):
并运行您的端点,ipdb 将停止应用程序,您将能够进入代码并检查它。
推荐阅读
- powershell - 使用变量 -Path 参数运行 Powershell 命令
- node.js - AWS 中有没有办法隐藏我的 nodejs 代码,同时向我的客户公开访问和存储相关的计费信息
- java - 当reduce将数据写入hdfs时发生了什么?
- autodesk-forge - 存储在 BIM360 Docs 中的 Revit 模型的模型衍生翻译
- sql - 在 CASE WHEN 期间搜索字符串
- python - 由第三个变量着色用 plotly.express 混淆了日期轴的顺序
- javascript - js 导出的变量不会更新,除非再次保存导入它的文件
- node.js - 当我在 node.js cli 中重新执行脚本时,firebase.auth().currentUser 返回 null
- swift - 为什么需要 typealias 以符合协议
- java - Tapestry Page 翻到下一页:点击下一页(如果下一页的表格内容是可编辑的,tapestry 会报错)