FreezeGun，一个实用的python库

大家好，我是木木。今天给大家分享一个超酷的 Python 库，FreezeGun。

这个库是用于在Python测试中“冻结”时间，让你能够模拟特定的时间和日期。可以在测试中准确地控制时间相关的逻辑，确保时间的变化不会影响到测试结果。

核心特点

时间控制

FreezeGun 允许在测试中设置任何特定的日期和时间，确保时间相关的代码表现如预期。在测试定时任务、过期功能等场景中极其有用。

简单易用

导入 FreezeGun 后，只需几行代码即可“冻结”时间。API设计简洁，易于理解，在任何测试场景下都能快速上手。

广泛兼容

无论是与标准库中的 datetime 模块还是第三方时间库（如 pytz）一起使用，FreezeGun 都能够很好地兼容。这让它成为了多种项目中的首选测试工具。

最佳实践

安装方法:

可以通过pip轻松安装FreezeGun:

pip install freezegun

基础使用示例:

功能一：固定测试时间

这个示例展示了如何在一个简单的函数测试中使用 FreezeGun 来固定时间。这对于测试那些依赖于当前时间的功能特别有用。

from freezegun import freeze_time
import datetime

# 使用 pytest 风格的测试固定时间
@freeze_time("2012-01-14")
def test_pytest_style():
    print(datetime.datetime.now())
    assert datetime.datetime.now() == datetime.datetime(2012, 1, 14)

# 执行测试
test_pytest_style()

函数内部调用 datetime.datetime.now() 会返回2012年1月14日的日期，而不是当前实际的日期和时间。

单元测试中使用

功能二：单元测试中固定时间

FreezeGun 也可以在使用 unittest 框架的单元测试中广泛应用，既可以装饰整个测试类，也可以装饰类内的单个测试方法。

from freezegun import freeze_time
import datetime
import unittest

# 使用 unittest.TestCase - 在每个测试中固定时间
@freeze_time("1955-11-12")
class MyTests(unittest.TestCase):
    def test_the_class(self):
        assert datetime.datetime.now() == datetime.datetime(1955, 11, 12)

# 单独的测试方法装饰器示例
class TestMethodDecorator(unittest.TestCase):
    @freeze_time('2013-04-09')
    def test_method_decorator(self):
        self.assertEqual(datetime.date(2013, 4, 9), datetime.date.today())

if __name__ == '__main__':
    unittest.main()

在 MyTests 类中，我们使用了 @freeze_time 装饰器来固定所有测试方法执行时的时间。

高级功能示例:

模拟时间流逝的高级应用

利用 FreezeGun 模拟特定时间段内的时间流逝，以测试时间敏感的功能。示例代码：

from freezegun import freeze_time  
import datetime  

# 定义一个测试函数来测试手动时间的流逝
def test_manual_tick():
    # 设置一个初始的时间点
    initial_datetime = datetime.datetime(year=1, month=7, day=12,
                                        hour=15, minute=6, second=3)
    # 使用freezegun的freeze_time上下文管理器冻结时间
    with freeze_time(initial_datetime) as frozen_datetime:
        
        assert frozen_datetime() == initial_datetime

        # 手动“滴答”时间，使其前进1秒
        frozen_datetime.tick()
        # 更新初始时间以反映时间的流逝
        initial_datetime += datetime.timedelta(seconds=1)
        # 再次断言冻结的时间与更新后的初始时间相同
        assert frozen_datetime() == initial_datetime

        # 手动“滴答”时间，使其前进10秒
        frozen_datetime.tick(delta=datetime.timedelta(seconds=10))
        # 更新初始时间以反映时间的流逝
        initial_datetime += datetime.timedelta(seconds=10)
        # 再次断言冻结的时间与更新后的初始时间相同
        assert frozen_datetime() == initial_datetime

# 定义另一个测试函数来测试monotonic时间的手动“滴答”
def test_monotonic_manual_tick():
    # 设置一个初始的时间点
    initial_datetime = datetime.datetime(year=1, month=7, day=12,
                                        hour=15, minute=6, second=3)
    # 使用freezegun的freeze_time上下文管理器冻结时间
    with freeze_time(initial_datetime) as frozen_datetime:
        # 获取monotonic时间，这是一个单调递增的时间，通常用于计算时间间隔
        monotonic_t0 = time.monotonic()
        # 手动“滴答”时间，使其前进1秒
        frozen_datetime.tick(1.0)
        # 再次获取monotonic时间
        monotonic_t1 = time.monotonic()
        # 断言经过1秒后的monotonic时间与之前的时间相差1秒
        assert monotonic_t1 == monotonic_t0 + 1.0