如何在django_filters字段中设置自定义错误提示信息？

有几种方式可以实现将无效日期范围的默认错误消息"Enter a valid date"替换为自定义的"No records found"，以下是具体方案：

方案一：自定义Filter类（精准针对单个过滤字段） #

继承DateFromToRangeFilter并重写filter方法，捕获验证异常后抛出自定义错误：

import django_filters
from django.core.exceptions import ValidationError
from src.core.models.rough_management import DocumentDetails

class CustomDateRangeFilter(django_filters.DateFromToRangeFilter):
    def filter(self, qs, value):
        try:
            # 调用父类逻辑执行验证和过滤
            return super().filter(qs, value)
        except ValidationError:
            # 替换为自定义错误消息
            raise ValidationError("No records found")

class DocumentDetailsFilter(django_filters.FilterSet):
    my_date = CustomDateRangeFilter()

    class Meta:
        model = DocumentDetails
        fields = ['my_date']

方案二：在FilterSet中重写clean方法（针对整个过滤集） #

通过重写FilterSet的clean方法，直接修改错误消息：

import django_filters
from src.core.models.rough_management import DocumentDetails

class DocumentDetailsFilter(django_filters.FilterSet):
    my_date = django_filters.DateFromToRangeFilter()

    class Meta:
        model = DocumentDetails
        fields = ['my_date']

    def clean(self):
        cleaned_data = super().clean()
        # 检查my_date字段是否存在验证错误
        if 'my_date' in self.errors:
            # 替换错误消息内容
            self.errors['my_date'] = ["No records found"]
        return cleaned_data

方案三：全局DRF异常处理（影响所有验证错误） #

如果希望全局统一处理这类日期验证错误，可以自定义DRF的异常处理器：

1. 在项目settings.py中配置自定义异常处理器：

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'your_project_name.utils.custom_exception_handler',
}

2. 在utils.py中实现处理器逻辑：

from rest_framework.views import exception_handler
from django.core.exceptions import ValidationError

def custom_exception_handler(exc, context):
    response = exception_handler(exc, context)
    
    # 仅处理日期验证相关的ValidationError
    if response and isinstance(exc, ValidationError):
        if any("Enter a valid date" in msg for msg in exc.messages):
            response.data = {"detail": "No records found"}
    
    return response

注意事项 #

• 方案一和二仅针对当前Filter/FilterSet生效，不会影响其他接口；方案三是全局生效，需谨慎使用。
• 虽然业务本质是日期格式错误，但以上方案均可按需求返回指定的自定义消息。

内容的提问来源于stack exchange，提问作者Abbas Shaikh