如何在 Django 1.5.5 测试中模拟 datetime.date.today() 方法

Question

我有一组测试依赖于使用 python 模拟库和 @mock.patch 装饰器模拟日期，以及找到的日期模拟代码示例 here。使用它，我们有一个 FakeDate 类：

class FakeDate(original_date):
    "A fake replacement for datetime.date that can be mocked for testing."
    def __new__(cls, *args, **kwargs):
        return original_date.__new__(original_date, *args, **kwargs)

在我们的测试中，我们有：

from datetime import date as real_date

@mock.patch('datetime.date', FakeDate)
def test_mondays_since_date(self):

    FakeDate.today = classmethod(lambda cls: real_date(2014, 1, 1))  # A Wednesday
    self.assertNotEqual(datetime.date.today(), real_date.today())
    self.assertEqual(datetime.date.today().year, 2014)
    # and so on..

在我将 Django 从 1.4.8 升级到 1.5.5 之前，一切正常。不幸的是，现在模拟日期导致测试失败，但仅限于模型保存操作。堆栈跟踪如下：

File "/site-packages/django/db/models/base.py", line 546, in save
  force_update=force_update, update_fields=update_fields)
File "/site-packages/django/db/models/base.py", line 650, in save_base
  result = manager._insert([self], fields=fields, return_id=update_pk, using=using, raw=raw)
File "/site-packages/django/db/models/manager.py", line 215, in _insert
  return insert_query(self.model, objs, fields, **kwargs)
File "/site-packages/django/db/models/query.py", line 1675, in insert_query
  return query.get_compiler(using=using).execute_sql(return_id)
File "/site-packages/django/db/models/sql/compiler.py", line 942, in execute_sql
  for sql, params in self.as_sql():
File "/site-packages/django/db/models/sql/compiler.py", line 900, in as_sql
  for obj in self.query.objs
File "/site-packages/django/db/models/fields/__init__.py", line 304, in get_db_prep_save
  prepared=False)
File "/site-packages/django/db/models/fields/__init__.py", line 738, in get_db_prep_value
  value = self.get_prep_value(value)
File "/site-packages/django/db/models/fields/__init__.py", line 733, in get_prep_value
  return self.to_python(value)
File "/site-packages/django/db/models/fields/__init__.py", line 697, in to_python
  parsed = parse_date(value)
File "/site-packages/django/utils/dateparse.py", line 36, in parse_date
  match = date_re.match(value)
TypeError: expected string or buffer

我已经 pdb 进入了 Django 源代码，问题似乎就在这里（django/db/models/fields/init.py:

def to_python(self, value):
    if value is None:
        return value
    if isinstance(value, datetime.datetime):
        if settings.USE_TZ and timezone.is_aware(value):
            # Convert aware datetimes to the default time zone
            # before casting them to dates (#17742).
            default_timezone = timezone.get_default_timezone()
            value = timezone.make_naive(value, default_timezone)
        return value.date()
    if isinstance(value, datetime.date):  # <-- This is the problem!
        return value

    try:
        parsed = parse_date(value)

类型相等表达式失败，因此调用parse_date 实际上引发了错误。 （即value，这是从我的FakeDate.today() 表达式返回的日期，不被视为标准库datetime.date 对象。）

所以，我知道问题出在哪里，但我能做些什么来解决它？模拟日期对我们的应用程序测试至关重要。

[编辑 1：Django 早期版本的比较]

比较上面的表达式在 Django 1.5.5 中失败了，下面是 1.4.8（没有失败）：

def to_python(self, value):
    if value is None:
        return value
    if isinstance(value, datetime.datetime):
        return value.date()
    if isinstance(value, datetime.date):
        return value

    value = smart_str(value)

    try:
        parsed = parse_date(value)

即他们是一样的。那么为什么一个通过而另一个失败 - 这与测试运行器的变化有关吗？

[编辑 2：更多调试]

进一步挖掘差异：

> /site-packages/django/db/models/fields/__init__.py(685)to_python()
    684         import ipdb; ipdb.set_trace()
--> 685         if value is None:
    686             return value
ipdb> value
datetime.date(2012, 12, 7)
ipdb> isinstance(value, datetime.date)
False
ipdb> type(value)
<type 'datetime.date'>
ipdb> type(datetime.date)
<type 'type'>
ipdb> datetime.date
<class 'testutils.FakeDate'>
ipdb> datetime.datetime
<type 'datetime.datetime'>

[编辑 3：找到问题]

我发现了 1.4 和 1.5 分支之间的差异，它不在测试运行程序中。关键是 1.4 分支中的 value = smart_str(value) 行。这在parse_date 之前调用，它将我们的 FakeDate 转换为可解析的字符串 repr（例如 '2012-05-09'）。这是不在 1.5 版本中调用的，它会爆炸。

这是 1.4.x 分支中的序列：

# value = FakeDate(2012, 12, 31)
# code fails the isinstance(datetime.date) test
value = smart_str(value)
# value is now a string '2012-12-31'
parsed = parse_date(value)
# inside parse_date we try a regex match
match = date_re.match(value)
# because we have called smart_str, this now parses as a date

1.5.x 分支中的序列不包括 smart_str 转换，因此正则表达式匹配失败，因为在这种情况下 value 参数是 FakeDate 对象而不是字符串。

[编辑 5：提交给 Django 的错误]

为此，我已向 Django 问题跟踪器 (https://code.djangoproject.com/ticket/21523) 提交了一个错误。

Answer 1

我对此的调查是作为一组编辑的问题，但总而言之，to_python 方法在 1.4 和 1.5 之间的更改意味着任何既不是有效的 datetime.date 也不是 datetime.datetime必须是字符串才能通过。

看起来（没有太多深入挖掘）django.utils.encoding.smart_str 方法似乎在 1.5 中被删除，虽然它已被 smart_text 取代，但这从未进入 to_python 方法。

我在 django Trac 实例中提出了一张票，https://code.djangoproject.com/ticket/21523

我还为这个问题创建了一个补丁 - 但显然这可能永远无法进入（而且这个补丁适用于 1.5.x，它已经过时了，所以我真的不会指望这个它在）。

[编辑 1：解决方案！]

有一个解决方案 ;-) - 我在这里写了一篇文章 - http://tech.yunojuno.com/mocking-dates-with-django - 关键是覆盖 FakeDate instancecheck 方法，以便在将真实的 datetime.date 与FakeDate 你得到 True。我整理了一些示例 FakeDate 类和相关测试以供参考 - https://gist.github.com/hugorodgerbrown/7750432