メインコンテンツへスキップ

Clock

時間依存の動作を正確にシミュレートすることは、アプリケーションの正確性を検証するために不可欠です。詳細については、クロックエミュレーションをご覧ください。

クロックは BrowserContext 全体に対してインストールされるため、すべてのページと iframe の時間は同じクロックによって制御されることに注意してください。

メソッド​

fast_forward​

v1.45 で追加 clock.fast_forward

時間を早送りしてクロックを進めます。期限切れのタイマーを最大で一度だけ発火させます。これは、ユーザーがしばらくラップトップの蓋を閉じて、指定された時間の後で再び開くのと同等です。

使用例

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

引数

  • ticks int | str#

    時間は、クロックを進めるミリ秒数、または人間が読める文字列で指定できます。有効な文字列形式は、8 秒の場合は "08"、1 分の場合は "01:00"、2 時間 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#

    時間は、クロックを進めるミリ秒数、または人間が読める文字列で指定できます。有効な文字列形式は、8 秒の場合は "08"、1 分の場合は "01:00"、2 時間 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

システム時間を設定しますが、タイマーはトリガーしません。これを使用して、Web ページがタイムシフトにどのように反応するかをテストします。たとえば、夏時間から冬時間への切り替えや、タイムゾーンの変更などです。

使用例

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")

引数

戻り値