BrowserType

BrowserType 提供了启动特定浏览器实例或连接到现有实例的方法。以下是使用 Playwright 驱动自动化的典型示例：

Sync
异步

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")
    # other actions...
    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")
    # other actions...
    await browser.close()

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

方法

连接

Added before v1.9

browserType.connect

此方法将Playwright附加到通过Node.js中的BrowserType.launchServer创建的现有浏览器实例。

note

连接到的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. 匹配本地环回接口：localhost, *.localhost, 127.0.0.1, [::1]。
一些常见示例：
1. "*" 用于暴露所有网络。
2. "" 用于暴露本地主机网络。
3. "*.test.internal-domain,*.staging.internal-domain," 用于暴露测试/预发布部署环境和本地主机。
headers Dict[str, str] (可选) 添加于: v1.11 #

用于WebSocket连接请求的额外HTTP头信息。可选。
slow_mo float (可选) 添加于: v1.10 #

通过指定的毫秒数减慢Playwright操作速度。有助于观察操作过程。默认为0。
timeout float (可选) 添加于: v1.10 #

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

Browser #

通过CDP连接

Added in: v1.9

browserType.connect_over_cdp

此方法使用Chrome开发者工具协议将Playwright附加到现有的浏览器实例上。

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

note

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

note

此连接的保真度明显低于通过browser_type.connect()建立的Playwright协议连接。如果您遇到问题或尝试使用高级功能，您可能需要使用browser_type.connect()。

用法

Sync
异步

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 URL。例如 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 (optional) v1.11版本新增 #

将Playwright操作速度减慢指定的毫秒数。有助于观察操作过程。默认为0。
timeout float (可选) 添加于: v1.11 #

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

Browser #

启动

Added before v1.9

browserType.launch

返回浏览器实例。

用法

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

Sync
异步

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

browser = await playwright.chromium.launch( # or "firefox" or "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] (optional)#

Firefox用户偏好设置。了解更多关于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

Added before 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()构造函数考虑基础URL来构建相应的URL。默认情况下未设置。示例：
- baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
- baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
- baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
bypass_csp bool (可选)#

切换绕过页面的内容安全策略。默认为 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] (可选) 添加于: 1.46 #
- origin str
  
  证书有效的精确来源。来源包括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属性应提供与证书适用的请求来源完全匹配的值。

note
在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。了解更多关于emulating devices with device scale factor的信息。
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用户偏好设置。了解更多关于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 (可选)
  
  限制在特定来源(scheme://host:port)上发送http凭据。
- send "unauthorized" | "always" (可选)
  
  此选项仅适用于从对应APIRequestContext发送的请求，不会影响从浏览器发送的请求。'always' - 每个API请求都会附带包含基本认证凭据的Authorization头部。'unauthorized - 仅当收到带有WWW-Authenticate头部的401(未授权)响应时才发送凭据。默认为'unauthorized'。
HTTP认证的凭据。如果未指定来源，则在收到未经授权的响应时，用户名和密码将被发送到任何服务器。
ignore_default_args bool | List[str] (可选)#

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

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

是否考虑meta viewport标签并启用触摸事件。isMobile是设备的一部分，因此实际上不需要手动设置它。默认为false，并且在Firefox中不受支持。了解更多关于mobile emulation的信息。
java_script_enabled bool (可选)#

是否在上下文中启用JavaScript。默认为true。了解更多关于禁用JavaScript的信息。
locale str (可选)#

指定用户区域设置，例如 en-GB、de-DE 等。区域设置会影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。
no_viewport bool (可选)#

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

是否模拟网络离线状态。默认为 false。了解更多关于网络模拟的信息。
permissions List[str] (optional)#

授予此上下文中所有页面的权限列表。详情请参阅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路由所需的信息。这将省略大小、时间、页面、cookies、安全和其他类型的HAR信息，这些信息在从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 workers。默认为'allow'。
- 'allow': 可以注册Service Workers。
- 'block': Playwright 将阻止所有 Service Workers 的注册。
slow_mo float (可选)#

将Playwright操作速度减慢指定的毫秒数。这个功能很有用，可以让你看清操作过程。
strict_selectors bool (可选)#

如果设置为true，为此上下文启用严格选择器模式。在严格选择器模式下，所有暗示单个目标DOM元素的选择器操作在匹配到多个元素时将抛出异常。此选项不影响任何Locator API（Locator始终是严格的）。默认为false。有关严格模式的更多信息，请参阅Locator。
timeout float (可选)#

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

更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。
traces_dir Union[str, pathlib.Path] (可选参数)#

如果指定该参数，追踪记录将被保存到此目录中。
user_agent str (可选)#

在此上下文中使用的特定用户代理。
viewport NoneType | Dict (可选)#
- width int
  
  页面宽度，单位为像素。
- height int
  
  页面高度，单位为像素。
为每个页面设置一致的视口。默认视口大小为1280x720。no_viewport可禁用固定视口。了解更多关于视口模拟的信息。

BrowserContext #

属性

executable_path

Added before v1.9

browserType.executable_path

Playwright预期查找捆绑浏览器可执行文件的路径。

用法

browser_type.executable_path

str #

名称

Added before v1.9

browserType.name

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

用法

browser_type.name

str #

方法​

连接​

通过CDP连接​

启动​

launch_persistent_context​

属性​

executable_path​

名称​

方法

连接

通过CDP连接

启动

launch_persistent_context

属性

executable_path

名称