Browser

extends: EventEmitter

Browser（浏览器）实例是通过 browser_type.launch(**kwargs) 创建的。下面是使用 Browser 创建 Page 的示例：

Sync
Async

from playwright.sync_api import sync_playwright

def run(playwright):
    firefox = playwright.firefox
    browser = firefox.launch()
    page = browser.new_page()
    page.goto("https://example.com")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright

async def run(playwright):
    firefox = playwright.firefox
    browser = await firefox.launch()
    page = await browser.new_page()
    await page.goto("https://example.com")
    await browser.close()

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

browser.on("disconnected")

Added in: v1.8

type: <Browser>

当 Browser 与浏览器应用程序断开连接时触发。这可能由以下原因引起：

浏览器应用程序关闭或崩溃。
调用了 browser.close() 方法。

browser.browser_type

Added in: v1.23

返回值: <BrowserType>#

获取该浏览器所属的浏览器类型（chromium、firefox 或 webkit）。

browser.close()

Added in: v1.8

返回值: <NoneType>#

如果该浏览器是通过 browser_type.launch(**kwargs) 获取的，则关闭浏览器及其所有页面（如果存在）。

如果该浏览器是连接到的（connected to），则清除该浏览器所属的所有已创建上下文，并断开与浏览器服务器的连接。

note

这类似于强制退出浏览器。因此，你应该在调用 browser.close() 之前，对所有显式创建的 BrowserContext 调用 browser_context.close()。

Browser 对象本身被视为已销毁，不能再使用。

browser.contexts

Added in: v1.8

返回值: <List[BrowserContext]>#

返回所有打开的浏览器上下文数组。在新创建的浏览器中，这将返回零个浏览器上下文。

Sync
Async

browser = pw.webkit.launch()
print(len(browser.contexts())) # 打印 `0`
context = browser.new_context()
print(len(browser.contexts())) # 打印 `1`

browser = await pw.webkit.launch()
print(len(browser.contexts())) # 打印 `0`
context = await browser.new_context()
print(len(browser.contexts())) # 打印 `1`

browser.is_connected()

Added in: v1.8

返回值: <bool>#

指示浏览器是否已连接。

browser.new_browser_cdp_session()

Added in: v1.11

返回值: <CDPSession>#

note

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

返回新创建的浏览器会话。

browser.new_context(**kwargs)

Added in: v1.8

accept_downloads <bool> 是否自动下载所有附件。默认为 true，即接受所有下载。#
base_url <str> 当使用 page.goto(url, **kwargs)、page.route(url, handler, **kwargs)、page.wait_for_url(url, **kwargs)、page.expect_request(url_or_predicate, **kwargs) 或 page.expect_response(url_or_predicate, **kwargs) 时，会通过 URL() 构造函数结合此基础 URL 来构建相应的 URL。示例：#
- baseURL: http://localhost:3000 且导航到 /bar.html 结果为 http://localhost:3000/bar.html
- baseURL: http://localhost:3000/foo/ 且导航到 ./bar.html 结果为 http://localhost:3000/foo/bar.html
- baseURL: http://localhost:3000/foo (无尾随斜杠) 且导航到 ./bar.html 结果为 http://localhost:3000/bar.html
bypass_csp <bool> 切换为忽略页面的内容安全策略（Content-Security-Policy）。#
color_scheme <"light"|"dark"|"no-preference"> 模拟 'prefers-colors-scheme' 媒体特性，支持的值为 'light'、'dark'、'no-preference'。详情参阅 page.emulate_media(**kwargs)。默认为 'light'。#
device_scale_factor <float> 指定设备缩放比例（可以理解为 dpr）。默认为 1。#
extra_http_headers <Dict[str, str]> 包含附加 HTTP 头的对象，这些头随每个请求发送。#
forced_colors <"active"|"none"> 模拟 'forced-colors' 媒体特性，支持的值为 'active'、'none'。详情参阅 page.emulate_media(**kwargs)。默认为 'none'。#
geolocation <Dict>#
- latitude <float> 纬度，介于 -90 和 90 之间。
- longitude <float> 经度，介于 -180 和 180 之间。
- accuracy <float> 非负精度值。默认为 0。
has_touch <bool> 指定视口是否支持触摸事件。默认为 false。#
http_credentials <Dict> HTTP 认证的凭据。#
- username <str>
- password <str>
ignore_https_errors <bool> 发送网络请求时是否忽略 HTTPS 错误。默认为 false。#
is_mobile <bool> 是否考虑 meta viewport 标签并启用触摸事件。默认为 false。不支持 Firefox。#
java_script_enabled <bool> 是否在上下文中启用 JavaScript。默认为 true。#
locale <str> 指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式化规则。#
no_viewport <bool> 不强制执行固定视口，允许在有头模式下调整窗口大小。#
offline <bool> 是否模拟网络离线。默认为 false。#
permissions <List[str]> 授予此上下文中所有页面的权限列表。详情参阅 browser_context.grant_permissions(permissions, **kwargs)。#
proxy <Dict> 此上下文使用的网络代理设置。#
- server <str> 用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
- bypass <str> 可选的以逗号分隔的绕过代理的域名，例如 ".com, chromium.org, .domain.com"。
- username <str> 可选的用户名，如果 HTTP 代理需要身份验证。
- password <str> 可选的密码，如果 HTTP 代理需要身份验证。
note
对于 Windows 上的 Chromium，浏览器需要使用全局代理启动才能使此选项生效。如果所有上下文都覆盖了代理，则永远不会使用全局代理，并且可以是任何字符串，例如 launch({ proxy: { server: 'http://per-context' } })。
record_har_content <"omit"|"embed"|"attach"> 控制资源内容管理的可选设置。如果指定 omit，则不持久化内容。如果指定 attach，资源将作为单独的文件持久化，所有这些文件都与 HAR 文件一起归档。默认为 embed，即按照 HAR 规范将内容内联存储在 HAR 文件中。#
record_har_mode <"full"|"minimal"> 当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这将省略从 HAR 重播时不使用的内容大小、时间、页面、Cookie、安全和其他类型的 HAR 信息。默认为 full。#
record_har_omit_content <bool> 控制是否从 HAR 中省略请求内容的可选设置。默认为 false。#
record_har_path <Union[str, pathlib.Path]> 将所有页面的 HAR 录制到文件系统上的指定 HAR 文件中。如果未指定，则不记录 HAR。确保调用 browser_context.close() 以保存 HAR。#
record_har_url_filter <str|Pattern>#
record_video_dir <Union[str, pathlib.Path]> 将所有页面的视频录制到指定目录中。如果未指定，则不录制视频。确保调用 browser_context.close() 以保存视频。#
record_video_size <Dict> 录制视频的尺寸。如果未指定，尺寸将等于按比例缩小以适应 800x800 的 viewport。如果未显式配置 viewport，则视频大小默认为 800x450。每个页面的实际图片将根据需要缩小以适应指定的大小。#
- width <int> 视频帧宽度。
- height <int> 视频帧高度。
reduced_motion <"reduce"|"no-preference"> 模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。详情参阅 page.emulate_media(**kwargs)。默认为 'no-preference'。#
screen <Dict> 通过 window.screen 模拟网页内可用的两个一致的窗口屏幕大小。仅在设置了 viewport 时使用。#
- width <int> 页面宽度（像素）。
- height <int> 页面高度（像素）。
service_workers <"allow"|"block"> 是否允许站点注册 Service workers。默认为 'allow'。#
- 'allow': 可以注册 Service Workers。
- 'block': Playwright 将阻止所有 Service Workers 的注册。
storage_state <Union[str, pathlib.Path]|Dict> 使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state(**kwargs) 获取的已登录信息初始化上下文。可以是保存存储的文件路径，或者是具有以下字段的对象：#
- cookies <List[Dict]> 为上下文设置的 cookie
  - name <str>
  - value <str>
  - domain <str> domain 和 path 是必需的
  - path <str> domain 和 path 是必需的
  - expires <float> Unix 时间（秒）。
  - httpOnly <bool>
  - secure <bool>
  - sameSite <"Strict"|"Lax"|"None"> sameSite 标志
- origins <List[Dict]> 为上下文设置的 localStorage
  - origin <str>
  - localStorage <List[Dict]>
    - name <str>
    - value <str>
strict_selectors <bool> 如果指定，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，所有暗示单个目标 DOM 元素的选择器操作都将抛出异常。有关严格模式的更多信息，请参阅 Locator。#
timezone_id <str> 更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。#
user_agent <str> 在此上下文中使用的特定用户代理。#
viewport <NoneType|Dict> 为每个页面设置一致的视口。默认为 1280x720 视口。no_viewport 禁用固定视口。#
- width <int> 页面宽度（像素）。
- height <int> 页面高度（像素）。
返回值: <BrowserContext>#

创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。

note

如果直接使用此方法创建 BrowserContexts，最佳实践是在代码完成 BrowserContext 的使用后，在调用 browser.close() 之前，通过 browser_context.close() 显式关闭返回的上下文。这将确保 context 被优雅地关闭，并完全刷新和保存任何工件（如 HAR 和视频）。

Sync
Async

browser = playwright.firefox.launch() # 或者 "chromium" 或 "webkit"。
# 创建一个新的隐身浏览器上下文。
context = browser.new_context()
# 在纯净的上下文中创建一个新页面。
page = context.new_page()
page.goto("https://example.com")

# 优雅地关闭所有内容
context.close()
browser.close()

browser = await playwright.firefox.launch() # 或者 "chromium" 或 "webkit"。
# 创建一个新的隐身浏览器上下文。
context = await browser.new_context()
# 在纯净的上下文中创建一个新页面。
page = await context.new_page()
await page.goto("https://example.com")

# 优雅地关闭所有内容
await context.close()
await browser.close()

browser.new_page(**kwargs)

Added in: v1.8

accept_downloads <bool> 是否自动下载所有附件。默认为 true，即接受所有下载。#
base_url <str> 当使用 page.goto(url, **kwargs)、page.route(url, handler, **kwargs)、page.wait_for_url(url, **kwargs)、page.expect_request(url_or_predicate, **kwargs) 或 page.expect_response(url_or_predicate, **kwargs) 时，通过使用 URL() 构造函数构建相应的 URL 来考虑基础 URL。示例：#
- baseURL: http://localhost:3000 且导航到 /bar.html 结果为 http://localhost:3000/bar.html
- baseURL: http://localhost:3000/foo/ 且导航到 ./bar.html 结果为 http://localhost:3000/foo/bar.html
- baseURL: http://localhost:3000/foo (无尾随斜杠) 且导航到 ./bar.html 结果为 http://localhost:3000/bar.html
bypass_csp <bool> 切换为忽略页面的内容安全策略（Content-Security-Policy）。#
color_scheme <"light"|"dark"|"no-preference"> 模拟 'prefers-colors-scheme' 媒体特性，支持的值为 'light'、'dark'、'no-preference'。详情参阅 page.emulate_media(**kwargs)。默认为 'light'。#
device_scale_factor <float> 指定设备缩放比例（可以理解为 dpr）。默认为 1。#
extra_http_headers <Dict[str, str]> 包含附加 HTTP 头的对象，这些头随每个请求发送。#
forced_colors <"active"|"none"> 模拟 'forced-colors' 媒体特性，支持的值为 'active'、'none'。详情参阅 page.emulate_media(**kwargs)。默认为 'none'。#
geolocation <Dict>#
- latitude <float> 纬度，介于 -90 和 90 之间。
- longitude <float> 经度，介于 -180 和 180 之间。
- accuracy <float> 非负精度值。默认为 0。
has_touch <bool> 指定视口是否支持触摸事件。默认为 false。#
http_credentials <Dict> HTTP 认证的凭据。#
- username <str>
- password <str>
ignore_https_errors <bool> 发送网络请求时是否忽略 HTTPS 错误。默认为 false。#
is_mobile <bool> 是否考虑 meta viewport 标签并启用触摸事件。默认为 false。不支持 Firefox。#
java_script_enabled <bool> 是否在上下文中启用 JavaScript。默认为 true。#
locale <str> 指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式化规则。#
no_viewport <bool> 不强制执行固定视口，允许在有头模式下调整窗口大小。#
offline <bool> 是否模拟网络离线。默认为 false。#
permissions <List[str]> 授予此上下文中所有页面的权限列表。详情参阅 browser_context.grant_permissions(permissions, **kwargs)。#
proxy <Dict> 此上下文使用的网络代理设置。#
- server <str> 用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
- bypass <str> 可选的以逗号分隔的绕过代理的域名，例如 ".com, chromium.org, .domain.com"。
- username <str> 可选的用户名，如果 HTTP 代理需要身份验证。
- password <str> 可选的密码，如果 HTTP 代理需要身份验证。
note
对于 Windows 上的 Chromium，浏览器需要使用全局代理启动才能使此选项生效。如果所有上下文都覆盖了代理，则永远不会使用全局代理，并且可以是任何字符串，例如 launch({ proxy: { server: 'http://per-context' } })。
record_har_content <"omit"|"embed"|"attach"> 控制资源内容管理的可选设置。如果指定 omit，则不持久化内容。如果指定 attach，资源将作为单独的文件持久化，所有这些文件都与 HAR 文件一起归档。默认为 embed，即按照 HAR 规范将内容内联存储在 HAR 文件中。#
record_har_mode <"full"|"minimal"> 当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这将省略从 HAR 重播时不使用的内容大小、时间、页面、Cookie、安全和其他类型的 HAR 信息。默认为 full。#
record_har_omit_content <bool> 控制是否从 HAR 中省略请求内容的可选设置。默认为 false。#
record_har_path <Union[str, pathlib.Path]> 将所有页面的 HAR 录制到文件系统上的指定 HAR 文件中。如果未指定，则不记录 HAR。确保调用 browser_context.close() 以保存 HAR。#
record_har_url_filter <str|Pattern>#
record_video_dir <Union[str, pathlib.Path]> 将所有页面的视频录制到指定目录中。如果未指定，则不录制视频。确保调用 browser_context.close() 以保存视频。#
record_video_size <Dict> 录制视频的尺寸。如果未指定，尺寸将等于按比例缩小以适应 800x800 的 viewport。如果未显式配置 viewport，则视频大小默认为 800x450。每个页面的实际图片将根据需要缩小以适应指定的大小。#
- width <int> 视频帧宽度。
- height <int> 视频帧高度。
reduced_motion <"reduce"|"no-preference"> 模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。详情参阅 page.emulate_media(**kwargs)。默认为 'no-preference'。#
screen <Dict> 通过 window.screen 模拟网页内可用的两个一致的窗口屏幕大小。仅在设置了 viewport 时使用。#
- width <int> 页面宽度（像素）。
- height <int> 页面高度（像素）。
service_workers <"allow"|"block"> 是否允许站点注册 Service workers。默认为 'allow'。#
- 'allow': 可以注册 Service Workers。
- 'block': Playwright 将阻止所有 Service Workers 的注册。
storage_state <Union[str, pathlib.Path]|Dict> 使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state(**kwargs) 获取的已登录信息初始化上下文。可以是保存存储的文件路径，或者是具有以下字段的对象：#
- cookies <List[Dict]> 为上下文设置的 cookie
  - name <str>
  - value <str>
  - domain <str> domain 和 path 是必需的
  - path <str> domain 和 path 是必需的
  - expires <float> Unix 时间（秒）。
  - httpOnly <bool>
  - secure <bool>
  - sameSite <"Strict"|"Lax"|"None"> sameSite 标志
- origins <List[Dict]> 为上下文设置的 localStorage
  - origin <str>
  - localStorage <List[Dict]>
    - name <str>
    - value <str>
strict_selectors <bool> 如果指定，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，所有暗示单个目标 DOM 元素的选择器操作都将抛出异常。有关严格模式的更多信息，请参阅 Locator。#
timezone_id <str> 更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。#
user_agent <str> 在此上下文中使用的特定用户代理。#
viewport <NoneType|Dict> 为每个页面设置一致的视口。默认为 1280x720 视口。no_viewport 禁用固定视口。#
- width <int> 页面宽度（像素）。
- height <int> 页面高度（像素）。
返回值: <Page>#

在一个新的浏览器上下文中创建一个新页面。关闭此页面将同时关闭该上下文。

这是一个便利 API，应仅用于单页场景和简短的代码片段。生产代码和测试框架应明确创建 browser.new_context(**kwargs)，然后调用 browser_context.new_page() 来控制它们的确切生命周期。

browser.start_tracing(**kwargs)

Added in: v1.11

page <Page> 可选，如果指定，跟踪将包含给定页面的屏幕截图。#
categories <List[str]> 指定要使用的自定义类别以替换默认类别。#
path <Union[str, pathlib.Path]> 将跟踪文件写入的路径。#
screenshots <bool> 在跟踪中捕获屏幕截图。#
返回值: <NoneType>#

note

此 API 控制 Chromium Tracing，这是一个低级 Chromium 特定调试工具。控制 Playwright Tracing 的 API 可以在这里找到。

你可以使用 browser.start_tracing(**kwargs) 和 browser.stop_tracing() 创建一个可以在 Chrome DevTools 性能面板中打开的跟踪文件。

Sync
Async

browser.start_tracing(page, path="trace.json")
page.goto("https://www.google.com")
browser.stop_tracing()

await browser.start_tracing(page, path="trace.json")
await page.goto("https://www.google.com")
await browser.stop_tracing()

browser.stop_tracing()

Added in: v1.11

返回值: <bytes>#

note

此 API 控制 Chromium Tracing，这是一个低级 Chromium 特定调试工具。控制 Playwright Tracing 的 API 可以在这里找到。

返回包含跟踪数据的缓冲区。

browser.version

Added in: v1.8

返回值: <str>#

返回浏览器版本。

browser.on("disconnected")​

browser.browser_type​

browser.close()​

browser.contexts​

browser.is_connected()​

browser.new_browser_cdp_session()​

browser.new_context(**kwargs)​

browser.new_page(**kwargs)​

browser.start_tracing(**kwargs)​

browser.stop_tracing()​

browser.version​

browser.on("disconnected")

browser.browser_type

browser.close()

browser.contexts

browser.is_connected()

browser.new_browser_cdp_session()

browser.new_context(**kwargs)

browser.new_page(**kwargs)

browser.start_tracing(**kwargs)

browser.stop_tracing()

browser.version