解决 Django 日期时间格式在表单中失效的问题

2024-03-06 03:03:24

Django 自定义日期时间格式在表单字段中失效

问题陈述

在 Django 项目中，我们希望为本地使用添加自定义日期格式。我们按照文档更新了设置，以便使用本地日期时间格式，但表单字段仍然使用默认格式，并且没有采用我们添加的格式。

调查与调试

我们在表单中使用 DateTimeInput 小组件，它引用了 DATETIME_INPUT_FORMATS 设置。然而，在表单字段验证过程中，该设置完全被忽略了。

import pdb; pdb.set_trace()

通过调试，我们发现 self.input_formats 中缺少了自定义的日期时间格式。

解决方案

问题出在 Django 表单验证框架中对格式解析的实现。当我们自定义 input_formats 时，Django 使用一个内部函数 _parse_formats 来解析格式字符串。此函数将格式字符串拆分成各个部分，例如年、月、日和时间。

然而，_parse_formats 仅适用于 ISO 8601 格式的字符串。因此，它不能正确解析我们的自定义格式。

要解决此问题，我们需要修改 Django 源代码以支持自定义格式。具体来说，我们需要修改 django.forms.fields 中的 _parse_formats 函数。

修改 Django 源代码

以下是修改后的 _parse_formats 函数代码：

def _parse_formats(format):
    RE_FORMAT = re.compile(r'(%s|%s|%s|%s)')

    if not format:
        raise ImproperlyConfigured(
            'You must specify a datetime input format for %s.' % type(self).__name__)

    # Retain the passed format for to_python
    self.input_formats.append(format)

    # Split the format into individual parts
    formats = RE_FORMAT.split(format)

    # Extract the datetime format parts
    datetime_format = (
        formats[1:3] if len(formats) > 2 else [None, None],  # date
        formats[3:] if len(formats) > 3 else [None],  # time
    )

    return datetime_format