跳到主要内容

Clock

准确模拟时间相关的行为对于验证应用程序的正确性至关重要。了解更多关于时钟模拟的信息。

请注意，时钟是为整个浏览器上下文（BrowserContext）安装的，因此所有页面和 iframe 中的时间都由同一个时钟控制。

方法​

fast_forward​

新增于：v1.45 clock.fast_forward

通过向前跳跃时间来推进时钟。最多只触发一次到期的计时器。这相当于用户合上笔记本电脑一段时间后，在给定时间后重新打开。

用法

page.clock.fast_forward(1000)
page.clock.fast_forward("30:00")

参数

  • ticks int | str#

    时间可以是向前推进的毫秒数，也可以是人类可读的字符串。有效的字符串格式包括表示八秒的 "08"，表示一分钟的 "01:00"，以及表示两小时 34 分钟 10 秒的 "02:34:10"。

返回值

install​

新增于：v1.45 clock.install

为以下时间相关函数安装伪实现

  • Date
  • setTimeout
  • clearTimeout
  • setInterval
  • clearInterval
  • requestAnimationFrame
  • cancelAnimationFrame
  • requestIdleCallback
  • cancelIdleCallback
  • performance

伪计时器用于在测试中手动控制时间流。它们允许您推进时间、触发计时器并控制时间相关函数的行为。更多信息请参阅 clock.run_for() 和 clock.fast_forward()。

用法

clock.install()
clock.install(**kwargs)

参数

  • time float | str | datetime (可选)#

    初始化时间，默认为当前系统时间。

返回值

pause_at​

新增于：v1.45 clock.pause_at

通过向前跳跃时间来推进时钟并暂停时间。此方法被调用后，除非调用 clock.run_for()、clock.fast_forward()、clock.pause_at() 或 clock.resume()，否则不会触发任何计时器。

最多只触发一次到期的计时器。这相当于用户合上笔记本电脑一段时间后，在指定时间重新打开并暂停。

用法

page.clock.pause_at(datetime.datetime(2020, 2, 2))
page.clock.pause_at("2020-02-02")

为获得最佳结果，请在导航页面之前安装时钟，并将其设置为略早于预期测试时间的时间。这可确保所有计时器在页面加载期间正常运行，防止页面卡住。页面完全加载后，您可以安全地使用 clock.pause_at() 暂停时钟。

# Initialize clock with some time before the test time and let the page load
# naturally. `Date.now` will progress as the timers fire.
page.clock.install(time=datetime.datetime(2024, 12, 10, 8, 0, 0))
page.goto("http://localhost:3333")
page.clock.pause_at(datetime.datetime(2024, 12, 10, 10, 0, 0))

参数

返回值

resume​

新增于：v1.45 clock.resume

恢复计时器。此方法被调用后，时间恢复流动，计时器照常触发。

用法

clock.resume()

返回值

run_for​

新增于：v1.45 clock.run_for

推进时钟，触发所有时间相关的回调。

用法

page.clock.run_for(1000);
page.clock.run_for("30:00")

参数

  • ticks int | str#

    时间可以是向前推进的毫秒数，也可以是人类可读的字符串。有效的字符串格式包括表示八秒的 "08"，表示一分钟的 "01:00"，以及表示两小时 34 分钟 10 秒的 "02:34:10"。

返回值

set_fixed_time​

新增于：v1.45 clock.set_fixed_time

使 Date.now 和 new Date() 始终返回固定的伪时间，并保持所有计时器运行。

此方法适用于只需要在预定义时间进行测试的简单场景。对于更高级的场景，请改用 clock.install()。阅读 时钟模拟 文档以了解更多信息。

用法

page.clock.set_fixed_time(datetime.datetime.now())
page.clock.set_fixed_time(datetime.datetime(2020, 2, 2))
page.clock.set_fixed_time("2020-02-02")

参数

返回值

set_system_time​

新增于：v1.45 clock.set_system_time

设置系统时间，但不触发任何计时器。使用此方法测试网页对时间偏移（例如，从夏季切换到冬季或更改时区）的反应。

用法

page.clock.set_system_time(datetime.datetime.now())
page.clock.set_system_time(datetime.datetime(2020, 2, 2))
page.clock.set_system_time("2020-02-02")

参数

返回值