跳到主要内容

页面

页面提供方法与单个选项卡交互 浏览器, 或者一个 扩展背景页面 在 Chromium 中。一个 浏览器 实例可能有多个 页面 实例。

此示例创建一个页面，将其导航到 URL，然后保存屏幕截图

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch()
    context = browser.new_context()
    page = context.new_page()
    page.goto("https://example.com")
    page.screenshot(path="screenshot.png")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

Page 类发出各种事件（在下面描述），可以使用任何 Node 的原生 EventEmitter 方法处理，例如 on、once 或 removeListener。

此示例记录单个页面 load 事件的消息

page.once("load", lambda: print("page loaded!"))

要取消订阅事件，请使用 removeListener 方法

def log_request(intercepted_request):
    print("a request was made:", intercepted_request.url)
page.on("request", log_request)
# sometime later...
page.remove_listener("request", log_request)

方法​

add_init_script​

在 v1.9 之前添加 page.add_init_script

添加将在以下一种情况下执行的脚本

  • 每当页面导航时。
  • 每当子框架附加或导航时。在这种情况下，该脚本在新附加的框架的上下文中执行。

该脚本在文档创建后但运行其任何脚本之前执行。这对于修改 JavaScript 环境很有用，例如为了对 Math.random 进行播种。

用法

在页面加载之前覆盖 Math.random 的示例

// preload.js
Math.random = () => 42;
# in your playwright script, assuming the preload.js file is in same directory
page.add_init_script(path="./preload.js")
注意

通过 browser_context.add_init_script() 和 page.add_init_script() 安装的多个脚本的执行顺序未定义。

参数

  • path Union[str, pathlib.Path] (可选)#

    JavaScript 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。可选。

  • script str (可选)#

    将在浏览器上下文中的所有页面中执行的脚本。可选。

返回值

add_locator_handler​

在以下版本中添加：v1.42 page.add_locator_handler

在测试网页时，有时会出现意外的覆盖层，例如“注册”对话框，阻止您想要自动执行的操作，例如单击按钮。这些覆盖层并不总是以相同的方式或在同一时间出现，因此难以在自动化测试中处理。

此方法允许您设置一个特殊函数，称为处理程序，当它检测到覆盖层可见时会激活。处理程序的任务是移除覆盖层，允许您的测试继续进行，就好像覆盖层不存在一样。

注意事项

  • 当覆盖层以可预测的方式显示时，我们建议在您的测试中显式地等待它，并将其作为您正常测试流程的一部分进行处理，而不是使用 page.add_locator_handler()。
  • Playwright 在每次执行或重试需要 可操作性检查 的操作之前，或者在执行自动等待断言检查之前，都会检查覆盖层。当覆盖层可见时，Playwright 首先调用处理程序，然后继续执行操作/断言。请注意，仅当您执行操作/断言时才会调用处理程序 - 如果覆盖层变得可见，但您没有执行任何操作，则处理程序不会触发。
  • 执行处理程序后，Playwright 会确保触发处理程序的覆盖层不再可见。您可以使用 no_wait_after 选择退出此行为。
  • 处理程序的执行时间计入执行处理程序的操作/断言的超时时间。如果您的处理程序花费的时间过长，可能会导致超时。
  • 您可以注册多个处理程序。但是，一次只能运行一个处理程序。确保处理程序中的操作不依赖于另一个处理程序。
警告

运行处理程序将改变您的页面状态，位于测试中间。例如，它将更改当前聚焦的元素并移动鼠标。确保在处理程序运行后的操作是独立的，并且不依赖于焦点和鼠标状态保持不变。

例如，考虑一个测试，它调用 locator.focus()，然后调用 keyboard.press()。如果您的处理程序在这两个操作之间点击了一个按钮，那么聚焦的元素很可能不正确，并且按键将发生在意外的元素上。使用 locator.press() 代替以避免此问题。

另一个示例是鼠标操作的系列，其中 mouse.move() 之后是 mouse.down()。同样，当处理程序在这两个操作之间运行时，鼠标在鼠标按下时的位置将不正确。优先使用独立的操作，例如 locator.click()，它不依赖于状态不被处理程序更改。

用法

当出现“注册到时事通讯”对话框时将其关闭的示例

# Setup the handler.
def handler():
  page.get_by_role("button", name="No thanks").click()
page.add_locator_handler(page.get_by_text("Sign up to the newsletter"), handler)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

当显示“确认您的安全详细信息”页面时跳过它的示例

# Setup the handler.
def handler():
  page.get_by_role("button", name="Remind me later").click()
page.add_locator_handler(page.get_by_text("Confirm your security details"), handler)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

使用每次可操作性检查的自定义回调的示例。它使用始终可见的 <body> 定位器，因此每次可操作性检查之前都会调用处理程序。指定 no_wait_after 很重要，因为处理程序不会隐藏 <body> 元素。

# Setup the handler.
def handler():
  page.evaluate("window.removeObstructionsForTestIfNeeded()")
page.add_locator_handler(page.locator("body"), handler, no_wait_after=True)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

处理程序将原始定位器作为参数。您还可以通过设置 times，在指定次数的调用后自动移除处理程序。

def handler(locator):
  locator.click()
page.add_locator_handler(page.get_by_label("Close"), handler, times=1)

参数

  • locator Locator#

    触发处理程序的定位器。

  • handler Callable[Locator]:Promise[Any]#

    当 locator 出现时应该运行的函数。此函数应去除阻止单击等操作的元素。

  • no_wait_after bool (可选)在以下版本中添加：v1.44#

    默认情况下，在调用处理程序后，Playwright 会等待直到覆盖层隐藏，然后 Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便覆盖层在处理程序运行后仍然可见。

  • times int (可选)在以下版本中添加：v1.44#

    指定此处理程序应被调用的最大次数。默认情况下无限制。

返回值

add_script_tag​

在 v1.9 之前添加 page.add_script_tag

在页面中添加一个 <script> 标签，其中包含所需的 url 或内容。当脚本的 onload 触发或脚本内容被注入框架时，返回添加的标签。

用法

page.add_script_tag()
page.add_script_tag(**kwargs)

参数

  • content str (可选)#

    要注入框架的原始 JavaScript 内容。

  • path Union[str, pathlib.Path] (可选)#

    要注入到框架中的 JavaScript 文件的路径。如果 path 是相对路径，则它将相对于当前工作目录解析。

  • type str (可选)#

    脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关更多详细信息，请参见 script。

  • url str (可选)#

    要添加的脚本的 URL。

返回值

add_style_tag​

在 v1.9 之前添加 page.add_style_tag

在页面中添加一个 <link rel="stylesheet"> 标签，并使用所需的 url 或 <style type="text/css"> 标签及其内容。当样式表的 onload 事件触发或 CSS 内容注入到框架中时，返回添加的标签。

用法

page.add_style_tag()
page.add_style_tag(**kwargs)

参数

  • content str (可选)#

    要注入到框架中的原始 CSS 内容。

  • path Union[str, pathlib.Path] (可选)#

    要注入到框架中的 CSS 文件的路径。如果 path 是相对路径，则它将相对于当前工作目录解析。

  • url str (可选)#

    <link> 标签的 URL。

返回值

bring_to_front​

在 v1.9 之前添加 page.bring_to_front

将页面置于最前面（激活选项卡）。

用法

page.bring_to_front()

返回值

close​

在 v1.9 之前添加 page.close

如果 run_before_unload 为 false，则不运行任何卸载处理程序，并等待页面关闭。如果 run_before_unload 为 true，该方法将运行卸载处理程序，但不会等待页面关闭。

默认情况下，page.close() 不会运行 beforeunload 处理程序。

注意

如果 run_before_unload 传递为 true，则可能会出现 beforeunload 对话框，应通过 page.on("dialog") 事件手动处理。

用法

page.close()
page.close(**kwargs)

参数

  • reason str (可选)新增于：v1.40#

    要报告给因页面关闭而中断的操作的原因。

  • run_before_unload bool (可选)#

    默认为 false。是否运行 before unload 页面处理程序。

返回值

content​

在 v1.9 之前添加 page.content

获取页面的完整 HTML 内容，包括文档类型。

用法

page.content()

返回值

drag_and_drop​

新增于：v1.13 page.drag_and_drop

此方法将源元素拖动到目标元素。它将首先移动到源元素，执行 mousedown，然后移动到目标元素并执行 mouseup。

用法

page.drag_and_drop("#source", "#target")
# or specify exact positions relative to the top-left corners of the elements:
page.drag_and_drop(
  "#source",
  "#target",
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)

参数

  • source str#

    一个选择器，用于搜索要拖动的元素。如果有多个元素满足选择器，则使用第一个元素。

  • target str#

    一个选择器，用于搜索要拖放到其上的元素。如果有多个元素满足选择器，则使用第一个元素。

  • force bool (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • source_position Dict (可选)新增于：v1.14#

    相对于元素填充框的左上角，在该点上点击源元素。如果没有指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • target_position Dict (可选)新增于：v1.14#

    相对于元素填充框的左上角，在该点上将目标元素放置在目标元素上。如果没有指定，则使用元素的某个可见点。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial bool (可选)#

    当设置此方法时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回值

emulate_media​

在 v1.9 之前添加 page.emulate_media

此方法使用 media 参数更改 CSS 媒体类型，或使用 colorScheme 参数更改 'prefers-colors-scheme' 媒体功能。

用法

page.evaluate("matchMedia('screen').matches")
# → True
page.evaluate("matchMedia('print').matches")
# → False

page.emulate_media(media="print")
page.evaluate("matchMedia('screen').matches")
# → False
page.evaluate("matchMedia('print').matches")
# → True

page.emulate_media()
page.evaluate("matchMedia('screen').matches")
# → True
page.evaluate("matchMedia('print').matches")
# → False
page.emulate_media(color_scheme="dark")
page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
# → True
page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
# → False
page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")

参数

  • color_scheme "light" | "dark" | "no-preference" | "null" (可选)新增于：v1.9#

    模拟 'prefers-colors-scheme' 媒体功能，支持的值为 'light'、'dark'、'no-preference'。传递 'Null' 会禁用颜色方案模拟。

  • forced_colors "active" | "none" | "null" (可选)新增于：v1.15#

  • media "screen" | "print" | "null" (可选)新增于：v1.9#

    更改页面的 CSS 媒体类型。唯一允许的值为 'Screen'、'Print' 和 'Null'。传递 'Null' 会禁用 CSS 媒体模拟。

  • reduced_motion "reduce" | "no-preference" | "null" (可选)新增于：v1.12#

    模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。传递 null 会禁用减少运动模拟。

返回值

evaluate​

在 v1.9 之前添加 page.evaluate

返回 expression 调用的值。

如果传递给 page.evaluate() 的函数返回 Promise，则 page.evaluate() 将等待 Promise 解析并返回其值。

如果传递给 page.evaluate() 的函数返回非 可序列化 值，则 page.evaluate() 解析为 undefined。Playwright 还支持传输一些无法通过 JSON 序列化的额外值：-0、NaN、Infinity、-Infinity。

用法

将参数传递给 expression

result = page.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
print(result) # prints "56"

除了函数，还可以传入字符串。

print(page.evaluate("1 + 2")) # prints "3"
x = 10
print(page.evaluate(f"1 + {x}")) # prints "11"

ElementHandle 实例可以作为参数传递给 page.evaluate()

body_handle = page.evaluate("document.body")
html = page.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
body_handle.dispose()

参数

  • expression str#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回值

evaluate_handle​

在 v1.9 之前添加 page.evaluate_handle

将 expression 调用的值作为 JSHandle 返回。

page.evaluate() 和 page.evaluate_handle() 之间的唯一区别是 page.evaluate_handle() 返回 JSHandle。

如果传递给 page.evaluate_handle() 的函数返回一个 Promise，则 page.evaluate_handle() 将等待 Promise 解决并返回其值。

用法

a_window_handle = page.evaluate_handle("Promise.resolve(window)")
a_window_handle # handle for the window object.

除了函数，还可以传入字符串。

a_handle = page.evaluate_handle("document") # handle for the "document"

JSHandle 实例可以作为参数传递给 page.evaluate_handle()

a_handle = page.evaluate_handle("document.body")
result_handle = page.evaluate_handle("body => body.innerHTML", a_handle)
print(result_handle.json_value())
result_handle.dispose()

参数

  • expression str#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回值

expect_console_message​

新增于：v1.9 page.expect_console_message

执行操作并等待页面中记录的 ConsoleMessage。如果提供谓词，则将 ConsoleMessage 值传递到 predicate 函数中，并等待 predicate(message) 返回真值。如果在 page.on("console") 事件触发之前页面关闭，则会抛出错误。

用法

page.expect_console_message()
page.expect_console_message(**kwargs)

参数

返回值

expect_download​

新增于：v1.9 page.expect_download

执行操作并等待新的 Download。如果提供谓词，则将 Download 值传递到 predicate 函数中，并等待 predicate(download) 返回真值。如果在下载事件触发之前页面关闭，则会抛出错误。

用法

page.expect_download()
page.expect_download(**kwargs)

参数

返回值

expect_event​

在 v1.9 之前添加 page.expect_event

等待事件触发，并将它的值传递到谓词函数中。在谓词返回真值时返回。如果在事件触发之前页面关闭，则会抛出错误。返回事件数据值。

用法

with page.expect_event("framenavigated") as event_info:
    page.get_by_role("button")
frame = event_info.value

参数

  • event str#

    事件名称，与通常传递到 *.on(event) 中的名称相同。

  • predicate Callable (可选)#

    接收事件数据，并在等待应解决时解析为真值。

  • timeout float (可选)#

    最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。可以通过使用 browser_context.set_default_timeout() 更改默认值。

返回值

expect_file_chooser​

新增于：v1.9 page.expect_file_chooser

执行操作并等待创建新的 FileChooser。如果提供谓词，则将 FileChooser 值传递到 predicate 函数中，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，则会抛出错误。

用法

page.expect_file_chooser()
page.expect_file_chooser(**kwargs)

参数

返回值

expect_popup​

新增于：v1.9 page.expect_popup

执行操作并等待弹出窗口 Page。如果提供谓词，则将 [Popup] 值传递到 predicate 函数中，并等待 predicate(page) 返回真值。如果在弹出窗口事件触发之前页面关闭，则会抛出错误。

用法

page.expect_popup()
page.expect_popup(**kwargs)

参数

返回值

expect_request​

在 v1.9 之前添加 page.expect_request

等待匹配的请求并返回它。有关事件的更多信息，请参见 等待事件。

用法

with page.expect_request("http://example.com/resource") as first:
    page.get_by_text("trigger request").click()
first_request = first.value

# or with a lambda
with page.expect_request(lambda request: request.url == "http://example.com" and request.method == "get") as second:
    page.get_by_text("trigger request").click()
second_request = second.value

参数

返回值

expect_request_finished​

新增于：v1.12 page.expect_request_finished

执行操作并等待 Request 完成加载。如果提供谓词，它将 Request 值传递到 predicate 函数中，并等待 predicate(request) 返回真值。如果在 page.on("requestfinished") 事件触发之前关闭页面，将抛出错误。

用法

page.expect_request_finished()
page.expect_request_finished(**kwargs)

参数

返回值

expect_response​

在 v1.9 之前添加 page.expect_response

返回匹配的响应。有关事件的更多详细信息，请参见 等待事件。

用法

with page.expect_response("https://example.com/resource") as response_info:
    page.get_by_text("trigger response").click()
response = response_info.value
return response.ok

# or with a lambda
with page.expect_response(lambda response: response.url == "https://example.com" and response.status == 200 and response.request.method == "get") as response_info:
    page.get_by_text("trigger response").click()
response = response_info.value
return response.ok

参数

返回值

expect_websocket​

新增于：v1.9 page.expect_websocket

执行操作并等待新的 WebSocket。如果提供谓词，它将 WebSocket 值传递到 predicate 函数中，并等待 predicate(webSocket) 返回真值。如果在 WebSocket 事件触发之前关闭页面，将抛出错误。

用法

page.expect_websocket()
page.expect_websocket(**kwargs)

参数

返回值

expect_worker​

新增于：v1.9 page.expect_worker

执行操作并等待新的 Worker。如果提供谓词，它将 Worker 值传递到 predicate 函数中，并等待 predicate(worker) 返回真值。如果在 worker 事件触发之前关闭页面，将抛出错误。

用法

page.expect_worker()
page.expect_worker(**kwargs)

参数

返回值

expose_binding​

在 v1.9 之前添加 page.expose_binding

该方法在该页面中每个框架的 window 对象上添加一个名为 name 的函数。当调用该函数时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

callback 函数的第一个参数包含有关调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

有关上下文范围版本的详细信息，请参见 browser_context.expose_binding()。

注意

通过 page.expose_binding() 安装的函数会在导航中保留。

用法

将页面 URL 公开给页面中所有框架的示例

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    context = browser.new_context()
    page = context.new_page()
    page.expose_binding("pageURL", lambda source: source["page"].url)
    page.set_content("""
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
    """)
    page.click("button")

with sync_playwright() as playwright:
    run(playwright)

参数

  • name str#

    window 对象上函数的名称。

  • callback Callable#

    将在 Playwright 上下文中调用的回调函数。

  • handle bool (可选)#

    已弃用

    此选项将在未来被删除。

    是否将参数作为句柄传递，而不是按值传递。当传递句柄时，仅支持一个参数。当按值传递时，支持多个参数。

返回值

expose_function​

在 v1.9 之前添加 page.expose_function

该方法在该页面中每个框架的 window 对象上添加一个名为 name 的函数。当调用该函数时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。

如果 callback 返回一个 Promise，它将被等待。

有关上下文范围公开函数的详细信息，请参见 browser_context.expose_function()。

注意

通过 page.expose_function() 安装的函数会在导航中保留。

用法

将 sha256 函数添加到页面的示例

import hashlib
from playwright.sync_api import sync_playwright, Playwright

def sha256(text):
    m = hashlib.sha256()
    m.update(bytes(text, "utf8"))
    return m.hexdigest()


def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    page = browser.new_page()
    page.expose_function("sha256", sha256)
    page.set_content("""
        <script>
          async function onClick() {
            document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
          }
        </script>
        <button onclick="onClick()">Click me</button>
        <div></div>
    """)
    page.click("button")

with sync_playwright() as playwright:
    run(playwright)

参数

  • name str#

    window 对象上函数的名称

  • callback Callable#

    在 Playwright 上下文中调用的回调函数。

返回值

frame​

在 v1.9 之前添加 page.frame

返回与指定条件匹配的框架。必须指定name或url。

用法

frame = page.frame(name="frame-name")
frame = page.frame(url=r".*domain.*")

参数

  • name str (可选)#

    在iframe的name属性中指定的框架名称。可选。

  • url str | Pattern | Callable[URL]:bool (可选)#

    一个 glob 模式，正则表达式模式或谓词，接收框架的url作为URL对象。可选。

返回值

frame_locator​

添加时间: v1.17 page.frame_locator

在处理 iframe 时，您可以创建一个 frame locator，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

以下代码片段定位了 id 为 my-frame 的 iframe 中文本为“Submit”的元素，例如 <iframe id="my-frame">

locator = page.frame_locator("#my-iframe").get_by_text("Submit")
locator.click()

参数

  • selector str#

    在解析 DOM 元素时要使用的选择器。

返回值

get_by_alt_text​

添加时间: v1.27 page.get_by_alt_text

允许通过 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本“Playwright logo”查找图像

<img alt='Playwright logo'>
page.get_by_alt_text("Playwright logo").click()

参数

  • text str | Pattern#

    要定位的元素的文本。

  • exact bool (可选)#

    是否查找完全匹配：区分大小写且为完整字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

get_by_label​

添加时间: v1.27 page.get_by_label

允许通过关联的<label>或aria-labelledby元素的文本，或通过aria-label属性定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签“Username”和“Password”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")

参数

  • text str | Pattern#

    要定位的元素的文本。

  • exact bool (可选)#

    是否查找完全匹配：区分大小写且为完整字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

get_by_placeholder​

添加时间: v1.27 page.get_by_placeholder

允许通过占位符文本定位输入元素。

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

通过占位符文本定位输入后，您可以填写它

page.get_by_placeholder("[email protected]").fill("[email protected]")

参数

  • text str | Pattern#

    要定位的元素的文本。

  • exact bool (可选)#

    是否查找完全匹配：区分大小写且为完整字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

get_by_role​

添加时间: v1.27 page.get_by_role

允许通过其ARIA 角色，ARIA 属性和可访问名称定位元素。

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

您可以通过其隐式角色定位每个元素

expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

page.get_by_role("checkbox", name="Subscribe").check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

参数

  • role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"#

    必需的 aria 角色。

  • checked bool (可选)#

    通常由aria-checked或原生<input type=checkbox>控件设置的属性。

    了解有关aria-checked的更多信息。

  • disabled bool (可选)#

    通常由aria-disabled或disabled设置的属性。

    注意

    与大多数其他属性不同，disabled是通过 DOM 层次结构继承的。了解有关aria-disabled的更多信息。

  • exact bool (可选)添加时间: v1.28#

    是否name是完全匹配：区分大小写且为完整字符串。默认为 false。当name是正则表达式时忽略。请注意，完全匹配仍然会修剪空格。

  • expanded bool (可选)#

    通常由aria-expanded设置的属性。

    了解有关aria-expanded的更多信息。

  • include_hidden bool (可选)#

    控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（按ARIA 定义）与角色选择器匹配。

    了解有关aria-hidden的更多信息。

  • level int (可选)#

    通常针对角色heading、listitem、row、treeitem存在的数字属性，<h1>-<h6>元素具有默认值。

    了解有关aria-level的更多信息。

  • name str | Pattern (可选)#

    匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用exact控制此行为。

    了解有关可访问名称的更多信息。

  • pressed bool (可选)#

    通常由aria-pressed设置的属性。

    了解有关aria-pressed的更多信息。

  • selected bool (可选)#

    通常由aria-selected设置的属性。

    了解有关aria-selected的更多信息。

返回值

详细信息

角色选择器**不会替代**无障碍审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素都有一个由角色选择器识别的隐式定义的角色。您可以在这里找到所有支持的角色。ARIA 指南不建议通过设置role 和/或 aria-* 属性来重复隐式角色和属性，这些属性被设置为默认值。

get_by_test_id​

添加时间: v1.27 page.get_by_test_id

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

<button data-testid="directions">Itinéraire</button>

您可以通过元素的测试 ID 来定位它。

page.get_by_test_id("directions").click()

参数

  • test_id str | 模式#

    用于定位元素的 ID。

返回值

详细信息

默认情况下，data-testid 属性用作测试 ID。如果需要，请使用selectors.set_test_id_attribute() 配置不同的测试 ID 属性。

get_by_text​

添加时间: v1.27 page.get_by_text

允许定位包含给定文本的元素。

另请参见locator.filter()，它允许通过其他标准（如可访问角色）进行匹配，然后按文本内容进行过滤。

用法

考虑以下 DOM 结构

<div>Hello <span>world</span></div>
<div>Hello</div>

您可以通过文本子字符串、完整字符串或正则表达式进行定位。

# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

参数

  • text str | 模式#

    要定位的元素的文本。

  • exact bool (可选)#

    是否查找完全匹配：区分大小写且为完整字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

详细信息

通过文本匹配始终规范化空格，即使进行精确匹配也是如此。例如，它将多个空格转换为一个空格，将换行符转换为空格，并忽略前导和尾随空格。

类型为 button 和 submit 的输入元素与其value 匹配，而不是其文本内容。例如，通过文本 "登录" 进行定位与 <input type=button value="登录"> 匹配。

get_by_title​

添加时间: v1.27 page.get_by_title

允许通过元素的 title 属性进行定位。

用法

考虑以下 DOM 结构。

<span title='Issues count'>25 issues</span>

您可以在通过标题文本进行定位后检查问题计数。

expect(page.get_by_title("Issues count")).to_have_text("25 issues")

参数

  • text str | 模式#

    要定位的元素的文本。

  • exact bool (可选)#

    是否查找完全匹配：区分大小写且为完整字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

go_back​

在 v1.9 之前添加 page.go_back

返回主资源响应。如果存在多个重定向，导航将以最后一个重定向的响应解析。如果无法返回，则返回 null。

导航到历史记录中的上一页。

用法

page.go_back()
page.go_back(**kwargs)

参数

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

go_forward​

在 v1.9 之前添加 page.go_forward

返回主资源响应。如果存在多个重定向，导航将以最后一个重定向的响应解析。如果无法前进，则返回 null。

导航到历史记录中的下一页。

用法

page.go_forward()
page.go_forward(**kwargs)

参数

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

goto​

在 v1.9 之前添加 page.goto

返回主资源响应。如果存在多个重定向，导航将以第一个非重定向响应解析。

如果出现以下情况，该方法将引发错误

  • 存在 SSL 错误（例如，在自签名证书的情况下）。
  • 目标 URL 无效。
  • 在导航过程中超过了超时 时间。
  • 远程服务器未响应或无法访问。
  • 主资源加载失败。

如果远程服务器返回任何有效的 HTTP 状态代码，该方法将不会引发错误，包括 404 “未找到” 和 500 “内部服务器错误”。可以通过调用response.status 来检索此类响应的状态代码。

注意

该方法要么引发错误，要么返回主资源响应。唯一的例外是导航到 about:blank 或导航到具有不同哈希值的相同 URL，这将成功并返回 null。

注意

无头模式不支持导航到 PDF 文档。请参见上游问题。

用法

page.goto(url)
page.goto(url, **kwargs)

参数

  • url str#

    要将页面导航到的 URL。URL 应包含方案，例如 https://。当通过上下文选项提供base_url 并且传递的 URL 是路径时，它将通过new URL() 构造函数进行合并。

  • referer str (可选)#

    Referer 标头值。如果提供，它将优先于由page.set_extra_http_headers() 设置的 Referer 标头值。

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

locator​

新增于：v1.14 page.locator

该方法返回一个元素定位器，可用于对该页面/框架执行操作。定位器在执行操作之前立即解析为元素，因此对同一个定位器的系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了变化，就会发生这种情况。

详细了解定位器.

用法

page.locator(selector)
page.locator(selector, **kwargs)

参数

  • selector str#

    在解析 DOM 元素时要使用的选择器。

  • has 定位器 (可选)#

    将方法的结果缩小到包含与该相对定位器匹配的元素的结果。例如，包含 text=Playwright 的 article 与 <article><div>Playwright</div></article> 匹配。

    内部定位器必须相对于外部定位器，并且从外部定位器匹配开始查询，而不是从文档根目录开始查询。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将失败，因为内部定位器必须是相对的，并且不应使用 content 外部的任何元素。

    请注意，外部定位器和内部定位器必须属于同一框架。内部定位器不应包含FrameLocator。

  • has_not 定位器 (可选)新增于：v1.33#

    匹配不包含与内部定位器匹配的元素的元素。内部定位器相对于外部定位器进行查询。例如，不包含 div 的 article 与 <article><span>Playwright</span></article> 匹配。

    请注意，外部定位器和内部定位器必须属于同一框架。内部定位器不应包含FrameLocator。

  • has_not_text str | 模式 (可选)新增于：v1.33#

    匹配不包含在内部（可能在子元素或后代元素中）的某个位置包含指定文本的元素。当传递 [字符串] 时，匹配不区分大小写，并搜索子字符串。

  • has_text str | Pattern (可选)#

    匹配包含指定文本的元素，文本可能位于子元素或后代元素中。如果传递 [字符串]，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

opener​

在 v1.9 之前添加 page.opener

返回弹出页面的打开器，对于其他页面返回 null。如果打开器已关闭，则返回 null。

用法

page.opener()

返回值

pause​

新增于：v1.9 page.pause

暂停脚本执行。Playwright 将停止执行脚本，并等待用户按下页面叠加层中的“恢复”按钮，或在 DevTools 控制台中调用 playwright.resume()。

用户可以在暂停时检查选择器或执行手动步骤。恢复将从暂停的地方继续运行原始脚本。

注意

此方法要求 Playwright 在有头模式下启动，并使用一个假值 headless 选项。

用法

page.pause()

返回值

pdf​

在 v1.9 之前添加 page.pdf

返回 PDF 缓冲区。

注意

目前仅在 Chromium 无头模式下支持生成 PDF。

page.pdf() 使用 print css 媒体生成页面的 PDF。要使用 screen 媒体生成 PDF，请在调用 page.pdf() 之前调用 page.emulate_media()

注意

默认情况下，page.pdf() 生成一个使用修改后的颜色进行打印的 PDF。使用 -webkit-print-color-adjust 属性强制渲染精确的颜色。

用法

# generates a pdf with "screen" media type.
page.emulate_media(media="screen")
page.pdf(path="page.pdf")

width、height 和 margin 选项接受带有单位的标签值。未标记的值将被视为像素。

以下是一些示例

  • page.pdf({width: 100}) - 使用 100 像素的宽度进行打印
  • page.pdf({width: '100px'}) - 使用 100 像素的宽度进行打印
  • page.pdf({width: '10cm'}) - 使用 10 厘米的宽度进行打印。

所有可能的单位是

  • px - 像素
  • in - 英寸
  • cm - 厘米
  • mm - 毫米

format 选项是

  • Letter: 8.5in x 11in
  • Legal: 8.5in x 14in
  • Tabloid: 11in x 17in
  • Ledger: 17in x 11in
  • A0: 33.1in x 46.8in
  • A1: 23.4in x 33.1in
  • A2: 16.54in x 23.4in
  • A3: 11.7in x 16.54in
  • A4: 8.27in x 11.7in
  • A5: 5.83in x 8.27in
  • A6: 4.13in x 5.83in
注意

header_template 和 footer_template 标记有以下限制： > 1. 模板中的脚本标签不会被评估。 > 2. 页面样式在模板中不可见。

参数

  • display_header_footer bool (可选)#

    显示页眉和页脚。默认为 false。

  • footer_template str (可选)#

    打印页脚的 HTML 模板。应使用与 header_template 相同的格式。

  • format str (可选)#

    纸张格式。如果设置，则优先于 width 或 height 选项。默认为 'Letter'。

  • header_template str (可选)#

    打印页眉的 HTML 模板。应为有效的 HTML 标记，使用以下类将其注入打印值

    • 'date' 格式化的打印日期
    • 'title' 文档标题
    • 'url' 文档位置
    • 'pageNumber' 当前页码
    • 'totalPages' 文档中的总页数

  • height str | float (可选)#

    纸张高度，接受带有单位的标签值。

  • landscape bool (可选)#

    纸张方向。默认为 false。

  • margin Dict (可选)#

    • top str | float (可选)

      上边距，接受带有单位的标签值。默认为 0。

    • right str | float (可选)

      右边距，接受带有单位的标签值。默认为 0。

    • bottom str | float (可选)

      下边距，接受带有单位的标签值。默认为 0。

    • left str | float (可选)

      左边距，接受带有单位的标签值。默认为 0。

    纸张边距，默认为无。

  • outline bool (可选)在以下版本中添加：v1.42#

    是否将文档大纲嵌入 PDF 中。默认为 false。

  • page_ranges str (可选)#

    要打印的纸张范围，例如 '1-5, 8, 11-13'。默认为空字符串，表示打印所有页面。

  • path Union[str, pathlib.Path] (可选)#

    要将 PDF 保存到的文件路径。如果 path 是相对路径，则它将相对于当前工作目录解析。如果没有提供路径，则 PDF 不会保存到磁盘。

  • prefer_css_page_size bool (可选)#

    让页面中声明的任何 CSS @page 大小优先于 width 和 height 或 format 选项中声明的大小。默认为 false，这将缩放内容以适合纸张大小。

  • print_background bool (可选)#

    打印背景图形。默认为 false。

  • scale float (可选)#

    网页渲染的比例。默认为 1。比例系数必须介于 0.1 和 2 之间。

  • tagged bool (可选)在以下版本中添加：v1.42#

    是否生成带标签（可访问）的 PDF。默认为 false。

  • width str | float (可选)#

    纸张宽度，接受带有单位的标签值。

返回值

reload​

在 v1.9 之前添加 page.reload

此方法重新加载当前页面，与用户触发浏览器刷新相同。返回主资源响应。如果发生多次重定向，则导航将使用最后一次重定向的响应进行解析。

用法

page.reload()
page.reload(**kwargs)

参数

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

remove_locator_handler​

在以下版本中添加：v1.44 page.remove_locator_handler

移除所有由 page.add_locator_handler() 添加的特定定位器定位器处理程序。

用法

page.remove_locator_handler(locator)

参数

返回值

request_gc​

新增于: v1.48 page.request_gc

请求页面执行垃圾回收。 请注意，无法保证所有无法访问的对象都会被回收。

这有助于检测内存泄漏。 例如，如果您的页面有一个大型对象 'suspect' 可能存在泄漏，您可以使用 WeakRef 检查它是否泄漏。

# 1. In your page, save a WeakRef for the "suspect".
page.evaluate("globalThis.suspectWeakRef = new WeakRef(suspect)")
# 2. Request garbage collection.
page.request_gc()
# 3. Check that weak ref does not deref to the original object.
assert page.evaluate("!globalThis.suspectWeakRef.deref()")

用法

page.request_gc()

返回值

route​

在 v1.9 之前添加 page.route

路由提供了修改页面发出的网络请求的能力。

启用路由后，每个匹配 url 模式的请求都会暂停，除非它被继续、完成或中止。

注意

如果响应是重定向，则处理程序将只对第一个 url 调用。

注意

page.route() 不会拦截服务工作者拦截的请求。 参见 此 问题。 我们建议通过将 service_workers 设置为 'block' 来禁用服务工作者，以便使用请求拦截。

注意

page.route() 不会拦截弹出页面的第一个请求。 请改用 browser_context.route()。

用法

一个简单处理程序的示例，它中止所有图像请求

page = browser.new_page()
page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.goto("https://example.com")
browser.close()

或者使用正则表达式模式代替的相同代码片段

page = browser.new_page()
page.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
page.goto("https://example.com")
browser.close()

可以检查请求以确定路由操作。 例如，模拟所有包含一些发布数据的请求，并将所有其他请求保留原样

def handle_route(route: Route):
  if ("my-string" in route.request.post_data):
    route.fulfill(body="mocked-data")
  else:
    route.continue_()
page.route("/api/**", handle_route)

当请求匹配两个处理程序时，页面路由优先于浏览器上下文路由（使用 browser_context.route() 设置）。

要删除路由及其处理程序，可以使用 page.unroute()。

注意

启用路由将禁用 http 缓存。

参数

  • url str | Pattern | Callable[URL]:bool#

    一个 glob 模式、正则表达式模式或谓词，接收 URL 以在路由时匹配。 当通过上下文选项提供 base_url 并且传递的 URL 是一个路径时，它会通过 new URL() 构造函数合并。

  • handler Callable[Route, Request]:Promise[Any] | Any#

    用于路由请求的处理程序函数。

  • times int (可选)新增于：v1.15#

    路由的使用频率。 默认情况下，它将在每次都使用。

返回值

route_from_har​

新增于: v1.23 page.route_from_har

如果指定，页面发出的网络请求将从 HAR 文件中提供服务。 阅读更多关于 从 HAR 重新播放。

Playwright 不会从 HAR 文件中提供服务工作者拦截的请求。 参见 此 问题。 我们建议通过将 service_workers 设置为 'block' 来禁用服务工作者，以便使用请求拦截。

用法

page.route_from_har(har)
page.route_from_har(har, **kwargs)

参数

  • har Union[str, pathlib.Path]#

    包含预先录制网络数据的 HAR 文件的路径。 如果 path 是一个相对路径，则它是相对于当前工作目录解析的。

  • not_found "abort" | "fallback" (可选)#

    • 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
    • 如果设置为 'fallback'，则丢失的请求将发送到网络。

    默认为 abort。

  • update bool (可选)#

    如果指定，则使用实际的网络信息更新给定的 HAR，而不是从文件中提供服务。 当 browser_context.close() 被调用时，文件被写入磁盘。

  • update_content "embed" | "attach" (可选)新增于: v1.32#

    可选设置，用于控制资源内容管理。 如果指定 attach，则资源将作为单独的文件或 ZIP 存档中的条目持久化。 如果指定 embed，则内容将内联存储在 HAR 文件中。

  • update_mode "full" | "minimal" (可选)新增于: v1.32#

    当设置为 minimal 时，只记录从 HAR 路由所需的信息。 这省略了大小、时间、页面、cookie、安全和其他类型的 HAR 信息，这些信息在从 HAR 重新播放时不会使用。 默认值为 minimal。

  • url str | Pattern (可选)#

    一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。 只有 URL 匹配该模式的请求才会从 HAR 文件中提供服务。 如果未指定，则所有请求都将从 HAR 文件中提供服务。

返回值

route_web_socket​

新增于: v1.48 page.route_web_socket

此方法允许修改页面发出的 websocket 连接。

请注意，只有在此方法被调用后创建的 WebSocket 会被路由。 建议在导航页面之前调用此方法。

用法

下面是一个简单模拟的示例，它响应单个消息。 参见 WebSocketRoute 了解详细信息和示例。

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    ws.send("response")

def handler(ws: WebSocketRoute):
  ws.on_message(lambda message: message_handler(ws, message))

page.route_web_socket("/ws", handler)

参数

返回值

screenshot​

在 v1.9 之前添加 page.screenshot

返回包含捕获屏幕截图的缓冲区。

用法

page.screenshot()
page.screenshot(**kwargs)

参数

  • animations "disabled" | "allow" (可选)#

    当设置为 "disabled" 时，会停止 CSS 动画、CSS 过渡和 Web 动画。 动画会根据其持续时间得到不同的处理

    • 有限动画会快速转发到完成，因此它们会触发 transitionend 事件。
    • 无限动画被取消到初始状态，然后在屏幕截图后播放。

    默认值为 "allow"，它不会更改动画。

  • caret "hide" | "initial" (可选)#

    当设置为 "hide" 时，屏幕截图将隐藏文本光标。当设置为 "initial" 时，文本光标行为将不会改变。默认值为 "hide"。

  • clip Dict (可选)#

    • x float

      剪切区域左上角的 x 坐标

    • y float

      剪切区域左上角的 y 坐标

    • width float

      剪切区域的宽度

    • height float

      剪切区域的高度

    指定对结果图像进行剪切的对象。

  • full_page bool (可选)#

    如果为真，则拍摄整个可滚动页面的屏幕截图，而不是当前可见的视窗。默认为 false。

  • mask List[Locator] (可选)#

    指定在拍摄屏幕截图时应屏蔽的定位器。屏蔽元素将被覆盖在一个粉红色的框 #FF00FF （由 mask_color 自定义）上，该框完全覆盖其边界框。

  • mask_color str (可选)在: v1.35 中添加#

    使用 CSS 颜色格式 指定屏蔽元素的叠加框的颜色。默认颜色为粉红色 #FF00FF。

  • omit_background bool (可选)#

    隐藏默认的白色背景，允许以透明方式捕获屏幕截图。不适用于 jpeg 图像。默认为 false。

  • path Union[str, pathlib.Path] (可选)#

    保存图像的文件路径。屏幕截图类型将从文件扩展名推断出来。如果 path 是一个相对路径，那么它将相对于当前工作目录解析。如果没有提供路径，则图像不会保存到磁盘。

  • quality int (可选)#

    图像的质量，介于 0-100 之间。不适用于 png 图像。

  • scale "css" | "device" (可选)#

    当设置为 "css" 时，屏幕截图将每个 CSS 像素对应一个像素。对于高 DPI 设备，这将保持屏幕截图的大小。使用 "device" 选项将产生每个设备像素对应一个像素，因此高 DPI 设备的屏幕截图将是两倍大甚至更大。

    默认为 "device"。

  • style str (可选)在: v1.41 中添加#

    在制作屏幕截图时要应用的样式表文本。您可以在这里隐藏动态元素，使元素不可见或更改其属性，以帮助您创建可重复的屏幕截图。此样式表穿透 Shadow DOM 并应用于内部框架。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • type "png" | "jpeg" (可选)#

    指定屏幕截图类型，默认为 png。

返回值

set_content​

在 v1.9 之前添加 page.set_content

此方法在内部调用 document.write()，继承了其所有特定特征和行为。

用法

page.set_content(html)
page.set_content(html, **kwargs)

参数

  • html str#

    要分配给页面的 HTML 标记。

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

set_default_navigation_timeout​

在 v1.9 之前添加 page.set_default_navigation_timeout

此设置将更改以下方法及其相关快捷方式的默认最大导航时间

注意

page.set_default_navigation_timeout() 优先于 page.set_default_timeout()、browser_context.set_default_timeout() 和 browser_context.set_default_navigation_timeout()。

用法

page.set_default_navigation_timeout(timeout)

参数

  • timeout float#

    最大导航时间，以毫秒为单位

set_default_timeout​

在 v1.9 之前添加 page.set_default_timeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

注意

page.set_default_navigation_timeout() 优先于 page.set_default_timeout()。

用法

page.set_default_timeout(timeout)

参数

  • timeout float#

    最大时间，以毫秒为单位

set_extra_http_headers​

在 v1.9 之前添加 page.set_extra_http_headers

额外的 HTTP 标头将随页面启动的每个请求一起发送。

注意

page.set_extra_http_headers() 不保证传出请求中标头的顺序。

用法

page.set_extra_http_headers(headers)

参数

  • headers Dict[str, str]#

    一个包含要随每个请求发送的额外 HTTP 标头的对象。所有标头值必须是字符串。

返回值

set_viewport_size​

在 v1.9 之前添加 page.set_viewport_size

在单个浏览器中有多个页面时，每个页面都可以有自己的视窗大小。但是，browser.new_context() 允许为上下文中的所有页面一次性设置视窗大小（以及更多）。

page.set_viewport_size() 将调整页面大小。许多网站不希望手机改变大小，因此您应该在导航到页面之前设置视窗大小。 page.set_viewport_size() 也会重置 screen 大小，如果您需要更好地控制这些属性，请使用带有 screen 和 viewport 参数的 browser.new_context()。

用法

page = browser.new_page()
page.set_viewport_size({"width": 640, "height": 480})
page.goto("https://example.com")

参数

  • viewport_size Dict#

    • width int

      页面宽度，以像素为单位。

    • height int

      页面高度，以像素为单位。

返回值

title​

在 v1.9 之前添加 page.title

返回页面的标题。

用法

page.title()

返回值

unroute​

在 v1.9 之前添加 page.unroute

删除使用 page.route() 创建的路由。当未指定 handler 时，将删除 url 的所有路由。

用法

page.unroute(url)
page.unroute(url, **kwargs)

参数

返回值

unroute_all​

在: v1.41 中添加 page.unroute_all

移除所有使用 page.route() 和 page.route_from_har() 创建的路由。

用法

page.unroute_all()
page.unroute_all(**kwargs)

参数

  • behavior "wait" | "ignoreErrors" | "default" (可选)#

    指定是否等待正在运行的处理程序以及如果它们抛出错误该怎么办

    • 'default' - 不等待当前处理程序调用（如果有）完成，如果未路由的处理程序抛出，可能会导致未处理的错误
    • 'wait' - 等待当前处理程序调用（如果有）完成
    • 'ignoreErrors' - 不等待当前处理程序调用（如果有）完成，路由后处理程序抛出的所有错误都会被静默捕获

返回值

wait_for_event​

在 v1.9 之前添加 page.wait_for_event
注意

在大多数情况下，您应该使用 page.expect_event()。

等待给定的 event 触发。如果提供谓词，它将事件的值传递给 predicate 函数，并等待 predicate(event) 返回一个真值。如果在 event 触发之前页面关闭，则会抛出错误。

用法

page.wait_for_event(event)
page.wait_for_event(event, **kwargs)

参数

  • event 字符串#

    事件名称，与通常传递到 *.on(event) 中的名称相同。

  • predicate 可调用 (可选)#

    接收事件数据，并在等待应解决时解析为真值。

  • timeout 浮点 (可选)#

    最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。可以通过使用 browser_context.set_default_timeout() 更改默认值。

返回值

wait_for_function​

在 v1.9 之前添加 page.wait_for_function

当 表达式 返回真值时返回。它解析为真值 JSHandle。

用法

The page.wait_for_function() 可以用来观察视窗大小的变化

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch()
    page = browser.new_page()
    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
    page.wait_for_function("() => window.x > 0")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

要将参数传递给 page.wait_for_function() 函数的谓词

selector = ".foo"
page.wait_for_function("selector => !!document.querySelector(selector)", selector)

参数

  • expression 字符串#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg 评估参数 (可选)#

    可选参数，传递给 表达式。

  • polling 浮点 | "raf" (可选)#

    如果 轮询 是 'raf'，则 表达式 在 requestAnimationFrame 回调中不断执行。如果 轮询 是一个数字，则它被视为函数执行的毫秒间隔。默认值为 raf。

  • timeout 浮点 (可选)#

    最大等待时间，以毫秒为单位。默认值为 30000（30 秒）。传递 0 禁用超时。默认值可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

返回值

wait_for_load_state​

在 v1.9 之前添加 page.wait_for_load_state

到达所需的加载状态时返回。

当页面到达所需的加载状态时，这将解析，默认情况下为 load。调用此方法时，导航必须已提交。如果当前文档已达到所需状态，则立即解析。

注意

大多数情况下，此方法不需要，因为 Playwright 在每次操作之前自动等待。

用法

page.get_by_role("button").click() # click triggers navigation.
page.wait_for_load_state() # the promise resolves after "load" event.
with page.expect_popup() as page_info:
    page.get_by_role("button").click() # click triggers a popup.
popup = page_info.value
# Wait for the "DOMContentLoaded" event.
popup.wait_for_load_state("domcontentloaded")
print(popup.title()) # popup is ready to use.

参数

返回值

wait_for_url​

在以下版本中添加：v1.11 page.wait_for_url

等待主框架导航到给定的 URL。

用法

page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
page.wait_for_url("**/target.html")

参数

  • url 字符串 | 模式 | 可调用[URL]:布尔#

    一个 glob 模式、正则表达式模式或接受 URL 的谓词，以便在等待导航时匹配。请注意，如果参数是一个没有通配符的字符串，则该方法将等待导航到与该字符串完全相同的 URL。

  • timeout 浮点 (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

属性​

clock​

在以下版本中添加：v1.45 page.clock

Playwright 能够模拟时钟和时间流逝。

用法

page.clock

类型

context​

在 v1.9 之前添加 page.context

获取页面所属的浏览器上下文。

用法

page.context

返回值

frames​

在 v1.9 之前添加 page.frames

附加到页面的所有框架的数组。

用法

page.frames

返回值

is_closed​

在 v1.9 之前添加 page.is_closed

表示页面已关闭。

用法

page.is_closed()

返回值

keyboard​

在 v1.9 之前添加 page.keyboard

用法

page.keyboard

类型

main_frame​

在 v1.9 之前添加 page.main_frame

页面的主框架。页面保证有一个主框架，该框架在导航期间持续存在。

用法

page.main_frame

返回值

mouse​

在 v1.9 之前添加 page.mouse

用法

page.mouse

类型

request​

在以下版本中添加：v1.16 page.request

与该页面关联的 API 测试助手。此方法返回与页面上下文上的 browser_context.request 相同的实例。有关更多详细信息，请参阅 browser_context.request。

用法

page.request

类型

touchscreen​

在 v1.9 之前添加 page.touchscreen

用法

page.touchscreen

类型

url​

在 v1.9 之前添加 page.url

用法

page.url

返回值

video​

在 v1.9 之前添加 page.video

与该页面关联的视频对象。

用法

page.video

返回值

viewport_size​

在 v1.9 之前添加 page.viewport_size

用法

page.viewport_size

返回值

  • NoneType | Dict#

    • width int

      页面宽度，以像素为单位。

    • height int

      页面高度，以像素为单位。

workers​

在 v1.9 之前添加 page.workers

此方法返回与页面关联的所有专用 WebWorkers。

注意

不包含 ServiceWorkers。

用法

page.workers

返回值

事件​

on("close")​

在 v1.9 之前添加 page.on("close")

当页面关闭时发出。

用法

page.on("close", handler)

事件数据

on("console")​

在 v1.9 之前添加 page.on("console")

当页面内的 JavaScript 调用控制台 API 方法（例如 console.log 或 console.dir）时发出。

传递到 console.log 的参数在 ConsoleMessage 事件处理程序参数上可用。

用法

def print_args(msg):
    for arg in msg.args:
        print(arg.json_value())

page.on("console", print_args)
page.evaluate("console.log('hello', 5, { foo: 'bar' })")

事件数据

on("crash")​

在 v1.9 之前添加 page.on("crash")

当页面崩溃时发出。浏览器页面可能会在尝试分配太多内存时崩溃。当页面崩溃时，正在进行的操作和后续操作将抛出异常。

处理崩溃最常见的方法是捕获异常。

try:
    # crash might happen during a click.
    page.click("button")
    # or while waiting for an event.
    page.wait_for_event("popup")
except Error as e:
    pass
    # when the page crashes, exception message contains "crash".

用法

page.on("crash", handler)

事件数据

on("dialog")​

在 v1.9 之前添加 page.on("dialog")

当 JavaScript 对话框出现时发出，例如 alert、prompt、confirm 或 beforeunload。侦听器 **必须** 接受或 dialog.dismiss() 对话框 - 否则页面将 冻结 等待对话框，并且像点击这样的操作将永远不会完成。

用法

page.on("dialog", lambda dialog: dialog.accept())
注意

当没有 page.on("dialog") 或 browser_context.on("dialog") 侦听器存在时，所有对话框都会自动关闭。

事件数据

on("domcontentloaded")​

新增于：v1.9 page.on("domcontentloaded")

当 JavaScript DOMContentLoaded 事件分发时发出。

用法

page.on("domcontentloaded", handler)

事件数据

on("download")​

在 v1.9 之前添加 page.on("download")

当附件下载开始时发出。用户可以通过传递的 Download 实例访问下载内容的基本文件操作。

用法

page.on("download", handler)

事件数据

on("filechooser")​

新增于：v1.9 page.on("filechooser")

当文件选择器应该出现时发出，例如在单击 <input type=file> 之后。Playwright 可以通过使用 file_chooser.set_files() 来响应它，该方法可以在之后上传。

page.on("filechooser", lambda file_chooser: file_chooser.set_files("/tmp/myfile.pdf"))

用法

page.on("filechooser", handler)

事件数据

on("frameattached")​

新增于：v1.9 page.on("frameattached")

当框架附加时发出。

用法

page.on("frameattached", handler)

事件数据

on("framedetached")​

新增于：v1.9 page.on("framedetached")

当框架分离时发出。

用法

page.on("framedetached", handler)

事件数据

on("framenavigated")​

新增于：v1.9 page.on("framenavigated")

当框架导航到新 URL 时发出。

用法

page.on("framenavigated", handler)

事件数据

on("load")​

在 v1.9 之前添加 page.on("load")

当 JavaScript load 事件分发时发出。

用法

page.on("load", handler)

事件数据

on("pageerror")​

新增于：v1.9 page.on("pageerror")

当页面内发生未捕获的异常时发出。

# Log all uncaught errors to the terminal
page.on("pageerror", lambda exc: print(f"uncaught exception: {exc}"))

# Navigate to a page with an exception.
page.goto("data:text/html,<script>throw new Error('test')</script>")

用法

page.on("pageerror", handler)

事件数据

on("popup")​

在 v1.9 之前添加 page.on("popup")

当页面打开新选项卡或窗口时发出。此事件除了 browser_context.on("page") 之外还会发出，但仅针对与该页面相关的弹出窗口。

页面可用的最早时间是在其导航到初始 URL 时。例如，当使用 window.open('http://example.com') 打开弹出窗口时，此事件将在对 "http://example.com" 的网络请求完成后并且其响应开始在弹出窗口中加载时触发。如果您想路由/监听此网络请求，请使用 browser_context.route() 和 browser_context.on("request") 分别代替 Page 上的类似方法。

with page.expect_event("popup") as page_info:
    page.get_by_text("open the popup").click()
popup = page_info.value
print(popup.evaluate("location.href"))
注意

使用 page.wait_for_load_state() 等待页面进入特定状态（在大多数情况下您应该不需要它）。

用法

page.on("popup", handler)

事件数据

on("request")​

在 v1.9 之前添加 page.on("request")

当页面发出请求时发出。该 request 对象是只读的。要拦截和修改请求，请参阅 page.route() 或 browser_context.route()。

用法

page.on("request", handler)

事件数据

on("requestfailed")​

新增于：v1.9 page.on("requestfailed")

当请求失败时发出，例如由于超时。

page.on("requestfailed", lambda request: print(request.url + " " + request.failure.error_text))
注意

HTTP 错误响应（例如 404 或 503）从 HTTP 角度来看仍然是成功的响应，因此请求将使用 page.on("requestfinished") 事件完成，而不是使用 page.on("requestfailed")。只有当客户端无法从服务器获取 HTTP 响应时（例如由于网络错误 net::ERR_FAILED），请求才会被视为失败。

用法

page.on("requestfailed", handler)

事件数据

on("requestfinished")​

新增于：v1.9 page.on("requestfinished")

当请求在下载响应主体后成功完成时发出。对于成功响应，事件顺序为 request、response 和 requestfinished。

用法

page.on("requestfinished", handler)

事件数据

on("response")​

在 v1.9 之前添加 page.on("response")

当请求的 response 状态和标头被接收时发出。对于成功响应，事件顺序为 request、response 和 requestfinished。

用法

page.on("response", handler)

事件数据

on("websocket")​

新增于：v1.9 page.on("websocket")

当 WebSocket 请求被发送时发出。

用法

page.on("websocket", handler)

事件数据

on("worker")​

在 v1.9 之前添加 page.on("worker")

当页面生成专用 WebWorker 时发出。

用法

page.on("worker", handler)

事件数据

已弃用​

accessibility​

在 v1.9 之前添加 page.accessibility
已弃用

不建议使用此属性。如果您需要测试页面可访问性，请使用其他库，例如 Axe。有关与 Axe 集成的信息，请参阅我们的 Node.js 指南。

用法

page.accessibility

类型

check​

在 v1.9 之前添加 page.check
不建议

使用基于定位器的 locator.check() 替代。详细了解 定位器。

此方法通过执行以下步骤来检查与 selector 匹配的元素。

  1. 查找与 selector 匹配的元素。如果没有，请等待与 DOM 附加的匹配元素。
  2. 确保匹配的元素是复选框或单选按钮。如果不是，此方法将抛出异常。如果元素已被选中，此方法将立即返回。
  3. 等待对匹配元素的 操作性 检查，除非设置了 force 选项。如果元素在检查期间分离，整个操作将被重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 在元素的中心单击。
  6. 确保元素现在已被选中。如果不是，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

page.check(selector)
page.check(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • force bool (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)在以下版本中添加：v1.11#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置此方法时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回值

click​

在 v1.9 之前添加 page.click
不建议

使用基于定位器的 locator.click() 代替。了解更多关于 定位器 的信息。

此方法通过以下步骤点击匹配 选择器 的元素：

  1. 查找匹配 选择器 的元素。如果不存在，则等待匹配元素附加到 DOM。
  2. 等待匹配元素上的 可操作性 检查，除非设置了 强制 选项。如果元素在检查期间被分离，则整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 点击元素的中心，或指定的 位置。
  5. 等待已启动的导航成功或失败，除非设置了 no_wait_after 选项。

如果所有步骤组合在指定的 超时 时间内未完成，此方法将抛出一个 TimeoutError。传递零超时将禁用此功能。

用法

page.click(selector)
page.click(selector, **kwargs)

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • button "left" | "right" | "middle" (可选)#

    默认值为 left。

  • click_count 整数 (可选)#

    默认值为 1。参见 UIEvent.detail。

  • delay 浮点数 (可选)#

    在 mousedown 和 mouseup 之间等待的时间，以毫秒为单位。默认值为 0。

  • force 布尔值 (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • modifiers 列表["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

    要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项将在未来默认设置为 true。

    启动导航的操作会等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择退出等待。您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。默认值为 false。

  • position 字典 (可选)#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置时，此方法只执行 可操作性 检查并跳过操作。默认值为 false。在不执行操作的情况下等待元素准备好操作时很有用。请注意，键盘 modifiers 将始终被按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

dblclick​

在 v1.9 之前添加 page.dblclick
不建议

使用基于定位器的 locator.dblclick() 代替。了解更多关于 定位器 的信息。

此方法通过以下步骤双击匹配 选择器 的元素：

  1. 查找匹配 选择器 的元素。如果不存在，则等待匹配元素附加到 DOM。
  2. 等待匹配元素上的 可操作性 检查，除非设置了 强制 选项。如果元素在检查期间被分离，则整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 双击元素的中心，或指定的 位置。

如果所有步骤组合在指定的 超时 时间内未完成，此方法将抛出一个 TimeoutError。传递零超时将禁用此功能。

注意

page.dblclick() 分派两个 click 事件和一个 dblclick 事件。

用法

page.dblclick(selector)
page.dblclick(selector, **kwargs)

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • button "left" | "right" | "middle" (可选)#

    默认值为 left。

  • delay 浮点数 (可选)#

    在 mousedown 和 mouseup 之间等待的时间，以毫秒为单位。默认值为 0。

  • force 布尔值 (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • modifiers 列表["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

    要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position 字典 (可选)#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置时，此方法只执行 可操作性 检查并跳过操作。默认值为 false。在不执行操作的情况下等待元素准备好操作时很有用。请注意，键盘 modifiers 将始终被按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

dispatch_event​

在 v1.9 之前添加 page.dispatch_event
不建议

使用基于定位器的 locator.dispatch_event() 代替。了解更多关于 定位器 的信息。

以下代码片段在元素上分派 click 事件。无论元素的可见性状态如何，都会分派 click。这等同于调用 element.click()。

用法

page.dispatch_event("button#submit", "click")

在幕后，它根据给定的 类型 创建一个事件实例，用 event_init 属性初始化它，并在元素上分派它。事件默认情况下是 composed、cancelable 并且冒泡。

由于 event_init 是特定于事件的，请参考事件文档以获取初始属性列表

您也可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中

# note you can only create data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
page.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • type 字符串#

    DOM 事件类型："click"、"dragstart" 等。

  • event_init 评估参数 (可选)#

    可选的特定于事件的初始化属性。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

eval_on_selector​

新增于：v1.9 page.eval_on_selector
不建议

此方法不会等待元素通过可操作性检查，因此可能会导致测试不稳定。使用 locator.evaluate()、其他 定位器 辅助方法或 web-first 断言代替。

该方法在页面内查找与指定选择器匹配的元素，并将该元素作为第一个参数传递给 表达式。如果没有任何元素与选择器匹配，该方法会抛出错误。返回 表达式 的值。

如果 表达式 返回一个 Promise，那么 page.eval_on_selector() 将等待 Promise 解析并返回其值。

用法

search_value = page.eval_on_selector("#search", "el => el.value")
preload_href = page.eval_on_selector("link[rel=preload]", "el => el.href")
html = page.eval_on_selector(".main-container", "(e, suffix) => e.outer_html + suffix", "hello")

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 表达式 的可选参数。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

eval_on_selector_all​

新增于：v1.9 page.eval_on_selector_all
不建议

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 Web 首要断言能更好地完成这项工作。

该方法在页面内查找与指定选择器匹配的所有元素，并将匹配元素数组作为第一个参数传递给 表达式。返回 表达式 调用结果。

如果 表达式 返回一个 Promise，那么 page.eval_on_selector_all() 将等待 Promise 解析并返回其值。

用法

div_counts = page.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 表达式 的可选参数。

返回值

expect_navigation​

在 v1.9 之前添加 page.expect_navigation
已弃用

此方法本质上是竞争性的，请改用 page.wait_for_url()。

等待主框架导航并返回主资源响应。如果出现多个重定向，导航将以最后一个重定向的响应解析。如果导航到不同的锚点或由于使用历史记录 API 导致导航，导航将以 null 解析。

用法

当页面导航到新 URL 或重新加载时，这将解析。当您运行将间接导致页面导航的代码时，这很有用。例如，点击目标具有一个 onclick 处理程序，该处理程序会触发来自 setTimeout 的导航。请考虑以下示例

with page.expect_navigation():
    # This action triggers the navigation after a timeout.
    page.get_by_text("Navigate after timeout").click()
# Resolves after navigation has finished
注意

使用 历史记录 API 更改 URL 被视为导航。

参数

  • timeout float (可选)#

    以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。默认值可以使用browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法进行更改。

  • url str | Pattern | Callable[URL]:bool (可选)#

    一个 glob 模式、正则表达式模式或接受 URL 的谓词，以便在等待导航时匹配。请注意，如果参数是一个没有通配符的字符串，则该方法将等待导航到与该字符串完全相同的 URL。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功，默认为 load。事件可以是以下任一事件

    • 'domcontentloaded' - 在触发 DOMContentLoaded 事件后，认为操作已完成。
    • 'load' - 在触发 load 事件后，认为操作已完成。
    • 'networkidle' - 不建议在至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 Web 断言来评估准备就绪状态。
    • 'commit' - 在收到网络响应并开始加载文档后，认为操作已完成。

返回值

fill​

在 v1.9 之前添加 page.fill
不建议

请改用基于定位器的 locator.fill()。详细了解 定位器。

此方法等待与 选择器 匹配的元素，等待 操作能力 检查，聚焦该元素，将其填入并填入后触发 input 事件。请注意，您可以传递空字符串来清除输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法会抛出错误。但是，如果该元素位于与 控件 关联的 <label> 元素内，则将改为填充控件。

若要发送细粒度的键盘事件，请使用 locator.press_sequentially()。

用法

page.fill(selector, value)
page.fill(selector, value, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • value str#

    要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。

  • force bool (可选)新增于：v1.13#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

focus​

在 v1.9 之前添加 page.focus
不建议

请改用基于定位器的 locator.focus()。详细了解 定位器。

此方法使用 选择器 获取元素并聚焦它。如果没有任何元素与 选择器 匹配，则该方法将等待直到 DOM 中出现匹配元素。

用法

page.focus(selector)
page.focus(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

get_attribute​

在 v1.9 之前添加 page.get_attribute
不建议

请改用基于定位器的 locator.get_attribute()。详细了解 定位器。

返回元素属性值。

用法

page.get_attribute(selector, name)
page.get_attribute(selector, name, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • name str#

    要获取值的属性名称。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

hover​

在 v1.9 之前添加 page.hover
不建议

请改用基于定位器的 locator.hover()。详细了解 定位器。

此方法通过执行以下步骤将鼠标悬停在与 选择器 匹配的元素上

  1. 查找与 选择器 匹配的元素。如果没有，则等待直到将匹配元素附加到 DOM。
  2. 等待 操作能力 检查匹配的元素，除非设置了 force 选项。如果元素在检查期间分离，则将重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 将鼠标悬停在元素的中心，或者指定的 位置 上。

当所有步骤的组合在指定的 timeout 内尚未完成时，此方法会抛出一个 TimeoutError。传递零超时将禁用此功能。

用法

page.hover(selector)
page.hover(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • force bool (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

    要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

  • no_wait_after bool (可选)添加时间: v1.28#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置时，此方法只执行 可操作性 检查并跳过操作。默认值为 false。在不执行操作的情况下等待元素准备好操作时很有用。请注意，键盘 modifiers 将始终被按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

inner_html​

在 v1.9 之前添加 page.inner_html
不建议

使用基于定位器的 locator.inner_html() 代替。详细了解 定位器。

返回 element.innerHTML。

用法

page.inner_html(selector)
page.inner_html(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

inner_text​

在 v1.9 之前添加 page.inner_text
不建议

使用基于定位器的 locator.inner_text() 代替。详细了解 定位器。

返回 element.innerText。

用法

page.inner_text(selector)
page.inner_text(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

input_value​

新增于：v1.13 page.input_value
不建议

使用基于定位器的 locator.input_value() 代替。详细了解 定位器。

返回所选 <input> 或 <textarea> 或 <select> 元素的 input.value。

对非输入元素抛出异常。但是，如果元素在具有关联 control 的 <label> 元素内，则返回 control 的值。

用法

page.input_value(selector)
page.input_value(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

is_checked​

在 v1.9 之前添加 page.is_checked
不建议

使用基于定位器的 locator.is_checked() 代替。详细了解 定位器。

返回元素是否被选中。如果元素不是复选框或单选按钮输入，则抛出异常。

用法

page.is_checked(selector)
page.is_checked(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

is_disabled​

在 v1.9 之前添加 page.is_disabled
不建议

使用基于定位器的 locator.is_disabled() 代替。详细了解 定位器。

返回元素是否被禁用，与 enabled 相反。

用法

page.is_disabled(selector)
page.is_disabled(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

is_editable​

在 v1.9 之前添加 page.is_editable
不建议

使用基于定位器的 locator.is_editable() 代替。详细了解 定位器。

返回元素是否 可编辑。

用法

page.is_editable(selector)
page.is_editable(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

is_enabled​

在 v1.9 之前添加 page.is_enabled
不建议

使用基于定位器的 locator.is_enabled() 代替。详细了解 定位器。

返回元素是否 已启用。

用法

page.is_enabled(selector)
page.is_enabled(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

is_hidden​

在 v1.9 之前添加 page.is_hidden
不建议

使用基于定位器的 locator.is_hidden() 代替。详细了解 定位器。

返回元素是否隐藏，与 visible 相反。不匹配任何元素的 selector 被认为是隐藏的。

用法

page.is_hidden(selector)
page.is_hidden(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    已弃用

    此选项被忽略。 page.is_hidden() 不会等待元素变为隐藏，并立即返回。

返回值

is_visible​

在 v1.9 之前添加 page.is_visible
不建议

使用基于定位器的 locator.is_visible() 代替。详细了解 定位器。

返回元素是否 可见。不匹配任何元素的 selector 被认为是不可见的。

用法

page.is_visible(selector)
page.is_visible(selector, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    已弃用

    此选项被忽略。 page.is_visible() 不会等待元素变为可见，并立即返回。

返回值

press​

在 v1.9 之前添加 page.press
不建议

使用基于定位器的 locator.press() 代替。详细了解 定位器。

使元素获得焦点，然后使用 keyboard.down() 和 keyboard.up()。

key 可以指定预期的 keyboardEvent.key 值或要生成的文本的单个字符。可以在 key 值的超集中找到 这里。键的示例有

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp 等。

以下修改快捷键也受支持：Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 将键入与 key 对应的文本，以大写形式。

如果 key 是单个字符，则区分大小写，因此值 a 和 A 将生成不同的文本。

也支持 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 等快捷键。如果与修饰符一起指定，则在按下后续键时，修饰符会一直被按下。

用法

page = browser.new_page()
page.goto("https://keycode.info")
page.press("body", "A")
page.screenshot(path="a.png")
page.press("body", "ArrowLeft")
page.screenshot(path="arrow_left.png")
page.press("body", "Shift+O")
page.screenshot(path="o.png")
browser.close()

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • key str#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • delay float (可选)#

    keydown 和 keyup 之间等待的时间（以毫秒为单位）。默认为 0。

  • no_wait_after bool (可选)#

    已弃用

    此选项将在未来默认设置为 true。

    启动导航的操作会等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择退出等待。您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。默认值为 false。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

query_selector​

新增于：v1.9 page.query_selector
不建议

使用基于定位器的 page.locator() 代替。详细了解 定位器。

此方法查找页面中与指定选择器匹配的元素。如果没有任何元素与选择器匹配，则返回值解析为 null。要等待页面上的元素，请使用 locator.wait_for()。

用法

page.query_selector(selector)
page.query_selector(selector, **kwargs)

参数

  • selector str#

    要查询的选择器。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

query_selector_all​

新增于：v1.9 page.query_selector_all
不建议

使用基于定位器的 page.locator() 代替。详细了解 定位器。

此方法查找页面中与指定选择器匹配的所有元素。如果没有任何元素与选择器匹配，则返回值解析为 []。

用法

page.query_selector_all(selector)

参数

  • selector str#

    要查询的选择器。

返回值

select_option​

在 v1.9 之前添加 page.select_option
不建议

使用基于定位器的 locator.select_option() 代替。详细了解 定位器。

此方法等待与 selector 匹配的元素，等待 操作性 检查，等待直到 <select> 元素中存在所有指定的选项，然后选择这些选项。

如果目标元素不是 <select> 元素，则此方法会抛出错误。但是，如果元素位于具有关联 控制 的 <label> 元素内，则会改用控制。

返回已成功选择的选项值的数组。

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

用法

# Single selection matching the value or label
page.select_option("select#colors", "blue")
# single selection matching both the label
page.select_option("select#colors", label="blue")
# multiple selection
page.select_option("select#colors", value=["red", "green", "blue"])

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • force bool (可选)新增于：v1.13#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • element ElementHandle | List[ElementHandle] (可选)#

    要选择的选项元素。可选。

  • index int | List[int] (可选)#

    要按索引选择的选项。可选。

  • value str | List[str] (可选)#

    要按值选择的选项。如果 <select> 具有 multiple 属性，则会选择所有给定的选项，否则仅选择与传递的选项之一匹配的第一个选项。可选。

  • label str | List[str] (可选)#

    要按标签选择的选项。如果 <select> 具有 multiple 属性，则会选择所有给定的选项，否则仅选择与传递的选项之一匹配的第一个选项。可选。

返回值

set_checked​

新增于：v1.15 page.set_checked
不建议

使用基于定位器的 locator.set_checked() 代替。详细了解 定位器。

此方法通过执行以下步骤来选中或取消选中与 selector 匹配的元素

  1. 查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选按钮。如果不是，则此方法会抛出异常。
  3. 如果元素已经具有正确的选中状态，则此方法会立即返回。
  4. 等待匹配元素上的 操作性 检查，除非设置了 force 选项。如果在检查期间元素分离，则整个操作会重试。
  5. 如果需要，将元素滚动到视图中。
  6. 使用 page.mouse 在元素的中心单击。
  7. 确保元素现在已选中或取消选中。如果不是，则此方法会抛出异常。

如果所有步骤组合在指定的 timeout 内尚未完成，则此方法会抛出 TimeoutError。传递零超时会禁用此功能。

用法

page.set_checked(selector, checked)
page.set_checked(selector, checked, **kwargs)

参数

  • selector str#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • checked bool#

    是否选中或取消选中复选框。

  • force bool (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)#

    当设置此方法时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回值

set_input_files​

在 v1.9 之前添加 page.set_input_files
不建议

使用基于定位器的 locator.set_input_files() 代替。了解更多关于 定位器 的信息。

将文件输入的值设置为这些文件路径或文件。如果一些 filePaths 是相对路径，那么它们将相对于当前工作目录解析。对于空数组，清除所选文件。对于具有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

此方法期望 选择器 指向一个 输入元素。但是，如果该元素位于具有关联 控制 的 <label> 元素内，则改为定位该控制。

用法

page.set_input_files(selector, files)
page.set_input_files(selector, files, **kwargs)

参数

返回值

tap​

在 v1.9 之前添加 page.tap
不建议

使用基于定位器的 locator.tap() 代替。了解更多关于 定位器 的信息。

此方法通过执行以下步骤来点击匹配 选择器 的元素

  1. 查找匹配 选择器 的元素。如果没有，则等待匹配元素附加到 DOM。
  2. 等待匹配元素上的 可操作性 检查，除非设置了 force 选项。如果元素在检查期间被分离，则整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.touchscreen 点击元素的中心或指定的 位置。

当所有步骤组合起来在指定的 超时 内未完成时，此方法会抛出一个 TimeoutError。传入零超时将禁用此功能。

注意

page.tap() 方法将在浏览器上下文的 has_touch 选项为 false 时抛出异常。

用法

page.tap(selector)
page.tap(selector, **kwargs)

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • force 布尔值 (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • modifiers 列表["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

    要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position 字典 (可选)#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置时，此方法只执行 可操作性 检查并跳过操作。默认值为 false。在不执行操作的情况下等待元素准备好操作时很有用。请注意，键盘 modifiers 将始终被按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

text_content​

在 v1.9 之前添加 page.text_content
不建议

使用基于定位器的 locator.text_content() 代替。了解更多关于 定位器 的信息。

返回 element.textContent。

用法

page.text_content(selector)
page.text_content(selector, **kwargs)

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

type​

在 v1.9 之前添加 page.type
已弃用

在大多数情况下，您应该使用 locator.fill() 代替。您只需要在页面上有特殊的键盘处理时才需要逐个按下键 - 在这种情况下，使用 locator.press_sequentially()。

为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。page.type 可用于发送细粒度的键盘事件。要填充表单字段的值，请使用 page.fill()。

要按下特殊键，例如 Control 或 ArrowDown，请使用 keyboard.press()。

用法

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • text 字符串#

    要键入到已聚焦元素中的文本。

  • delay 浮点数 (可选)#

    按键之间等待的时间，以毫秒为单位。默认值为 0。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout 浮点数 (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

uncheck​

在 v1.9 之前添加 page.uncheck
不建议

使用基于定位器的 locator.uncheck() 代替。了解更多关于 定位器 的信息。

此方法通过执行以下步骤来取消选中匹配 选择器 的元素

  1. 查找匹配 选择器 的元素。如果没有，则等待匹配元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选按钮。如果不是，则此方法会抛出异常。如果该元素已被取消选中，则此方法立即返回。
  3. 等待匹配元素上的 可操作性 检查，除非设置了 force 选项。如果元素在检查期间被分离，则整个操作将重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 在元素的中心单击。
  6. 确保该元素现在已被取消选中。如果不是，则此方法会抛出异常。

当所有步骤组合起来在指定的 超时 内未完成时，此方法会抛出一个 TimeoutError。传入零超时将禁用此功能。

用法

page.uncheck(selector)
page.uncheck(selector, **kwargs)

参数

  • selector 字符串#

    用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。

  • force 布尔值 (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)在以下版本中添加：v1.11#

    相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

  • trial 布尔值 (可选)在以下版本中添加：v1.11#

    当设置此方法时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回值

wait_for_selector​

在 v1.9 之前添加 page.wait_for_selector
不建议

使用断言可见性或基于定位器的 locator.wait_for() 的 Web 断言代替。了解更多关于 定位器 的信息。

当由选择器指定的元素满足 状态 选项时返回。如果等待 hidden 或 detached，则返回 null。

注意

Playwright 会自动等待元素准备好，然后再执行操作。使用 Locator 对象和 Web 首要断言使代码无需等待选择器。

等待 选择器 满足 状态 选项（出现在 DOM 中/从 DOM 中消失，或变为可见/隐藏）。如果在调用方法时，选择器 已经满足条件，该方法将立即返回。如果选择器在 超时 毫秒内没有满足条件，则该函数将抛出异常。

用法

此方法在导航之间有效

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = chromium.launch()
    page = browser.new_page()
    for current_url in ["https://google.com", "https://bbc.com"]:
        page.goto(current_url, wait_until="domcontentloaded")
        element = page.wait_for_selector("img")
        print("Loaded image: " + str(element.get_attribute("src")))
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

参数

  • selector str#

    要查询的选择器。

  • state "attached" | "detached" | "visible" | "hidden" (可选)#

    默认为 'visible'。可以是以下之一：

    • 'attached' - 等待元素出现在 DOM 中。
    • 'detached' - 等待元素不再出现在 DOM 中。
    • 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空边界框，并且不被视为可见。
    • 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。

  • strict bool (可选)新增于：v1.14#

    如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。

返回值

wait_for_timeout​

在 v1.9 之前添加 page.wait_for_timeout
不建议

不要在生产环境中等待超时。等待时间的测试本质上是不可靠的。使用 Locator 操作和自动等待的 Web 断言。

等待指定的 超时（以毫秒为单位）。

请注意，page.waitForTimeout() 仅应用于调试。在生产环境中使用计时器的测试将不可靠。请改用信号，例如网络事件、选择器变得可见和其他信号。

用法

# wait for 1 second
page.wait_for_timeout(1000)

参数

  • timeout float#

    要等待的超时时间

返回值