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

Tracing

Playwrightトレースを収集して保存するためのAPI。Playwrightスクリプトの実行後、Playwrightトレースはトレースビューアーで開くことができます。

注

おそらくcontext.tracingを使用する代わりに、設定ファイルでトレースを有効にすることをお勧めします。

context.tracing APIはブラウザの操作とネットワークアクティビティをキャプチャしますが、テストアサーション（expect呼び出しなど）は記録しません。Playwright Testの設定を通じてトレースを有効にすることをお勧めします。これにより、これらのアサーションが含まれ、テストの失敗をデバッグするためのより完全なトレースが提供されます。

アクションを実行する前にトレースの記録を開始します。最後に、トレースを停止してファイルに保存します。

browser = chromium.launch()
context = browser.new_context()
context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dokyumento.jp")
context.tracing.stop(path = "trace.zip")

メソッド​

group​

追加バージョン: v1.49 tracing.group
注意

利用可能な場合は代わりにtest.stepを使用してください。

tracing.group_end()が呼び出されるまで、その後のAPI呼び出しをこのグループに割り当て、トレース内に新しいグループを作成します。グループはネスト可能で、トレースビューアーに表示されます。

使用法

# All actions between group and group_end
# will be shown in the trace viewer as a group.
page.context.tracing.group("Open Playwright.dev > API")
page.goto("https://playwright.dokyumento.jp/")
page.get_by_role("link", name="API").click()
page.context.tracing.group_end()

引数

  • name str#

    トレースビューアに表示されるグループ名。

  • location Dict (オプション)#

    • file str

    • line int (オプション)

    • column int (オプション)

    トレースビューアーに表示されるグループのカスタムの場所を指定します。tracing.group()が呼び出された場所がデフォルトとなります。

戻り値

group_end​

追加バージョン: v1.49 tracing.group_end

tracing.group()によって作成された最後のグループを閉じます。

使用法

tracing.group_end()

戻り値

start​

追加日: v1.12 tracing.start

トレースを開始します。

注

Tracing.startを使用する代わりに、設定ファイルでトレースを有効にすることをお勧めします。

context.tracing APIはブラウザの操作とネットワークアクティビティをキャプチャしますが、テストアサーション（expect呼び出しなど）は記録しません。Playwright Testの設定を通じてトレースを有効にすることをお勧めします。これにより、これらのアサーションが含まれ、テストの失敗をデバッグするためのより完全なトレースが提供されます。

使用法

context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dokyumento.jp")
context.tracing.stop(path = "trace.zip")

引数

  • name str (オプション)#

    指定された場合、中間トレースファイルは、browser_type.launch()で指定されたtraces_dirディレクトリ内の、指定された名前プレフィックスを持つファイルに保存されます。最終的なトレースzipファイル名を指定するには、代わりにtracing.stop()にpathオプションを渡す必要があります。

  • screenshots bool (オプション)#

    トレース中にスクリーンショットをキャプチャするかどうか。スクリーンショットはタイムラインプレビューの作成に使用されます。

  • snapshots bool (オプション)#

    このオプションがtrueの場合、トレースは以下を行います。

    • すべてのアクションでDOMスナップショットをキャプチャ
    • ネットワークアクティビティを記録

  • sources bool (オプション)追加バージョン: v1.17#

    トレースアクションのソースファイルを含めるかどうか。

  • title str (オプション)追加バージョン: v1.17#

    トレースビューアに表示されるトレース名。

戻り値

start_chunk​

追加されたバージョン: v1.15 tracing.start_chunk

新しいトレースチャンクを開始します。同じBrowserContext上で複数のトレースを記録したい場合は、tracing.start()を一度使用し、その後tracing.start_chunk()とtracing.stop_chunk()で複数のトレースチャンクを作成します。

使用法

context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dokyumento.jp")

context.tracing.start_chunk()
page.get_by_text("Get Started").click()
# Everything between start_chunk and stop_chunk will be recorded in the trace.
context.tracing.stop_chunk(path = "trace1.zip")

context.tracing.start_chunk()
page.goto("http://example.com")
# Save a second trace file with different actions.
context.tracing.stop_chunk(path = "trace2.zip")

引数

  • name str (オプション)追加日: v1.32#

    指定された場合、中間トレースファイルは、browser_type.launch()で指定されたtraces_dirディレクトリ内の、指定された名前プレフィックスを持つファイルに保存されます。最終的なトレースzipファイル名を指定するには、代わりにtracing.stop_chunk()にpathオプションを渡す必要があります。

  • title str (オプション)追加バージョン: v1.17#

    トレースビューアに表示されるトレース名。

戻り値

stop​

追加日: v1.12 tracing.stop

トレースを停止します。

使用法

tracing.stop()
tracing.stop(**kwargs)

引数

  • path Union[str, pathlib.Path] (オプション)#

    指定されたパスのファイルにトレースをエクスポートします。

戻り値

stop_chunk​

追加されたバージョン: v1.15 tracing.stop_chunk

トレースチャンクを停止します。複数のトレースチャンクの詳細については、tracing.start_chunk()を参照してください。

使用法

tracing.stop_chunk()
tracing.stop_chunk(**kwargs)

引数

戻り値