跳转到主要内容

Tracing

用于收集和保存 Playwright 跟踪信息的 API。Playwright 跟踪信息可以在 Playwright 脚本运行后在 Trace Viewer 中打开。

注意

您可能希望在您的配置文件中启用追踪，而不是使用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.net.cn")
context.tracing.stop(path = "trace.zip")

方法​

group​

新增于: v1.49 tracing.group
注意

如果可用，请改用test.step。

在跟踪中创建一个新组，将所有后续的 API 调用分配给该组，直到调用 tracing.group_end()。组可以嵌套，并且会显示在跟踪查看器中。

用法

# 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.net.cn/")
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.net.cn")
context.tracing.stop(path = "trace.zip")

参数

  • name str (可选)#

    如果指定，中间跟踪文件将保存到 traces_dir 目录（在 browser_type.launch() 中指定）内具有给定名称前缀的文件中。要指定最终的跟踪 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.net.cn")

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

参数

返回

stop​

添加于：v1.12 tracing.stop

停止追踪。

用法

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

参数

返回

stop_chunk​

新增于: v1.15 tracing.stop_chunk

停止跟踪块。有关多个跟踪块的更多详细信息，请参阅 tracing.start_chunk()。

用法

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

参数

返回