跳到主要内容

Page

Page 提供了与 Browser 中的单个选项卡或 Chromium 中的扩展程序后台页面进行交互的方法。一个 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

添加一个脚本，该脚本将在以下情况之一中执行

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

脚本在文档创建之后但在其任何脚本运行之前执行。这对于修改 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#

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

  • target str#

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

  • 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

参数

  • color_scheme "light" | "dark" | "no-preference" | "null" (可选)在 v1.9 中添加#

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

  • 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() 的函数返回非 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 (可选)#

    传递给 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。如果提供了 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

返回匹配的 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

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

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

有关上下文范围的版本，请参阅 browser_context.expose_binding()。

注意

通过 page.expose_binding() 安装的函数在导航后仍然有效。

用法

向页面中的所有 frame 公开页面 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 (可选)#

    已弃用

    此选项将在未来版本中移除。

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

返回值

expose_function​

在 v1.9 之前添加 page.expose_function

此方法在页面中每个 frame 的 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

返回与指定条件匹配的 frame。必须指定 name 或 url 之一。

用法

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

参数

  • name str (可选)#

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

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

    glob 模式、正则表达式模式或接收 frame 的 url 作为 URL 对象的 predicate。可选。

返回值

frame_locator​

添加于: v1.17 page.frame_locator

当使用 iframe 时，您可以创建一个 frame locator，它将进入 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="[email protected]" />

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

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

    控制是否匹配隐藏元素的可选项。默认情况下，role selector 只匹配非隐藏元素，如 ARIA 定义。

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

  • level int (可选)#

    数字属性，通常存在于 role heading、listitem、row、treeitem 中，<h1>-<h6> 元素具有默认值。

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

  • name str | Pattern (可选)#

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

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

  • pressed bool (可选)#

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

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

  • selected bool (可选)#

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

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

返回值

详情

Role selector 不能替代 可访问性审计和一致性测试，而是提供关于 ARIA 指南的早期反馈。

许多 html 元素具有隐式 定义的 role，role selector 可以识别它。您可以在 此处 找到所有 支持的 role。ARIA 指南 不建议 通过将 role 和/或 aria-* 属性设置为默认值来复制隐式 role 和属性。

get_by_test_id​

添加于: v1.27 page.get_by_test_id

通过 test id 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过元素的 test id 定位它

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

参数

返回值

详情

默认情况下，data-testid 属性用作 test id。如有必要，使用 selectors.set_test_id_attribute() 配置不同的 test id 属性。

get_by_text​

添加于: v1.27 page.get_by_text

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

另请参阅 locator.filter()，它允许通过另一个条件（例如可访问的 role）进行匹配，然后按文本内容进行筛选。

用法

考虑以下 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 无效。
  • 在导航期间超过了 timeout。
  • 远程服务器未响应或无法访问。
  • 主资源加载失败。

当远程服务器返回任何有效的 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 应包含 scheme，例如 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 外部的任何元素。

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

  • has_not Locator (可选)添加于: v1.33#

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

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

  • 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 选项为 falsy 值。

用法

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.5 英寸 x 11 英寸
  • Legal: 8.5 英寸 x 14 英寸
  • Tabloid: 11 英寸 x 17 英寸
  • Ledger: 17 英寸 x 11 英寸
  • A0: 33.1 英寸 x 46.8 英寸
  • A1: 23.4 英寸 x 33.1 英寸
  • A2: 16.54 英寸 x 23.4 英寸
  • A3: 11.7 英寸 x 16.54 英寸
  • A4: 8.27 英寸 x 11.7 英寸
  • A5: 5.83 英寸 x 8.27 英寸
  • A6: 4.13 英寸 x 5.83 英寸
注意

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 Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时禁用 Service Worker，方法是将 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()

可以检查请求以决定路由操作。例如，模拟包含某些 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 (可选)在 v1.15 中添加#

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

返回值

route_from_har​

添加于: v1.23 page.route_from_har

如果指定，则页面中发出的网络请求将从 HAR 文件提供。阅读更多关于 从 HAR 文件回放 的信息。

Playwright 不会从 HAR 文件中提供 Service Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时禁用 Service Worker，方法是将 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'，则缺少的请求将发送到网络。

    默认为中止。

  • update bool (可选)#

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

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

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

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

    当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这省略了在从 HAR 文件回放时未使用的尺寸、时间、页面、cookie、安全和其他类型的 HAR 信息。默认为 minimal。

  • url str | Pattern (可选)#

    用于匹配请求 URL 的 glob 模式、正则表达式或谓词。只有 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 (可选)#

    当为 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 大小，如果您需要更好地控制这些属性，请将 browser.new_context() 与 screen 和 viewport 参数一起使用。

用法

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 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() 函数的谓词

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

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

用法

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() 对话框 - 否则页面将 冻结 等待对话框，并且像 click 这样的操作将永远不会完成。

用法

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。请参阅我们的 Node.js 指南 以了解与 Axe 的集成。

用法

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#

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

  • force bool (可选)#

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

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

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

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

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作时很有用。

返回值

click​

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

请改用基于定位器的 locator.click()。阅读更多关于 定位器 的信息。

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

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

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

用法

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

参数

  • selector str#

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

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

    默认为 left。

  • click_count int (可选)#

    默认为 1。请参阅 UIEvent.detail。

  • delay float (可选)#

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

  • force bool (可选)#

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

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

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

  • no_wait_after bool (可选)#

    已弃用

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

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

  • position Dict (可选)#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

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

    当设置此项时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

dblclick​

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

请改用基于定位器的 locator.dblclick()。阅读更多关于 定位器 的信息。

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

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

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

注意

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

用法

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

参数

  • selector str#

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

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

    默认为 left。

  • delay float (可选)#

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

  • force bool (可选)#

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

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

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: 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")

在底层，它根据给定的 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#

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

  • type str#

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

  • event_init EvaluationArgument (可选)#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

返回值

eval_on_selector​

在 v1.9 中添加 page.eval_on_selector
不建议使用

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

该方法在页面中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素与选择器匹配，则该方法会抛出错误。返回 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#

    要查询的选择器。

  • expression str#

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

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • strict bool (可选)在 v1.14 中添加#

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

返回值

eval_on_selector_all​

在 v1.9 中添加 page.eval_on_selector_all
不建议使用

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 Web-first 断言可以更好地完成工作。

该方法在页面中查找与指定选择器匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 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#

    要查询的选择器。

  • expression str#

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

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值

expect_navigation​

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

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

等待主框架导航并返回主资源响应。在多次重定向的情况下，导航将使用最后一次重定向的响应来解析。如果导航到不同的锚点或由于 History 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
注意

使用 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.fill()。阅读更多关于 定位器 的信息。

此方法等待与 selector 匹配的元素，等待 可操作性 检查，聚焦元素，填充它并在填充后触发 input 事件。请注意，您可以传递空字符串以清除输入字段。

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

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

用法

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

参数

  • selector str#

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

  • 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()。阅读更多关于 定位器 的信息。

此方法获取与 selector 匹配的元素并使其获得焦点。如果没有元素与 selector 匹配，则该方法将等待直到匹配的元素出现在 DOM 中。

用法

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

参数

  • selector str#

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

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

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

  • name str#

    要获取其值的属性名称。

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

返回值

悬停​

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

请改用基于 locator 的 locator.hover()。阅读更多关于 locator 的信息。

此方法悬停在匹配 selector 的元素之上，通过执行以下步骤

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

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

用法

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

参数

  • selector str#

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

  • 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 bool (可选)添加于版本: v1.11#

    当设置此项时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

inner_html​

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

请改用基于 locator 的 locator.inner_html()。阅读更多关于 locator 的信息。

返回 element.innerHTML。

用法

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

参数

  • selector str#

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

  • 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 的 locator.inner_text()。阅读更多关于 locator 的信息。

返回 element.innerText。

用法

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

参数

  • selector str#

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

  • 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 的 locator.input_value()。阅读更多关于 locator 的信息。

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

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

用法

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

参数

  • selector str#

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

  • 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 的 locator.is_checked()。阅读更多关于 locator 的信息。

返回元素是否被选中。如果元素不是复选框或单选输入，则抛出错误。

用法

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

参数

  • selector str#

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

  • 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 的 locator.is_disabled()。阅读更多关于 locator 的信息。

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

用法

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

参数

  • selector str#

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

  • 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 的 locator.is_editable()。阅读更多关于 locator 的信息。

返回元素是否可编辑。

用法

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

参数

  • selector str#

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

  • 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 的 locator.is_enabled()。阅读更多关于 locator 的信息。

返回元素是否启用。

用法

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

参数

  • selector str#

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

  • 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 的 locator.is_hidden()。阅读更多关于 locator 的信息。

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

用法

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

参数

  • selector str#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

    已弃用

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

返回值

is_visible​

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

请改用基于 locator 的 locator.is_visible()。阅读更多关于 locator 的信息。

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

用法

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

参数

  • selector str#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

    已弃用

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

返回值

press​

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

请改用基于 locator 的 locator.press()。阅读更多关于 locator 的信息。

聚焦元素，然后使用 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#

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

  • 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
不建议使用

请改用基于 locator 的 page.locator()。阅读更多关于 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
不建议使用

请改用基于 locator 的 page.locator()。阅读更多关于 locator 的信息。

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

用法

page.query_selector_all(selector)

参数

  • selector str#

    要查询的选择器。

返回值

select_option​

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

请改用基于 locator 的 locator.select_option()。阅读更多关于 locator 的信息。

此方法等待与 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#

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

  • 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 的 locator.set_checked()。阅读更多关于 locator 的信息。

此方法通过执行以下步骤来选中或取消选中与 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#

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

  • checked bool#

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

  • force bool (可选)#

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (可选)#

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

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作时很有用。

返回值

set_input_files​

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

请改用基于 locator 的 locator.set_input_files()。阅读更多关于 locator 的信息。

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

此方法希望 selector 指向 input 元素。 但是，如果元素在具有关联 控件的 <label> 元素内，则目标是控件。

用法

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

参数

返回值

tap​

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

请改用基于 locator 的 locator.tap()。阅读更多关于 locator 的信息。

此方法通过执行以下步骤来轻触与 selector 匹配的元素

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

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

注意

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

用法

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

参数

  • selector str#

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

  • force bool (可选)#

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

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

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

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

    当设置此项时，此方法仅执行 可操作性 检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

text_content​

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

请改用基于 locator 的 locator.text_content()。阅读更多关于 locator 的信息。

返回 element.textContent。

用法

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

参数

  • selector str#

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

  • strict bool (可选)在 v1.14 中添加#

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

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

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

  • text str#

    要输入到焦点元素中的文本。

  • delay float (可选)#

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

返回值

uncheck​

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

请改用基于 locator 的 locator.uncheck()。阅读更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector str#

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

  • force bool (可选)#

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

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

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

  • strict bool (可选)在 v1.14 中添加#

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

  • timeout float (可选)#

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

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

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作时很有用。

返回值

wait_for_selector​

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

请改用断言可见性的 Web 断言或基于 locator 的 locator.wait_for()。阅读更多关于 locators 的信息。

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

注意

Playwright 会自动等待元素准备就绪后再执行操作。使用 Locator 对象和 web-first 断言使代码无需 wait-for-selector。

等待 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#

    要查询的选择器。

  • 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
不建议使用

永远不要在生产环境中使用 timeout 等待。等待时间的测试本质上是不稳定的。请使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒。

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

用法

# wait for 1 second
page.wait_for_timeout(1000)

参数

  • timeout float#

    要等待的超时时间

返回值