BrowserType

BrowserType 提供了启动特定浏览器实例或连接到已有实例的方法。下面是一个使用 Playwright 进行自动化的典型示例：

同步
异步

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = chromium.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, Playwright

async def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = await chromium.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())

方法

connect

v1.9 之前添加

browserType.connect

该方法将 Playwright 附加到一个已通过 Node.js 中的 BrowserType.launchServer 创建的浏览器实例。

备注

连接的 Playwright 实例的主版本号和次版本号需要与启动浏览器的 Playwright 版本一致（例如 1.2.3 → 兼容 1.2.x）。

用法

browser_type.connect(ws_endpoint)
browser_type.connect(ws_endpoint, **kwargs)

参数

ws_endpoint str v1.10 添加#

要连接的 Playwright 浏览器 websocket 端点。你可以通过 BrowserServer.wsEndpoint 获取该端点。
expose_network str (可选) v1.37 添加#

此选项会将连接客户端可用的网络暴露给被连接的浏览器。由逗号分隔的规则列表组成。

可用规则：
1. 主机名模式，例如：example.com、*.org:99、x.*.y.com、*foo.org。
2. IP 字面量，例如：127.0.0.1、0.0.0.0:99、[::1]、[0:0::1]:99。
3. <loopback> 匹配本地回环接口：localhost、*.localhost、127.0.0.1、[::1]。
一些常见示例：
1. "*" 暴露所有网络。
2. "<loopback>" 仅暴露本地回环网络。
3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" 暴露测试/预发布环境和本地回环。
headers Dict[str, str] (可选) v1.11 添加#

连接 websocket 时要发送的额外 HTTP 头。可选。
slow_mo float (可选) v1.10 添加#

以毫秒为单位减慢 Playwright 操作的速度。便于观察操作过程。默认值为 0。
timeout float (可选) v1.10 添加#

等待连接建立的最大时间（毫秒）。默认为 0（不超时）。

返回值

Browser #

connect_over_cdp

v1.9 添加

browserType.connect_over_cdp

该方法通过 Chrome DevTools 协议（CDP）将 Playwright 附加到一个已存在的浏览器实例。

默认浏览器上下文可通过 browser.contexts 访问。

备注

通过 Chrome DevTools 协议连接仅支持 Chromium 内核的浏览器。

备注

该连接方式的功能完整性明显低于通过 browser_type.connect() 的 Playwright 协议连接。如果你遇到问题或需要使用高级功能，建议优先使用 browser_type.connect()。

用法

同步
异步

browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
default_context = browser.contexts[0]
page = default_context.pages[0]

browser = await playwright.chromium.connect_over_cdp("http://localhost:9222")
default_context = browser.contexts[0]
page = default_context.pages[0]

参数

endpoint_url str v1.11 添加#

要连接的 CDP websocket 端点或 http 地址。例如 http://localhost:9222/ 或 ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。
headers Dict[str, str] (可选) v1.11 添加#

连接请求时要发送的额外 HTTP 头。可选。
slow_mo float (可选) v1.11 添加#

以毫秒为单位减慢 Playwright 操作的速度。便于观察操作过程。默认值为 0。
timeout float (可选) v1.11 添加#

等待连接建立的最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。

返回值

Browser #

launch

v1.9 之前添加

browserType.launch

返回浏览器实例。

用法

你可以使用 ignore_default_args 过滤默认参数中的 --mute-audio：

同步
异步

browser = playwright.chromium.launch( # 或 "firefox" 或 "webkit"。
    ignore_default_args=["--mute-audio"]
)

browser = await playwright.chromium.launch( # 或 "firefox" 或 "webkit"。
    ignore_default_args=["--mute-audio"]
)

仅限 Chromium Playwright 也可以用于控制 Google Chrome 或 Microsoft Edge 浏览器，但它与自带的 Chromium 版本配合效果最佳。无法保证能与其他版本兼容。使用 executable_path 选项时请务必小心。

如果你更倾向于使用 Google Chrome（而不是 Chromium），建议使用 Chrome Canary 或 Dev Channel 版本。

像 Google Chrome 和 Microsoft Edge 这样的官方浏览器适用于需要专有媒体编解码器进行视频播放的测试。关于 Chromium 和 Chrome 之间的其他区别，请参阅这篇文章。这篇文章介绍了 Linux 用户下的部分差异。

参数

args List[str] (可选)#

注意
自定义浏览器参数需谨慎使用，部分参数可能会导致 Playwright 功能异常。

传递给浏览器实例的额外参数。Chromium 的参数列表可参考这里。
channel str (可选)#

浏览器发行渠道。

使用 "chromium" 可启用新版无头模式。

使用 "chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev" 或 "msedge-canary" 可使用品牌版 Google Chrome 和 Microsoft Edge。
chromium_sandbox bool (可选)#

启用 Chromium 沙箱。默认值为 false。
devtools bool (可选)#

已废弃
请使用调试工具代替。

仅限 Chromium 是否为每个标签页自动打开开发者工具面板。如果该选项为 true，headless 选项会被设置为 false。
downloads_path Union[str, pathlib.Path] (可选)#

如果指定，已接受的下载内容将保存到该目录。否则会创建临时目录，并在浏览器关闭时删除。在任意情况下，下载内容会在其所属的浏览器上下文关闭时被删除。
env Dict[str, str | float | bool] (可选)#

指定对浏览器可见的环境变量。默认值为 process.env。
executable_path Union[str, pathlib.Path] (可选)#

指定要运行的浏览器可执行文件路径，替代自带的浏览器。如果 executable_path 是相对路径，则相对于当前工作目录解析。注意 Playwright 仅保证与自带的 Chromium、Firefox 或 WebKit 兼容，其他版本请谨慎使用。
firefox_user_prefs Dict[str, str | float | bool] (可选)#

Firefox 用户偏好设置。了解更多请参阅 about:config。
handle_sighup bool (可选)#

收到 SIGHUP 信号时关闭浏览器进程。默认值为 true。
handle_sigint bool (可选)#

按下 Ctrl-C 时关闭浏览器进程。默认值为 true。
handle_sigterm bool (可选)#

收到 SIGTERM 信号时关闭浏览器进程。默认值为 true。
headless bool (可选)#

是否以无头模式运行浏览器。更多关于 Chromium 和 Firefox 的说明。默认值为 true，除非 devtools 选项为 true。
ignore_default_args bool | List[str] (可选)#

如果为 true，Playwright 不会传递自身的配置参数，仅使用 args 中的参数。如果传递数组，则会过滤掉指定的默认参数。该选项较为危险，请谨慎使用。默认值为 false。
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 代理需要认证时使用的密码。
网络代理设置。
slow_mo float (可选)#

以毫秒为单位减慢 Playwright 操作速度。便于观察操作过程。
timeout float (可选)#

等待浏览器实例启动的最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。
traces_dir Union[str, pathlib.Path] (可选)#

如果指定，跟踪文件将保存到该目录。

返回值

Browser #

launch_persistent_context

v1.9 之前添加

browserType.launch_persistent_context

返回持久化浏览器上下文实例。

启动一个使用 user_data_dir 指定的持久化存储的浏览器，并返回唯一的上下文。关闭该上下文会自动关闭浏览器。

用法

browser_type.launch_persistent_context(user_data_dir)
browser_type.launch_persistent_context(user_data_dir, **kwargs)

参数

user_data_dir Union[str, pathlib.Path]#

用户数据目录的路径，用于存储浏览器会话数据，如 cookies 和本地存储。传入空字符串会创建一个临时目录。

Chromium 相关说明和 Firefox 相关说明。Chromium 的用户数据目录是 chrome://version 页面中“Profile Path”的父级目录。

注意：浏览器不允许使用同一个用户数据目录同时启动多个实例。
accept_downloads bool (可选)#

是否自动接受所有下载的附件。默认为 true，即自动接受所有下载。
args List[str] (可选)#

注意
自定义浏览器参数需谨慎使用，部分参数可能会导致 Playwright 功能异常。

传递给浏览器实例的额外参数。Chromium 的参数列表可参考这里。
base_url str (可选)#

在使用 page.goto()、page.route()、page.wait_for_url()、page.expect_request() 或 page.expect_response() 时，会通过 URL() 构造函数基于 base 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。默认为 false。
channel str (可选)#

浏览器发行渠道。

使用 "chromium" 可启用新版无头模式。

使用 "chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev" 或 "msedge-canary" 可使用品牌版 Google Chrome 和 Microsoft Edge。
chromium_sandbox bool (可选)#

启用 Chromium 沙箱。默认值为 false。
client_certificates List[Dict] (可选) v1.46 添加#
- origin str
  
  证书有效的精确 origin。origin 包含 https 协议、主机名和可选端口。
- certPath Union[str, pathlib.Path] (可选)
  
  PEM 格式证书文件的路径。
- cert bytes (可选)
  
  PEM 格式证书的直接内容。
- keyPath Union[str, pathlib.Path] (可选)
  
  PEM 格式私钥文件的路径。
- key bytes (可选)
  
  PEM 格式私钥的直接内容。
- pfxPath Union[str, pathlib.Path] (可选)
  
  PFX 或 PKCS12 编码的私钥和证书链文件路径。
- pfx bytes (可选)
  
  PFX 或 PKCS12 编码的私钥和证书链的直接内容。
- passphrase str (可选)
  
  私钥（PEM 或 PFX）的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。

详细说明

要使用的客户端证书数组。每个证书对象必须同时包含 certPath 和 keyPath，或仅包含 pfxPath，或对应的直接内容（cert 和 key，或 pfx）。如证书已加密，可选填 passphrase 属性。origin 属性需与请求的 origin 完全匹配。

备注
在 macOS 上使用 WebKit 时，访问 localhost 不会自动使用客户端证书。可将 localhost 替换为 local.playwright 以生效。
color_scheme "light" | "dark" | "no-preference" | "null" (可选)#

模拟 prefers-colors-scheme 媒体特性，支持的值有 'light' 和 'dark'。更多细节见 page.emulate_media()。传入 'null' 可重置为系统默认。默认值为 'light'。
contrast "no-preference" | "more" | "null" (可选)#

模拟 'prefers-contrast' 媒体特性，支持的值有 'no-preference'、'more'。更多细节见 page.emulate_media()。传入 'null' 可重置为系统默认。默认值为 'no-preference'。
device_scale_factor float (可选)#

指定设备像素比（可理解为 dpr）。默认值为 1。了解更多关于设备像素比模拟。
devtools bool (可选)#

已废弃
请使用调试工具代替。

仅限 Chromium 是否为每个标签页自动打开开发者工具面板。如果该选项为 true，headless 选项会被设置为 false。
downloads_path Union[str, pathlib.Path] (可选)#

如果指定，已接受的下载内容将保存到该目录。否则会创建临时目录，并在浏览器关闭时删除。在任意情况下，下载内容会在其所属的浏览器上下文关闭时被删除。
env Dict[str, str | float | bool] (可选)#

指定对浏览器可见的环境变量。默认值为 process.env。
executable_path Union[str, pathlib.Path] (可选)#

指定要运行的浏览器可执行文件路径，替代自带的浏览器。如果 executable_path 是相对路径，则相对于当前工作目录解析。注意 Playwright 仅保证与自带的 Chromium、Firefox 或 WebKit 兼容，其他版本请谨慎使用。
extra_http_headers Dict[str, str] (可选)#

包含每个请求要发送的额外 HTTP 头的对象。默认无。
firefox_user_prefs Dict[str, str | float | bool] (可选) v1.40 添加#

Firefox 用户偏好设置。了解更多请参阅 about:config。
forced_colors "active" | "none" | "null" (可选)#

模拟 'forced-colors' 媒体特性，支持的值有 'active'、'none'。更多细节见 page.emulate_media()。传入 'null' 可重置为系统默认。默认值为 'none'。
geolocation Dict (可选)#
- latitude float
  
  纬度，范围 -90 到 90。
- longitude float
  
  经度，范围 -180 到 180。
- accuracy float (可选)
  
  非负精度值。默认值为 0。
handle_sighup bool (可选)#

收到 SIGHUP 信号时关闭浏览器进程。默认值为 true。
handle_sigint bool (可选)#

按下 Ctrl-C 时关闭浏览器进程。默认值为 true。
handle_sigterm bool (可选)#

收到 SIGTERM 信号时关闭浏览器进程。默认值为 true。
has_touch bool (可选)#

是否支持触摸事件。默认值为 false。了解更多关于移动端模拟。
headless bool (可选)#

是否以无头模式运行浏览器。更多关于 Chromium 和 Firefox 的说明。默认值为 true，除非 devtools 选项为 true。
http_credentials Dict (可选)#
- username str
- password str
- origin str (可选)
  
  限定仅在指定 origin（scheme://host:port）发送 http 认证信息。
- send "unauthorized" | "always" (可选)
  
  该选项仅影响通过对应 APIRequestContext 发送的请求，不影响浏览器发出的请求。'always' - 每个 API 请求都带上带有基本认证信息的 Authorization 头。'unauthorized' - 仅在收到带有 WWW-Authenticate 头的 401（未授权）响应时发送认证信息。默认值为 'unauthorized'。
HTTP 认证凭据。如果未指定 origin，用户名和密码会在收到未授权响应时发送给任意服务器。
ignore_default_args bool | List[str] (可选)#

如果为 true，Playwright 不会传递自身的配置参数，仅使用 args 中的参数。如果传递数组，则会过滤掉指定的默认参数。该选项较为危险，请谨慎使用。默认值为 false。
ignore_https_errors bool (可选)#

发送网络请求时是否忽略 HTTPS 错误。默认值为 false。
is_mobile bool (可选)#

是否启用 meta viewport 标签和触摸事件。isMobile 是设备配置的一部分，通常无需手动设置。默认值为 false，Firefox 不支持。了解更多关于移动端模拟。
java_script_enabled bool (可选)#

是否启用 JavaScript。默认值为 true。了解更多关于禁用 JavaScript。
locale str (可选)#

指定用户区域设置，例如 en-GB、de-DE 等。locale 会影响 navigator.language、Accept-Language 请求头以及数字和日期格式。默认使用系统区域设置。更多模拟说明见模拟指南。
no_viewport bool (可选)#

不强制固定视口，允许在有界面模式下调整窗口大小。
offline bool (可选)#

是否模拟网络离线。默认值为 false。了解更多关于网络模拟。
permissions List[str] (可选)#

要授予该上下文所有页面的权限列表。详见 browser_context.grant_permissions()。默认无。
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 代理需要认证时使用的密码。
网络代理设置。
record_har_content "omit" | "embed" | "attach" (可选)#

控制资源内容管理的可选设置。若为 omit，则不保存内容。若为 attach，资源以单独文件保存，并与 HAR 文件一起归档。默认值为 embed，即内容内嵌于 HAR 文件中，符合 HAR 规范。
record_har_mode "full" | "minimal" (可选)#

设置为 minimal 时，仅记录 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 (可选)#
- width int
  
  视频帧宽度。
- height int
  
  视频帧高度。
录制视频的尺寸。如果未指定，尺寸等于 viewport，并缩放至不超过 800x800。如果未显式配置 viewport，则视频尺寸默认为 800x450。每个页面的实际画面会根据需要缩放以适应指定尺寸。
reduced_motion "reduce" | "no-preference" | "null" (可选)#

模拟 'prefers-reduced-motion' 媒体特性，支持的值有 'reduce'、'no-preference'。更多细节见 page.emulate_media()。传入 'null' 可重置为系统默认。默认值为 'no-preference'。
screen Dict (可选)#
- width int
  
  页面宽度（像素）。
- height int
  
  页面高度（像素）。
模拟网页内通过 window.screen 可用的窗口屏幕尺寸。仅在设置了 viewport 时生效。
service_workers "allow" | "block" (可选)#

是否允许站点注册 Service Worker。默认值为 'allow'。
- 'allow'：Service Worker 可以注册。
- 'block'：Playwright 会阻止所有 Service Worker 注册。
slow_mo float (可选)#

以毫秒为单位减慢 Playwright 操作速度。便于观察操作过程。
strict_selectors bool (可选)#

若设置为 true，则为该上下文启用严格选择器模式。在严格模式下，所有要求唯一目标元素的选择器操作，如果匹配到多个元素会抛出异常。该选项不影响 Locator API（Locator 始终为严格模式）。默认值为 false。详见 Locator 了解严格模式。
timeout float (可选)#

等待浏览器实例启动的最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。
timezone_id str (可选)#

更改上下文的时区。支持的时区 ID 见 ICU 的 metaZones.txt。默认使用系统时区。
traces_dir Union[str, pathlib.Path] (可选)#

如果指定，跟踪文件将保存到该目录。
user_agent str (可选)#

指定该上下文使用的 User-Agent。
viewport NoneType | Dict (可选)#
- width int
  
  页面宽度（像素）。
- height int
  
  页面高度（像素）。
为每个页面设置一致的视口。默认视口为 1280x720。no_viewport 可禁用固定视口。了解更多关于视口模拟。

返回值

BrowserContext #

属性

executable_path

v1.9 之前添加

browserType.executable_path

Playwright 期望查找内置浏览器可执行文件的路径。

用法

browser_type.executable_path

返回值

str #

name

v1.9 之前添加

browserType.name

返回浏览器名称。例如：'chromium'、'webkit' 或 'firefox'。

用法

browser_type.name

返回值

str #

方法​

connect​

connect_over_cdp​

launch​

launch_persistent_context​

属性​

executable_path​

name​

方法

connect

connect_over_cdp

launch

launch_persistent_context

属性

executable_path

name