Page

Page 提供了与 Browser 中的单个标签页或 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)

import asyncio
from playwright.async_api import async_playwright, Playwright

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

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

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​

添加一个脚本，该脚本将在以下任一场景中被执行：

• 每当页面发生导航时。
• 每当子框架被附加或导航时。在这种情况下，脚本会在新附加框架的上下文中进行评估。

脚本会在文档创建后但在其任何脚本运行前被评估。这对于修改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")

# in your playwright script, assuming the preload.js file is in same directory
await page.add_init_script(path="./preload.js")

参数

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

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

• script str (可选)#

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

返回

• NoneType#

add_locator_handler​

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

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

需要注意的事项：

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

用法

一个示例，当"注册订阅新闻通讯"对话框出现时将其关闭：

# 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():
  await page.get_by_role("button", name="No thanks").click()
await page.add_locator_handler(page.get_by_text("Sign up to the newsletter"), handler)

# Write the test as usual.
await page.goto("https://example.com")
await 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()

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

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

一个在每次可操作性检查时使用自定义回调的示例。它使用了始终可见的定位器，因此处理程序会在每次可操作性检查前被调用。指定no_wait_after很重要，因为该处理程序不会隐藏元素。

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

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

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

Handler 将原始定位器作为参数。您还可以通过设置 times 来指定调用次数后自动移除该 handler：

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

def handler(locator):
  await locator.click()
await 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会等待直到覆盖层变为隐藏状态，然后才会继续执行触发该处理程序的操作/断言。此选项允许退出此行为，使得处理程序运行后覆盖层可以保持可见。

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

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

返回

• NoneType#

add_script_tag​

向页面添加一个带有指定URL或内容的

用法

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

参数

• content str (可选)#

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

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

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

• type str (optional)#

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

• url str (可选)#

  要添加脚本的URL。

返回

• ElementHandle#

add_style_tag​

向页面中添加一个带有指定URL的标签，或者一个带有CSS内容的

用法

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

参数

• content str (可选参数)#

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

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

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

• url str (可选)#

  <link> 标签的URL。

返回

• ElementHandle#

bring_to_front​

将页面置于前台（激活标签页）。

用法

page.bring_to_front()

返回

• NoneType#

关闭​

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

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

用法

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

参数

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

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

• run_before_unload bool (可选)#

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

返回

• NoneType#

内容​

Gets the full HTML contents of the page, including the doctype.

用法

page.content()

返回

• str#

拖放操作​

该方法将源元素拖动到目标元素。首先会移动到源元素，执行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}
)

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

参数

• source str#

  用于搜索要拖拽元素的选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• target str#

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

• force bool (可选)#

  是否绕过actionability检查。默认为false。

• no_wait_after bool (可选)#

  已弃用

  此选项无效。

  此选项无效。

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

  • x float

  • y float

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

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

  当设置为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

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

  • x float

  • y float

  在目标元素的这一点上相对于元素内边距框的左上角进行拖放。如果未指定，则使用元素的某个可见点。

• timeout float (可选)#

  最大时间，单位为毫秒。默认为 30000 (30秒)。传入 0 表示禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法进行修改。

• trial bool (可选)#

  当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作而无需实际执行的情况。

返回

• NoneType#

模拟媒体​

此方法通过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

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

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

await page.emulate_media()
await page.evaluate("matchMedia('screen').matches")
# → True
await 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

await page.emulate_media(color_scheme="dark")
await page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
# → True
await 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' 已被弃用。

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

• 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将禁用减少动画效果的模拟。

返回

• NoneType#

评估​

返回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"

result = await 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"

print(await page.evaluate("1 + 2")) # prints "3"
x = 10
print(await 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()

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

参数

• expression str#

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

• arg EvaluationArgument (可选)#

  可选的参数传递给 expression。

返回

• Dict#

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_window_handle = await page.evaluate_handle("Promise.resolve(window)")
a_window_handle # handle for the window object.

也可以传入字符串而不是函数：

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

a_handle = await 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()

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

参数

• expression str#

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

• arg EvaluationArgument (可选)#

  可选的参数传递给 expression。

返回

• JSHandle#

expect_console_message​

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

用法

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

参数

• predicate Callable[ConsoleMessage]:bool (可选)#

  接收ConsoleMessage对象，当等待应解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[ConsoleMessage]#

expect_download​

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

用法

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

参数

• predicate Callable[Download]:bool (可选)#

  接收Download对象，当等待应解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[Download]#

expect_event​

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

用法

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

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

参数

• event str#

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

• predicate Callable (可选)#

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

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager#

expect_file_chooser​

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

用法

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

参数

• predicate Callable[FileChooser]:bool (可选)#

  接收FileChooser对象，当等待应解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[FileChooser]#

expect_popup​

执行操作并等待弹出Page。如果提供了predicate，它会将[Popup]值传递给predicate函数，并等待predicate(page)返回真值。如果在弹出事件触发前页面被关闭，将会抛出错误。

用法

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

参数

• predicate Callable[Page]:bool (可选)#

  接收Page对象，当等待应解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[Page]#

expect_request​

等待匹配的请求并返回它。有关事件的更多详情，请参阅waiting for event。

用法

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

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

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

参数

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

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

• timeout float (可选)#

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

返回

• EventContextManager[Request]#

expect_request_finished​

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

用法

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

参数

• predicate Callable[Request]:bool (可选)#

  接收Request对象，当等待应该解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[Request]#

expect_response​

返回匹配的响应。有关事件的更多详情，请参阅waiting for event。

用法

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

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

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

参数

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

  请求URL字符串、正则表达式或接收Response对象的谓词函数。当通过上下文选项提供了base_url且传入的URL是路径时，将通过new URL()构造函数进行合并。

• timeout float (可选参数)#

  最大等待时间（毫秒），默认为30秒，传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()或page.set_default_timeout()方法进行修改。

返回

• EventContextManager[Response]#

expect_websocket​

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

用法

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

参数

• predicate Callable[WebSocket]:bool (可选)#

  接收WebSocket对象，当等待应该解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[WebSocket]#

expect_worker​

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

用法

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

参数

• predicate Callable[Worker]:bool (可选)#

  接收Worker对象，当等待应该解决时解析为真值。

• timeout float (可选参数)#

  最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browser_context.set_default_timeout()进行修改。

返回

• EventContextManager[Worker]#

expose_binding​

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

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

参见browser_context.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)

import asyncio
from playwright.async_api import async_playwright, Playwright

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

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

参数

• name str#

  窗口对象上的函数名称。

• callback Callable#

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

• handle bool (可选)#

  已弃用

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

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

返回

• NoneType#

expose_function​

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

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

有关上下文范围内暴露的函数，请参见browser_context.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)

import asyncio
import hashlib
from playwright.async_api import async_playwright, Playwright

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


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

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

参数

• name str#

  窗口对象上的函数名称

• callback Callable#

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

返回

• NoneType#

框架​

返回符合指定条件的框架。必须指定name或url参数。

用法

frame = page.frame(name="frame-name")

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

参数

• name str (可选)#

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

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

  接收帧的url作为URL对象的通配符模式、正则表达式模式或谓词函数。可选参数。

返回

• NoneType | Frame#

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

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

参数

• selector str#

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

返回

• FrameLocator#

get_by_alt_text​

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

用法

例如，这个方法将通过alt文本"Playwright logo"找到图片：

<img alt='Playwright logo'>

page.get_by_alt_text("Playwright logo").click()

await page.get_by_alt_text("Playwright logo").click()

参数

• text str | Pattern#

  用于定位元素的文本。

• exact bool (可选)#

  是否查找完全匹配：区分大小写且整个字符串匹配。默认为false。使用正则表达式定位时忽略此选项。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

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

await page.get_by_label("Username").fill("john")
await page.get_by_label("Password").fill("secret")

参数

• text str | Pattern#

  用于定位元素的文本。

• exact bool (可选)#

  是否查找完全匹配：区分大小写且整个字符串匹配。默认为false。使用正则表达式定位时忽略此选项。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

get_by_placeholder​

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

用法

例如，考虑以下DOM结构。

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

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

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

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

参数

• text str | Pattern#

  用于定位元素的文本。

• exact bool (可选)#

  是否查找完全匹配：区分大小写且整个字符串匹配。默认为false。使用正则表达式定位时忽略此选项。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

get_by_role​

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

用法

考虑以下DOM结构。

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

您可以通过元素的隐式角色来定位每个元素：

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

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

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

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

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

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

参数

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

  必需的aria角色。

• checked bool (可选)#

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

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

• disabled bool (可选)#

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

  注意

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

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

  是否对name进行精确匹配：区分大小写且需完全匹配整个字符串。默认为false。当name是正则表达式时此参数将被忽略。请注意精确匹配仍会去除首尾空格。

• expanded bool (可选)#

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

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

• include_hidden bool (可选)#

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

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

• level int (可选)#

  一个数值属性，通常出现在角色 heading、listitem、row、treeitem 中，对于 <h1>-<h6> 元素有默认值。

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

• name str | Pattern (可选)#

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

  了解更多关于accessible name的信息。

• pressed bool (可选)#

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

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

• selected bool (可选)#

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

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

返回

• 定位器#

详情

角色选择器不能替代无障碍审计和合规性测试，而是提供关于ARIA指南的早期反馈。

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

get_by_test_id​

通过测试ID定位元素。

用法

考虑以下DOM结构。

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

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

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

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

参数

• test_id str | Pattern#

  用于定位元素的ID。

返回

• 定位器#

详情

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

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

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

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

用法

考虑以下DOM结构。

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

您可以通过标题文本定位后检查问题数量：

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

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

参数

• text str | Pattern#

  用于定位元素的文本。

• exact bool (可选)#

  是否查找完全匹配：区分大小写且整个字符串匹配。默认为false。使用正则表达式定位时忽略此选项。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

返回​

返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。如果无法返回，则返回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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
  • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• NoneType | Response#

前进​

返回主资源响应。在多次重定向的情况下，导航将以最后一次重定向的响应结果解析。如果无法前进，则返回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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
  • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• NoneType | Response#

前往​

返回主资源响应。在多次重定向的情况下，导航将解析为第一个非重定向响应。

该方法将在以下情况下抛出错误：

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

当远程服务器返回任何有效的HTTP状态码时，该方法不会抛出错误，包括404"未找到"和500"内部服务器错误"。此类响应的状态码可以通过调用response.status来获取。

用法

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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
  • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• NoneType | Response#

定位器​

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

了解更多关于定位器的信息。

用法

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

参数

• selector str#

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

• has Locator (可选)#

  将方法的结果范围缩小到包含匹配此相对定位器的元素。例如，article 包含 text=Playwright 会匹配 <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>。

返回

• 定位器#

开启器​

返回弹出页面的开启者，其他情况返回null。如果开启者已被关闭，则返回null。

用法

page.opener()

返回

• NoneType | Page#

暂停​

暂停脚本执行。Playwright将停止执行脚本，等待用户点击页面覆盖层中的'Resume'按钮或在开发者工具控制台中调用playwright.resume()。

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

用法

page.pause()

返回

• NoneType#

pdf​

返回PDF缓冲区。

page.pdf() 生成带有 print CSS媒体类型的页面PDF。要生成带有 screen 媒体类型的PDF，请在调用 page.pdf() 之前先调用 page.emulate_media()：

用法

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

# generates a pdf with "screen" media type.
await page.emulate_media(media="screen")
await 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英寸

参数

• display_header_footer bool (可选)#

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

• footer_template str (optional)#

  HTML template for the print footer. Should use the same format as the header_template.

• format str (可选)#

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

• header_template str (可选)#

  HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

  • '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 (optional)#

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

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

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

  纸张宽度，接受带单位的数值。

返回

• bytes#

重新加载​

此方法会重新加载当前页面，就像用户触发了浏览器刷新一样。返回主资源响应。如果存在多次重定向，导航将以最后一次重定向的响应结果为准。

用法

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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
  • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• NoneType | Response#

移除定位器处理程序​

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

用法

page.remove_locator_handler(locator)

参数

• locator Locator#

  传递给page.add_locator_handler()的定位器。

返回

• NoneType#

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

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

用法

page.request_gc()

返回

• NoneType#

路由​

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

一旦启用路由功能，每个匹配URL模式的请求都将被挂起，除非它被继续、完成或中止。

用法

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

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