跳到主要内容

Page

Page 提供与 Browser 中的单个 tab 页或 Chromium 中的 extension background page 进行交互的方法。一个 Browser 实例可能拥有多个 Page 实例。

此示例创建一个页面，导航到 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

添加将在以下场景中评估的脚本

  • 页面导航时。
  • 子 frame 附加或导航时。在这种情况下，脚本将在新附加 frame 的上下文中进行评估。

脚本在文档创建后但在任何脚本运行之前进行评估。这对于修改 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] (optional)#

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

  • script str (optional)#

    要在浏览器上下文的所有页面中进行评估的脚本。可选。

返回值

add_locator_handler​

添加于: v1.42 page.add_locator_handler

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

此方法允许您设置一个特殊函数，称为处理程序 (handler)，当检测到覆盖层可见时，它就会被激活。处理程序的作用是移除覆盖层，让您的测试能够继续，就像覆盖层不存在一样。

需要注意的事项

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

运行处理程序会改变测试中的页面状态。例如，它会改变当前获得焦点的元素并移动鼠标。请确保处理程序后运行的操作是自包含的，并且不依赖于焦点和鼠标状态保持不变。

例如，考虑一个调用 locator.focus() 后跟 keyboard.press() 的测试。如果处理程序在这两个操作之间点击了一个按钮，获得焦点的元素很可能是错误的，并且按键操作将作用于意料之外的元素。请改用 locator.press() 来避免此问题。

另一个示例是一系列鼠标操作，其中 mouse.move() 后跟 mouse.down()。同样，当处理程序在这两个操作之间运行时，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()

一个自定义回调在每次 actionability check 时执行的示例。它使用一个始终可见的 <body> locator，因此处理程序在每次 actionability check 之前都会被调用。重要的是指定 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()

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

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

参数

  • locator Locator#

    触发处理程序的 locator。

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

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

  • no_wait_after bool (optional)添加于: v1.44#

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

  • times int (optional)添加于: v1.44#

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

返回值

add_script_tag​

在 v1.9 版本之前添加 page.add_script_tag

在页面中添加一个带有所需 url 或 content 的 <script> 标签。当脚本的 onload 事件触发或脚本内容注入 frame 后，返回添加的标签。

用法

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

参数

  • content str (optional)#

    要注入 frame 的原始 JavaScript 内容。

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

    要注入 frame 的 JavaScript 文件路径。如果 path 是相对路径，则它相对于当前工作目录进行解析。

  • type str (optional)#

    脚本类型。使用 'module' 以加载 JavaScript ES6 模块。更多详情请参阅 script。

  • url str (optional)#

    要添加的脚本的 URL。

返回值

add_style_tag​

在 v1.9 版本之前添加 page.add_style_tag

在页面中添加一个带有所需 url 的 <link rel="stylesheet"> 标签或一个带有所需 content 的 <style type="text/css"> 标签。当样式表的 onload 事件触发或 CSS 内容注入 frame 后，返回添加的标签。

用法

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

参数

  • content str (optional)#

    要注入 frame 的原始 CSS 内容。

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

    要注入 frame 的 CSS 文件路径。如果 path 是相对路径，则它相对于当前工作目录进行解析。

  • url str (optional)#

    <link> 标签的 URL。

返回值

bring_to_front​

在 v1.9 版本之前添加 page.bring_to_front

将页面带到最前面（激活 tab 页）。

用法

page.bring_to_front()

返回值

close​

在 v1.9 版本之前添加 page.close

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

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

注意

如果将 run_before_unload 设置为 true，可能会弹出 beforeunload 对话框，应通过 page.on("dialog") 事件手动处理。

用法

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

参数

  • reason str (optional)添加于: v1.40#

    页面关闭中断的操作将报告的原因。

  • run_before_unload bool (optional)#

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

返回值

content​

在 v1.9 版本之前添加 page.content

获取页面的完整 HTML 内容，包括 doctype。

用法

page.content()

返回值

drag_and_drop​

添加于: v1.13 page.drag_and_drop

此方法将 source 元素拖动到 target 元素。它会首先移动到 source 元素，执行 mousedown，然后移动到 target 元素并执行 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#

    要搜索用于拖动的元素的 selector。如果存在多个满足 selector 的元素，则使用第一个。

  • target str#

    要搜索用于放置的元素的 selector。如果存在多个满足 selector 的元素，则使用第一个。

  • force bool (optional)#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (optional)#

    已废弃

    此选项无效。

    此选项无效。

  • source_position Dict (optional)添加于: v1.14#

    在 source 元素的这个点相对于元素 padding box 的左上角进行点击。如果未指定，则使用元素的某个可见点。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • target_position Dict (optional)添加于: v1.14#

    在 target 元素的这个点相对于元素 padding box 的左上角进行放置。如果未指定，则使用元素的某个可见点。

  • timeout float (optional)#

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

  • trial bool (optional)#

    设置后，此方法仅执行 actionability checks 并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。

返回值

emulate_media​

在 v1.9 版本之前添加 page.emulate_media

此方法通过 media 参数更改 CSS media type，并通过 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

参数

  • color_scheme "light" | "dark" | "no-preference" | "null" (optional)添加于: v1.9#

    模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。传入 'Null' 将禁用 color scheme 模拟。'no-preference' 已废弃。

  • contrast "no-preference" | "more" | "null" (optional)添加于: v1.51#

  • forced_colors "active" | "none" | "null" (optional)添加于: v1.15#

  • media "screen" | "print" | "null" (optional)添加于: v1.9#

    更改页面的 CSS media type。只允许的值为 'Screen'、'Print' 和 'Null'。传入 'Null' 将禁用 CSS media 模拟。

  • reduced_motion "reduce" | "no-preference" | "null" (optional)添加于: v1.12#

    模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。传入 null 将禁用 reduced motion 模拟。

返回值

evaluate​

在 v1.9 版本之前添加 page.evaluate

返回 expression 调用结果的值。

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

如果传递给 page.evaluate() 的函数返回一个非 Serializable 值，则 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 (optional)#

    可选参数，用于传递给 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 (optional)#

    可选参数，用于传递给 expression。

返回值

expect_console_message​

添加于: v1.9 page.expect_console_message

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

用法

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

参数

返回值

expect_download​

添加于: v1.9 page.expect_download

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

用法

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

参数

返回值

expect_event​

在 v1.9 版本之前添加 page.expect_event

等待事件触发，并将其值传递给 predicate 函数。当 predicate 返回真值时返回。如果在事件触发前页面关闭，则会抛出错误。返回事件数据值。

用法

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 创建。如果提供了 predicate，则会将 FileChooser 的值传递给 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开前页面关闭，则会抛出错误。

用法

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

参数

返回值

expect_popup​

添加于: v1.9 page.expect_popup

执行动作并等待弹出窗口 Page。如果提供了 predicate，则会将 [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

参数

  • url_or_predicate str | Pattern | Callable[Request]:bool#

    请求 URL 字符串、正则表达式或接收 Request 对象的 predicate。如果在上下文选项中提供了 base_url 且传入的 URL 是路径，则会通过 new URL() 构造函数进行合并。

  • timeout float （可选）#

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

返回值

expect_request_finished​

添加于: v1.12 page.expect_request_finished

执行动作并等待 Request 完成加载。如果提供了 predicate，则会将 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。如果提供了 predicate，则会将 WebSocket 的值传递给 predicate 函数，并等待 predicate(webSocket) 返回真值。如果在 WebSocket 事件触发前页面关闭，则会抛出错误。

用法

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

参数

返回值

expect_worker​

添加于: v1.9 page.expect_worker

执行动作并等待新的 Worker。如果提供了 predicate，则会将 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#

    窗口对象上的函数名称。

  • callback Callable#

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

  • handle bool （可选）#

    已废弃

    此选项将来会被移除。

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

返回值

expose_function​

在 v1.9 版本之前添加 page.expose_function

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

如果 callback 返回一个 Promise，则会等待其完成。

有关上下文范围的 exposed function，请参阅 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#

    窗口对象上的函数名称

  • 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 对象的 predicate。可选。

返回值

frame_locator​

添加于：v1.17 page.frame_locator

在使用 iframe 时，可以创建一个框架定位器来进入 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 元素的 selector。

返回值

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

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

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="name@example.com" />

您可以通过 placeholder 文本定位输入框并填充它

page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool （可选）#

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

返回值

get_by_role​

添加于：v1.27 page.get_by_role

允许通过元素的 ARIA role、ARIA 属性和可访问名称定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过其隐含的 role 定位每个元素

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 role。

  • 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 定义的非隐藏元素才会被 role selector 匹配。

    了解更多关于 aria-hidden。

  • level int （可选）#

    通常用于 heading、listitem、row、treeitem 等 role 的数字属性，<h1>-<h6> 元素有默认值。

    了解更多关于 aria-level。

  • name str | Pattern （可选）#

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

    了解更多关于可访问名称。

  • pressed bool （可选）#

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

    了解更多关于 aria-pressed。

  • selected bool （可选）#

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

    了解更多关于 aria-selected。

返回值

详细信息

Role selector 不能替代 可访问性审计和一致性测试，但可以提供关于 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()

参数

返回值

详细信息

默认情况下，将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 | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

详细信息

按文本匹配总是会规范化空白字符，即使是精确匹配也是如此。例如，它会将多个空格变成一个，将换行符变成空格，并忽略开头和结尾的空白字符。

类型为button和submit的输入元素通过它们的value进行匹配，而不是文本内容。例如，按文本"Log in"定位会匹配<input type=button value="Log in">。

get_by_title​

添加于：v1.27 page.get_by_title

允许根据元素的 title 属性进行定位。

用法

考虑以下 DOM 结构。

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

在根据 title 文本定位元素后，您可以检查问题计数

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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • 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 "Not Found" 和 500 "Internal Server Error"。可以通过调用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 元素的 selector。

  • has Locator (可选)#

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

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

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

  • has_not Locator (可选)新增于: v1.33#

    匹配不包含匹配内部定位器的元素的那些元素。内部定位器是相对于外部定位器查询的。例如，不具有div的article会匹配<article><span>Playwright</span></article>。

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

  • has_not_text str | Pattern (可选)新增于: v1.33#

    匹配不包含内部指定文本的元素，可能在子元素或后代元素中。传入 [string] 时，匹配不区分大小写并搜索子字符串。

  • has_text str | Pattern (可选)#

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

返回值

opener​

在 v1.9 版本之前添加 page.opener

对于弹出页面，返回其 opener；对于其他页面，返回null。如果 opener 已经关闭，则返回null。

用法

page.opener()

返回值

pause​

添加于: v1.9 page.pause

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

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

注意

此方法要求 Playwright 在有头模式下启动，并且headless选项为假值。

用法

page.pause()

返回值

pdf​

在 v1.9 版本之前添加 page.pdf

返回 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是相对路径，则它会相对于当前工作目录解析。如果没有提供 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 Worker 拦截的请求。请参阅此 issue。我们建议在使用请求拦截时通过将service_workers设置为'block'来禁用 Service Workers。

注意

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

可以检查请求来决定路由操作。例如，模拟所有包含某些 POST 数据的请求，并保留所有其他请求不变。

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 (optional)添加于: v1.15#

    路由应被使用多少次。默认情况下，它将被每次使用。

返回值

route_from_har​

新增于: v1.23 page.route_from_har

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

Playwright 不会从 HAR 文件提供 Service Worker 拦截的请求。请参阅此 issue。我们建议在使用请求拦截时通过将service_workers设置为'block'来禁用 Service Workers。

用法

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 路由所需的信息。这会省略大小、时间、页面、cookies、安全以及其他类型的 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)

参数

返回值

截图​

在 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 (可选)#

    为 true 时，截取整个可滚动页面的截图，而不是当前可见视口的截图。默认为 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#

    最大时间（毫秒）。传入 0 禁用超时。

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 函数，并等待 predicate(event) 返回一个真值。如果在 event 触发之前页面关闭，将抛出错误。

用法

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

参数

  • event str#

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

  • predicate Callable (可选)#

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

  • timeout float (可选)#

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

返回值

wait_for_function​

在 v1.9 版本之前添加 page.wait_for_function

当 expression 返回一个真值时返回。它解析为真值的 JSHandle。

用法

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() 函数的 predicate 传递参数

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

参数

  • expression str#

    要在浏览器上下文中进行评估的 JavaScript 表达式。如果表达式评估为函数，则自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • polling float | "raf" (可选)#

    如果 polling 为 `"raf"`，则 expression 会在 requestAnimationFrame 回调中持续执行。如果 polling 是一个数字，则它被视为函数执行的间隔（毫秒）。默认为 raf。

  • timeout float (可选)#

    最大等待时间（毫秒）。默认为 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.

参数

  • state "load" | "domcontentloaded" | "networkidle" (可选)#

    可选的等待加载状态，默认为 load。如果在加载当前文档时已达到该状态，方法会立即解析。可以是以下之一：

    • 'load' - 等待 load 事件触发。
    • 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
    • 'networkidle' - 不推荐 等待直到至少 500 毫秒内没有网络连接。请勿将此方法用于测试，而是依赖 Web 断言来评估页面准备状态。

  • 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_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 str | Pattern | Callable[URL]:bool#

    一个 glob 模式、正则表达式模式或在等待导航时接收 URL 以进行匹配的谓词函数。请注意，如果参数是不包含通配符的字符串，则方法将等待导航到与该字符串完全相等的 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()方法来更改默认值。

  • 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

与此页面关联的 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.accept() 或 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")

在 frame 附加时触发。

用法

page.on("frameattached", handler)

事件数据

on("framedetached")​

添加于: v1.9 page.on("framedetached")

在 frame 分离时触发。

用法

page.on("framedetached", handler)

事件数据

on("framenavigated")​

添加于: v1.9 page.on("framenavigated")

在 frame 导航到新 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。请参阅我们的 Node.js 指南，了解如何与 Axe 集成。

用法

page.accessibility

类型

check​

在 v1.9 版本之前添加 page.check
不建议使用

请改用基于 locator 的 locator.check()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来勾选与 selector 匹配的元素：

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

如果在指定的 timeout 期间未完成所有步骤，此方法将抛出 TimeoutError。传入零超时会禁用此功能。

用法

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

参数

  • selector str#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)添加于: v1.11#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability checks 并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。

返回值

click​

在 v1.9 版本之前添加 page.click
不建议使用

请改用基于 locator 的 locator.click()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来点击与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有找到，则等待直到一个匹配的元素附加到 DOM 中。
  2. 等待对匹配的元素进行 actionability 检查，除非设置了 force 选项。如果在检查期间元素分离，整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 点击元素的中心，或指定的 position。
  5. 等待已启动的导航成功或失败，除非设置了 no_wait_after 选项。

如果在指定的 timeout 期间未完成所有步骤，此方法将抛出 TimeoutError。传入零超时会禁用此功能。

用法

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

参数

  • selector str#

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

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

    默认为 left。

  • click_count int (可选)#

    默认为 1。参见 UIEvent.detail。

  • delay float (可选)#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

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

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

  • no_wait_after bool (可选)#

    已废弃

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

    启动导航的操作会等待这些导航发生以及页面开始加载。您可以通过设置此标志来选择不等待。只有在导航到无法访问的页面等特殊情况下，您才需要此选项。默认为 false。

  • position Dict (可选)#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。请注意，无论是否设置 trial，都会按下键盘 modifiers，以便测试只有在按下这些键时才可见的元素。

返回值

dblclick​

在 v1.9 版本之前添加 page.dblclick
不建议使用

请改用基于 locator 的 locator.dblclick()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来双击与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有找到，则等待直到一个匹配的元素附加到 DOM 中。
  2. 等待对匹配的元素进行 actionability 检查，除非设置了 force 选项。如果在检查期间元素分离，整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 双击元素的中心，或指定的 position。

如果在指定的 timeout 期间未完成所有步骤，此方法将抛出 TimeoutError。传入零超时会禁用此功能。

注意

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

用法

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

参数

  • selector str#

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

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

    默认为 left。

  • delay float (可选)#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

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

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

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。请注意，无论是否设置 trial，都会按下键盘 modifiers，以便测试只有在按下这些键时才可见的元素。

返回值

dispatch_event​

在 v1.9 版本之前添加 page.dispatch_event
不建议使用

请改用基于 locator 的 locator.dispatch_event()。了解更多关于 locators 的信息。

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

用法

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

在底层，它根据给定的 type 创建一个事件实例，使用 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 str#

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

  • type str#

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

  • event_init EvaluationArgument (可选)#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

eval_on_selector​

添加于: v1.9 page.eval_on_selector
不建议使用

此方法不等待元素通过 actionability 检查，因此可能导致测试不稳定。请改用 locator.evaluate()、其他 Locator 辅助方法或 web-first 断言。

此方法在页面内查找与指定 selector 匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配 selector，该方法将抛出错误。返回 expression 的值。

如果 expression 返回一个 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#

    用于查询的 selector。

  • expression str#

    要在浏览器上下文中进行评估的 JavaScript 表达式。如果表达式评估为函数，则自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

返回值

eval_on_selector_all​

添加于: v1.9 page.eval_on_selector_all
不建议使用

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 web-first 断言表现更好。

此方法在页面内查找所有与指定 selector 匹配的元素，并将匹配元素的数组作为第一个参数传递给 expression。返回 expression 调用的结果。

如果 expression 返回一个 Promise，则 page.eval_on_selector_all() 将等待 Promise 解析并返回其值。

用法

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

参数

  • selector str#

    用于查询的 selector。

  • expression str#

    要在浏览器上下文中进行评估的 JavaScript 表达式。如果表达式评估为函数，则自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值

expect_navigation​

在 v1.9 版本之前添加 page.expect_navigation
已废弃

此方法存在固有的竞争条件，请改用 page.wait_for_url()。

等待主 frame 导航并返回主资源响应。如果存在多个重定向，导航将解析为最后一个重定向的响应。如果导航到不同的锚点或因 History API 使用而进行的导航，导航将解析为 null。

用法

当页面导航到新 URL 或重新加载时，此 Promise 将解析。当您运行的代码会间接导致页面导航时，此方法很有用。例如，点击目标含有一个 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
注意

使用 History 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 的 locator.fill()。了解更多关于 locators 的信息。

此方法等待与 selector 匹配的元素出现，等待 actionability 检查，聚焦元素，填充值并在填充后触发 input 事件。请注意，您可以传入空字符串来清空输入字段。

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

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

用法

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

参数

  • selector str#

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

  • value str#

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

  • force bool (可选)添加于: v1.13#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

focus​

在 v1.9 版本之前添加 page.focus
不建议使用

请改用基于 locator 的 locator.focus()。了解更多关于 locators 的信息。

此方法根据 selector 获取元素并聚焦它。如果没有元素匹配 selector，该方法将等待直到匹配的元素出现在 DOM 中。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

get_attribute​

在 v1.9 版本之前添加 page.get_attribute
不建议使用

请改用基于 locator 的 locator.get_attribute()。了解更多关于 locators 的信息。

返回元素的属性值。

用法

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

参数

  • selector str#

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

  • name str#

    要获取值的属性名称。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

hover​

在 v1.9 版本之前添加 page.hover
不建议使用

请改用基于 locator 的 locator.hover()。了解更多关于 locators 的信息。

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

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

如果在指定的 timeout 期间未完成所有步骤，此方法将抛出 TimeoutError。传入零超时会禁用此功能。

用法

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

参数

  • selector str#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

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

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

  • no_wait_after bool (optional)添加于：v1.28#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。请注意，无论是否设置 trial，都会按下键盘 modifiers，以便测试只有在按下这些键时才可见的元素。

返回值

inner_html​

在 v1.9 版本之前添加 page.inner_html
不建议使用

请改用基于 locator 的 locator.inner_html()。了解更多关于 locators 的信息。

返回 element.innerHTML。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

is_editable​

在 v1.9 版本之前添加 page.is_editable
不建议使用

改用基于 locator.is_editable() 的定位符。了解更多关于 定位符 的信息。

返回元素是否 editable。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

is_enabled​

在 v1.9 版本之前添加 page.is_enabled
不建议使用

改用基于 locator.is_enabled() 的定位符。了解更多关于 定位符 的信息。

返回元素是否 enabled。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    已废弃

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

返回值

is_visible​

在 v1.9 版本之前添加 page.is_visible
不建议使用

改用基于 locator.is_visible() 的定位符。了解更多关于 定位符 的信息。

返回元素是否 visible。未匹配到任何元素的selector被视为不可见。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

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

  • key str#

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

  • delay float (可选)#

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

  • no_wait_after bool (可选)#

    已废弃

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

    启动导航的操作会等待这些导航发生以及页面开始加载。您可以通过设置此标志来选择不等待。只有在导航到无法访问的页面等特殊情况下，您才需要此选项。默认为 false。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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#

    用于查询的 selector。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

返回值

query_selector_all​

添加于: v1.9 page.query_selector_all
不建议使用

改用基于 page.locator() 的定位符。了解更多关于 定位符 的信息。

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

用法

page.query_selector_all(selector)

参数

  • selector str#

    用于查询的 selector。

返回值

select_option​

在 v1.9 版本之前添加 page.select_option
不建议使用

改用基于 locator.select_option() 的定位符。了解更多关于 定位符 的信息。

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

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

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

在所有提供的选项都被选中后，触发一个 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#

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

  • force bool (可选)添加于: v1.13#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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. 等待对匹配元素执行 actionability 检查，除非设置了 force 选项。如果在检查期间元素被分离，则整个操作会被重试。
  5. 如果需要，将元素滚动到视图中。
  6. 使用 page.mouse 点击元素的中心。
  7. 确保元素现在已选中或未选中。如果不是，此方法会抛出错误。

当所有步骤在指定的 timeout 期间未能完成时，此方法会抛出 TimeoutError。传入零超时会禁用此功能。

用法

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

参数

  • selector str#

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

  • checked bool#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (可选)#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后，此方法仅执行 actionability checks 并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。

返回值

set_input_files​

在 v1.9 版本之前添加 page.set_input_files
不建议使用

改用基于 locator.set_input_files() 的定位符。了解更多关于 定位符 的信息。

将文件输入框的值设置为这些文件路径或文件。如果部分 filePaths 是相对路径，则它们会相对于当前工作目录进行解析。对于空数组，清除选中的文件。对于带有 [webkitdirectory] 属性的输入框，只支持单个目录路径。

此方法要求 selector 指向一个 input element。但是，如果该元素位于具有相关联的 control 的 <label> 元素内，则改而定位到该 control。

用法

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

参数

返回值

tap​

在 v1.9 版本之前添加 page.tap
不建议使用

改用基于 locator.tap() 的定位符。了解更多关于 定位符 的信息。

此方法通过执行以下步骤来点击匹配 selector 的元素：

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

当所有步骤在指定的 timeout 期间未能完成时，此方法会抛出 TimeoutError。传入零超时会禁用此功能。

注意

如果浏览器上下文的 has_touch 选项为 false，page.tap() 方法会抛出错误。

用法

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

参数

  • selector str#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

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

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

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。请注意，无论是否设置 trial，都会按下键盘 modifiers，以便测试只有在按下这些键时才可见的元素。

返回值

text_content​

在 v1.9 版本之前添加 page.text_content
不建议使用

改用基于 locator.text_content() 的定位符。了解更多关于 定位符 的信息。

返回 element.textContent。

用法

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

参数

  • selector str#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

    最大等待时间，单位为毫秒。默认为 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 str#

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

  • text str#

    要输入到聚焦元素的文本。

  • delay float (可选)#

    按键之间等待的时间（毫秒）。默认为 0。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

返回值

uncheck​

在 v1.9 版本之前添加 page.uncheck
不建议使用

改用基于 locator.uncheck() 的定位符。了解更多关于 定位符 的信息。

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

  1. 查找匹配 selector 的元素。如果没有找到，则等待匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，此方法会抛出错误。如果元素已处于未选中状态，此方法会立即返回。
  3. 等待对匹配元素执行 actionability 检查，除非设置了 force 选项。如果在检查期间元素被分离，则整个操作会被重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 点击元素的中心。
  6. 确保元素现在已未选中。如果不是，此方法会抛出错误。

当所有步骤在指定的 timeout 期间未能完成时，此方法会抛出 TimeoutError。传入零超时会禁用此功能。

用法

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

参数

  • selector str#

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

  • force bool (可选)#

    是否绕过 actionability checks。默认为 false。

  • no_wait_after bool (可选)#

    已废弃

    此选项无效。

    此选项无效。

  • position Dict (可选)添加于: v1.11#

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

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于: v1.11#

    设置后，此方法仅执行 actionability checks 并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪时非常有用。

返回值

wait_for_selector​

在 v1.9 版本之前添加 page.wait_for_selector
不建议使用

建议使用断言可见性的 Web 断言或基于定位符的 locator.wait_for()。阅读更多关于定位符的信息。

当由选择器指定的元素满足 state 选项时返回。如果等待 hidden 或 detached 则返回 null。

注意

Playwright 在执行操作之前会自动等待元素准备就绪。使用 Locator 对象和 Web 优先断言可以使代码无需等待选择器。

等待由 selector 指定的元素满足 state 选项（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用方法时 selector 已经满足条件，方法将立即返回。如果在 timeout 毫秒内选择器不满足条件，函数将抛出异常。

用法

此方法在导航之间也有效。

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#

    用于查询的 selector。

  • state "attached" | "detached" | "visible" | "hidden" (可选)#

    默认为 'visible'。可以是以下之一：

    • 'attached' - 等待元素出现在 DOM 中。
    • 'detached' - 等待元素不出现在 DOM 中。
    • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden 样式。请注意，没有内容的元素或具有 display:none 样式的元素的边界框为空，不被视为可见。
    • 'hidden' - 等待元素从 DOM 分离，或者具有空的边界框，或者具有 visibility:hidden 样式。这与 'visible' 选项相反。

  • strict bool (optional)添加于: v1.14#

    当设置为 true 时，调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用会抛出异常。

  • 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 断言。

等待给定的 timeout 毫秒。

请注意，page.waitForTimeout() 仅应用于调试。在生产环境中使用定时器的测试将会不稳定。请改用网络事件、选择器变为可见等信号。

用法

# wait for 1 second
page.wait_for_timeout(1000)

参数

  • timeout float#

    要等待的超时时间

返回值