跳至主要内容

浏览器上下文

浏览器上下文提供了一种操作多个独立浏览器会话的方法。

如果页面打开了另一个页面，例如使用 window.open 调用，则弹出窗口将属于父页面的浏览器上下文。

Playwright 允许使用 browser.new_context() 方法创建隔离的非持久性浏览器上下文。非持久性浏览器上下文不会将任何浏览数据写入磁盘。

# create a new incognito browser context
context = browser.new_context()
# create a new page inside context.
page = context.new_page()
page.goto("https://example.com")
# dispose context once it is no longer needed.
context.close()

方法​

add_cookies​

在 v1.9 之前添加 browserContext.add_cookies

将 cookie 添加到此浏览器上下文。此上下文中的所有页面都将安装这些 cookie。可以通过 browser_context.cookies() 获取 cookie。

用法

browser_context.add_cookies([cookie_object1, cookie_object2])

参数

  • cookies List[Dict]#

    • name str

    • value str

    • url str (可选)

      url 或域/路径是必需的。可选。

    • domain str (可选)

      要使 cookie 也适用于所有子域，请在域名前面加上点，例如：".example.com"。url 或域/路径是必需的。可选。

    • path str (可选)

      url 或域/路径是必需的。可选。

    • expires float (可选)

      以秒为单位的 Unix 时间。可选。

    • httpOnly bool (可选)

      可选。

    • secure bool (可选)

      可选。

    • sameSite "Strict" | "Lax" | "None" (可选)

      可选。

返回值

add_init_script​

在 v1.9 之前添加 browserContext.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.
browser_context.add_init_script(path="preload.js")
注意

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

参数

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

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

  • script str (可选)#

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

返回值

clear_cookies​

在 v1.9 之前添加 browserContext.clear_cookies

从上下文中删除 cookie。接受可选的过滤器。

用法

context.clear_cookies()
context.clear_cookies(name="session-id")
context.clear_cookies(domain="my-origin.com")
context.clear_cookies(path="/api/v1")
context.clear_cookies(name="session-id", domain="my-origin.com")

参数

  • domain str | Pattern (可选)在以下版本中添加：v1.43#

    仅删除具有给定域的 cookie。

  • name str | Pattern (可选)在以下版本中添加：v1.43#

    仅删除具有给定名称的 cookie。

  • path str | Pattern (可选)在以下版本中添加：v1.43#

    仅删除具有给定路径的 cookie。

返回值

clear_permissions​

在 v1.9 之前添加 browserContext.clear_permissions

清除浏览器上下文的所有权限覆盖。

用法

context = browser.new_context()
context.grant_permissions(["clipboard-read"])
# do stuff ..
context.clear_permissions()

返回值

close​

在 v1.9 之前添加 browserContext.close

关闭浏览器上下文。属于浏览器上下文的所有页面都将关闭。

注意

默认浏览器上下文无法关闭。

用法

browser_context.close()
browser_context.close(**kwargs)

参数

  • reason str (可选)在以下版本中添加：v1.40#

    要报告给由上下文关闭中断的操作的原因。

返回值

cookies​

在 v1.9 之前添加 browserContext.cookies

如果没有指定 URL，则此方法将返回所有 cookie。如果指定了 URL，则仅返回影响这些 URL 的 cookie。

用法

browser_context.cookies()
browser_context.cookies(**kwargs)

参数

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

    可选的 URL 列表。

返回值

expect_console_message​

在以下版本中添加：v1.34 browserContext.expect_console_message

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

用法

browser_context.expect_console_message()
browser_context.expect_console_message(**kwargs)

参数

返回值

expect_event​

在 v1.9 之前添加 browserContext.expect_event

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

用法

with context.expect_event("page") as event_info:
    page.get_by_role("button").click()
page = event_info.value

参数

  • event str#

    事件名称，与传递给 browserContext.on(event) 的事件名称相同。

  • predicate Callable (可选)#

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

  • timeout float (可选)#

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

返回值

expect_page​

添加时间：v1.9 browserContext.expect_page

执行操作并等待上下文创建新的 Page。如果提供谓词，它将 Page 值传递给 predicate 函数，并等待 predicate(event) 返回真值。如果在创建新 Page 之前上下文关闭，将抛出错误。

用法

browser_context.expect_page()
browser_context.expect_page(**kwargs)

参数

返回值

expose_binding​

在 v1.9 之前添加 browserContext.expose_binding

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

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

有关页面的版本，请参阅 page.expose_binding()。

用法

将页面 URL 公开给上下文中的所有页面的所有帧的示例

from playwright.sync_api import sync_playwright, Playwright

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

with sync_playwright() as playwright:
    run(playwright)

参数

  • name str#

    窗口对象上的函数名称。

  • callback Callable#

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

  • handle bool (可选)#

    已弃用

    此选项将在未来被移除。

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

返回值

expose_function​

在 v1.9 之前添加 browserContext.expose_function

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

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

有关页面的版本，请参阅 page.expose_function()。

用法

将 sha256 函数添加到上下文中的所有页面的示例

import hashlib
from playwright.sync_api import sync_playwright

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


def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    context = browser.new_context()
    context.expose_function("sha256", sha256)
    page = context.new_page()
    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.get_by_role("button").click()

with sync_playwright() as playwright:
    run(playwright)

参数

  • name str#

    窗口对象上的函数名称。

  • callback Callable#

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

返回值

grant_permissions​

在 v1.9 之前添加 browserContext.grant_permissions

授予浏览器上下文指定的权限。如果指定，只授予给定源相应的权限。

用法

browser_context.grant_permissions(permissions)
browser_context.grant_permissions(permissions, **kwargs)

参数

  • permissions List[str]#

    要授予的权限或权限数组。权限可以是以下值之一

    • 'accelerometer'
    • 'accessibility-events'
    • 'ambient-light-sensor'
    • 'background-sync'
    • 'camera'
    • 'clipboard-read'
    • 'clipboard-write'
    • 'geolocation'
    • 'gyroscope'
    • 'magnetometer'
    • 'microphone'
    • 'midi-sysex' （系统独占 MIDI）
    • 'midi'
    • 'notifications'
    • 'payment-handler'
    • 'storage-access'

  • origin str (可选)#

    要授予权限的 源，例如 "https://example.com"。

返回值

new_cdp_session​

添加时间：v1.11 browserContext.new_cdp_session
注意

CDP 会话仅在基于 Chromium 的浏览器中受支持。

返回新创建的会话。

用法

browser_context.new_cdp_session(page)

参数

  • page Page | Frame#

    要为其创建新会话的目标。为了向后兼容，此参数名为 page，但它可以是 Page 或 Frame 类型。

返回值

new_page​

在 v1.9 之前添加 browserContext.new_page

在浏览器上下文中创建一个新页面。

用法

browser_context.new_page()

返回值

route​

在 v1.9 之前添加 browserContext.route

路由提供修改浏览器上下文中任何页面发出的网络请求的能力。启用路由后，每个与 URL 模式匹配的请求将被暂停，除非它被继续、完成或中止。

注意

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

用法

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

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

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

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

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

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

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

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

注意

启用路由会禁用 HTTP 缓存。

参数

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

    用于在路由时匹配的全局模式、正则表达式模式或接收 URL 的谓词。如果通过上下文选项提供了 base_url 并且传入的 URL 是路径，则它将通过 new URL() 构造函数合并。

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

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

  • times int (可选)添加时间：v1.15#

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

返回值

route_from_har​

添加时间：v1.23 browserContext.route_from_har

如果指定，上下文中发出的网络请求将从 HAR 文件中提供服务。详细了解 从 HAR 中重播。

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

用法

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

参数

  • har Union[str, pathlib.Path]#

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

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

    • 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
    • 如果设置为 'fallback'，则将继续到处理程序链中的下一个路由处理程序。

    默认值为 abort。

  • update bool (可选)#

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

  • update_content "embed" | "attach" (可选)添加时间：v1.32#

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

  • update_mode "full" | "minimal" (可选)添加时间：v1.32#

    当设置为 minimal 时，仅记录从 HAR 进行路由所需的必要信息。这省略了在从 HAR 播放时未使用的尺寸、计时、页面、cookie、安全性和其他类型的 HAR 信息。默认值为 minimal。

  • url str | Pattern (可选)#

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

返回值

route_web_socket​

添加时间：v1.48 browserContext.route_web_socket

此方法允许修改浏览器上下文中任何页面发出的 websocket 连接。

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

用法

以下是一个简单的处理程序示例，它会阻止一些 websocket 消息。有关更多详细信息和示例，请参见 WebSocketRoute。

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "to-be-blocked":
    return
  ws.send(message)

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

context.route_web_socket("/ws", handler)

参数

返回值

set_default_navigation_timeout​

在 v1.9 之前添加 browserContext.set_default_navigation_timeout

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

注意

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

用法

browser_context.set_default_navigation_timeout(timeout)

参数

  • timeout float#

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

set_default_timeout​

在 v1.9 之前添加 browserContext.set_default_timeout

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

注意

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

用法

browser_context.set_default_timeout(timeout)

参数

  • timeout float#

    以毫秒为单位的最大时间

set_extra_http_headers​

在 v1.9 之前添加 browserContext.set_extra_http_headers

所有上下文中的页面发起的请求都会发送额外的 HTTP 头信息。这些头信息会与使用 page.set_extra_http_headers() 设置的特定页面额外 HTTP 头信息合并。如果页面覆盖了特定的头信息，则会使用特定页面的头信息值，而不是浏览器上下文头信息值。

注意

browser_context.set_extra_http_headers() 不保证传出请求中头信息的顺序。

用法

browser_context.set_extra_http_headers(headers)

参数

  • headers Dict[str, str]#

    包含要与每个请求一起发送的额外 HTTP 头信息的 객체。所有头信息值都必须是字符串。

返回值

set_geolocation​

在 v1.9 之前添加 browserContext.set_geolocation

设置上下文的地理位置。传递 null 或 undefined 表示位置不可用。

用法

browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
注意

考虑使用 browser_context.grant_permissions() 来授予浏览器上下文页面读取其地理位置的权限。

参数

  • geolocation NoneType | Dict#

    • latitude float

      介于 -90 到 90 之间的纬度。

    • longitude float

      介于 -180 到 180 之间的经度。

    • accuracy float (optional)

      非负精度值。默认值为 0。

返回值

set_offline​

在 v1.9 之前添加 browserContext.set_offline

用法

browser_context.set_offline(offline)

参数

  • offline bool#

    是否模拟浏览器上下文网络处于离线状态。

返回值

storage_state​

在 v1.9 之前添加 browserContext.storage_state

返回此浏览器上下文的存储状态，包含当前 cookie 和本地存储快照。

用法

browser_context.storage_state()
browser_context.storage_state(**kwargs)

参数

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

    要保存存储状态的文件路径。如果 path 是相对路径，则它相对于当前工作目录解析。如果没有提供路径，存储状态仍然会返回，但不会保存到磁盘。

返回值

unroute​

在 v1.9 之前添加 browserContext.unroute

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

用法

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

参数

返回值

unroute_all​

添加到：v1.41 browserContext.unroute_all

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

用法

browser_context.unroute_all()
browser_context.unroute_all(**kwargs)

参数

  • behavior "wait" | "ignoreErrors" | "default" (optional)#

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

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

返回值

wait_for_event​

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

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

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

用法

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

参数

  • event str#

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

  • predicate Callable (optional)#

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

  • timeout float (optional)#

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

返回值

属性​

background_pages​

添加时间：v1.11 browserContext.background_pages
注意

后台页面仅在基于 Chromium 的浏览器中受支持。

上下文中的所有现有后台页面。

用法

browser_context.background_pages

返回值

browser​

在 v1.9 之前添加 browserContext.browser

返回上下文的浏览器实例。如果它被启动为持久上下文，则返回 null。

用法

browser_context.browser

返回值

clock​

添加到：v1.45 browserContext.clock

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

用法

browser_context.clock

类型

pages​

在 v1.9 之前添加 browserContext.pages

返回上下文中所有打开的页面。

用法

browser_context.pages

返回值

request​

添加到：v1.16 browserContext.request

与该上下文关联的 API 测试助手。使用此 API 发出的请求将使用上下文 cookie。

用法

browser_context.request

类型

service_workers​

添加时间：v1.11 browserContext.service_workers
注意

服务工作者仅在基于 Chromium 的浏览器中受支持。

上下文中所有现有的服务工作者。

用法

browser_context.service_workers

返回值

tracing​

新增于：v1.12 browserContext.tracing

用法

browser_context.tracing

类型

事件​

on("backgroundpage")​

添加时间：v1.11 browserContext.on("backgroundpage")
注意

仅适用于 Chromium 浏览器的持久上下文。

当上下文中创建新的后台页面时发出。

background_page = context.wait_for_event("backgroundpage")

用法

browser_context.on("backgroundpage", handler)

事件数据

on("close")​

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

当浏览器上下文关闭时发出。这可能是由于以下原因之一

  • 浏览器上下文已关闭。
  • 浏览器应用程序已关闭或崩溃。
  • 已调用 browser.close() 方法。

用法

browser_context.on("close", handler)

事件数据

on("console")​

在以下版本中添加：v1.34 browserContext.on("console")

当页面中的 JavaScript 调用控制台 API 方法之一时发出，例如 console.log 或 console.dir。

传递给 console.log 和页面的参数在 ConsoleMessage 事件处理程序参数中可用。

用法

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

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

事件数据

on("dialog")​

在以下版本中添加：v1.34 browserContext.on("dialog")

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

用法

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

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

事件数据

on("page")​

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

当浏览器上下文中创建新页面时发出此事件。该页面可能仍在加载。该事件也会针对弹出页面触发。另请参见 page.on("popup") 以接收与特定页面相关的弹出窗口事件。

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

with context.expect_page() as page_info:
    page.get_by_text("open new page").click(),
page = page_info.value
print(page.evaluate("location.href"))
注意

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

用法

browser_context.on("page", handler)

事件数据

on("request")​

新增于：v1.12 browserContext.on("request")

当通过此上下文创建的任何页面发出请求时发出。 request 对象是只读的。要仅监听来自特定页面的请求，请使用 page.on("request")。

要拦截和修改请求，请参阅 browser_context.route() 或 page.route()。

用法

browser_context.on("request", handler)

事件数据

on("requestfailed")​

新增于：v1.12 browserContext.on("requestfailed")

当请求失败时发出，例如超时。要仅监听来自特定页面的失败请求，请使用 page.on("requestfailed")。

注意

HTTP 错误响应，例如 404 或 503，从 HTTP 角度来看仍然是成功的响应，因此请求将使用 browser_context.on("requestfinished") 事件完成，而不是使用 browser_context.on("requestfailed")。

用法

browser_context.on("requestfailed", handler)

事件数据

on("requestfinished")​

新增于：v1.12 browserContext.on("requestfinished")

当请求在下载响应主体后成功完成时发出。对于成功的响应，事件顺序是 request、response 和 requestfinished。要监听来自特定页面的成功请求，请使用 page.on("requestfinished")。

用法

browser_context.on("requestfinished", handler)

事件数据

on("response")​

新增于：v1.12 browserContext.on("response")

当为请求接收到 response 状态和标头时发出。对于成功的响应，事件顺序是 request、response 和 requestfinished。要监听来自特定页面的响应事件，请使用 page.on("response")。

用法

browser_context.on("response", handler)

事件数据

on("serviceworker")​

添加时间：v1.11 browserContext.on("serviceworker")
注意

服务工作者仅在基于 Chromium 的浏览器中受支持。

当上下文中创建新的服务工作者时发出。

用法

browser_context.on("serviceworker", handler)

事件数据

on("weberror")​

新增于：v1.38 browserContext.on("weberror")

当此上下文中的任何页面中未处理异常时发出。要监听来自特定页面的错误，请改用 page.on("pageerror")。

用法

browser_context.on("weberror", handler)

事件数据