浏览器类型

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

方法

连接

在 v1.9 之前添加

browserType.connect

此方法将 Playwright 附加到现有的浏览器实例。当连接到通过 Node.js 中的 BrowserType.launchServer 启动的另一个浏览器时，主版本和次版本需要与客户端版本匹配（1.2.3 → 与 1.2.x 兼容）。

用法

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

参数

ws_endpoint str添加于：v1.10#

要连接到的浏览器 WebSocket 端点。
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 #

通过 CDP 连接

添加于：v1.9

browserType.connect_over_cdp

此方法使用 Chrome DevTools 协议将 Playwright 附加到现有的浏览器实例。

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

注意

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

用法

同步
异步

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

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

参数

endpoint_url str添加于：v1.11#

要连接到的 CDP WebSocket 端点或 HTTP URL。例如 https://127.0.0.1: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 #

启动

在 v1.9 之前添加

browserType.launch

返回浏览器实例。

用法

您可以使用 ignore_default_args 从默认参数中过滤掉 --mute-audio

同步
异步

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 或开发渠道版本。

像 Google Chrome 和 Microsoft Edge 这样的常用浏览器适用于需要专有媒体编解码器进行视频播放的测试。有关 Chromium 和 Chrome 之间其他差异的信息，请参阅本文。本文描述了 Linux 用户的一些差异。

参数

args List[str] (可选)#

警告
自行承担使用自定义浏览器参数的风险，因为其中一些参数可能会破坏 Playwright 的功能。

要传递给浏览器实例的其他参数。Chromium 标志列表可以在这里找到这里。
channel str (可选)#

浏览器分发渠道。支持的值为“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 用户偏好设置。了解有关 Firefox 用户偏好设置的更多信息，请访问 about:config。
handle_sighup bool (可选)#

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

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

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

是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 devtools 选项为 true，否则默认为 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]#

用户数据目录的路径，其中存储浏览器会话数据，例如 cookie 和本地存储。有关 Chromium 和 Firefox 的更多详细信息。请注意，Chromium 的用户数据目录是 chrome://version 中显示的“配置文件路径”的**父**目录。传递空字符串以使用临时目录。
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: https://127.0.0.1:3000 并且导航到 /bar.html 会导致 https://127.0.0.1:3000/bar.html
- baseURL: https://127.0.0.1:3000/foo/ 并且导航到 ./bar.html 会导致 https://127.0.0.1:3000/foo/bar.html
- baseURL: https://127.0.0.1:3000/foo（没有尾部斜杠）并且导航到 ./bar.html 会导致 https://127.0.0.1:3000/bar.html
bypass_csp bool (可选)#

切换是否绕过页面的内容安全策略。默认为 false。
channel str (可选)#

浏览器分发渠道。支持的值为“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属性提供。

注意
在 macOS 上使用 WebKit 时，访问localhost将不会获取客户端证书。您可以通过将localhost替换为local.playwright来使其工作。
color_scheme "light" | "dark" | "no-preference" | "null" (可选)#

模拟'prefers-colors-scheme'媒体特性，支持的值为'light'、'dark'、'no-preference'。有关更多详细信息，请参阅page.emulate_media()。传递'null'将模拟重置为系统默认值。默认为'light'。
device_scale_factor 浮点数 (可选)#

指定设备缩放因子（可视为 dpr）。默认为1。详细了解使用设备缩放因子模拟设备。
devtools 布尔值 (可选)#

已弃用
改用调试工具。

仅限 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为true，则headless选项将设置为false。
downloads_path 联合类型[字符串, pathlib.Path] (可选)#

如果指定，则接受的下载将下载到此目录中。否则，将创建临时目录，并在浏览器关闭时删除。在这两种情况下，在创建它们的浏览器上下文关闭时，下载都会被删除。
env 字典[字符串, 字符串 | 浮点数 | 布尔值] (可选)#

指定浏览器可见的环境变量。默认为 process.env。
executable_path 联合类型[字符串, pathlib.Path] (可选)#

要运行的浏览器可执行文件的路径，而不是捆绑的可执行文件。如果executable_path是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，请自行承担风险使用。
extra_http_headers 字典[字符串, 字符串] (可选)#

包含要与每个请求一起发送的其他 HTTP 标头的对象。默认为无。
firefox_user_prefs 字典[字符串, 字符串 | 浮点数 | 布尔值] (可选)新增于：v1.40#

Firefox 用户偏好设置。了解有关 Firefox 用户偏好设置的更多信息，请访问 about:config。
forced_colors "active" | "none" | "null" (可选)#

模拟'forced-colors'媒体特性，支持的值为'active'、'none'。有关更多详细信息，请参阅page.emulate_media()。传递'null'将模拟重置为系统默认值。默认为'none'。
geolocation 字典 (可选)#
- latitude 浮点数
  
  -90 到 90 之间的纬度。
- longitude 浮点数
  
  -180 到 180 之间的经度。
- accuracy 浮点数 (可选)
  
  非负精度值。默认为0。
handle_sighup 布尔值 (可选)#

在 SIGHUP 信号时关闭浏览器进程。默认为 true。
handle_sigint 布尔值 (可选)#

在 Ctrl-C 时关闭浏览器进程。默认为 true。
handle_sigterm 布尔值 (可选)#

在 SIGTERM 信号时关闭浏览器进程。默认为 true。
has_touch 布尔值 (可选)#

指定视口是否支持触摸事件。默认为 false。详细了解移动模拟。
headless 布尔值 (可选)#

是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 devtools 选项为 true，否则默认为 true。
http_credentials 字典 (可选)#
- username 字符串
- password 字符串
- origin 字符串 (可选)
  
  限制在特定来源（方案://主机:端口）上发送 HTTP 凭据。).
- send "unauthorized" | "always" (可选)
  
  此选项仅适用于从相应的APIRequestContext发送的请求，不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的Authorization标头。'unauthorized - 仅在收到带有WWW-Authenticate标头的 401（未授权）响应时才发送凭据。默认为'unauthorized'。
用于HTTP 身份验证的凭据。如果未指定来源，则在收到未授权的响应时，用户名和密码将发送到任何服务器。
ignore_default_args 布尔值 | 列表[字符串] (可选)#

如果为true，则 Playwright 不会传递其自己的配置参数，而仅使用来自args的参数。如果给定一个数组，则过滤掉给定的默认参数。危险选项；谨慎使用。默认为false。
ignore_https_errors 布尔值 (可选)#

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

是否考虑meta viewport标签并启用触摸事件。isMobile 是设备的一部分，因此您实际上不需要手动设置它。默认为false，并且在 Firefox 中不受支持。详细了解移动模拟。
java_script_enabled 布尔值 (可选)#

是否在上下文中启用 JavaScript。默认为true。详细了解禁用 JavaScript。
locale 字符串 (可选)#

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

不强制使用固定视口，允许在 headed 模式下调整窗口大小。
offline 布尔值 (可选)#

是否模拟网络离线状态。默认为 false。了解更多关于网络模拟。
permissions 列表[字符串] (可选)#

授予此上下文中的所有页面的一系列权限。有关更多详细信息，请参阅 browser_context.grant_permissions()。默认为无。
proxy 字典 (可选)#
- 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 播放时未使用的其他类型的 HAR 信息。默认为 full。
record_har_omit_content 布尔值 (可选)#

可选设置，用于控制是否从 HAR 中省略请求内容。默认为 false。
record_har_path 联合类型[字符串, pathlib.Path] (可选)#

为所有页面启用 HAR 记录到文件系统上的指定 HAR 文件中。如果未指定，则不会记录 HAR。确保调用 browser_context.close() 以保存 HAR。
record_har_url_filter 字符串 | 模式 (可选)#
record_video_dir 联合类型[字符串, pathlib.Path] (可选)#

为所有页面启用视频录制到指定的目录中。如果未指定，则不会录制视频。确保调用 browser_context.close() 以保存视频。
record_video_size 字典 (可选)#
- width 整数
  
  视频帧宽度。
- height 整数
  
  视频帧高度。
录制视频的尺寸。如果未指定，则大小将等于缩放到适合 800x800 的 viewport。如果未显式配置 viewport，则视频大小默认为 800x450。如果需要，每个页面的实际图片将缩小以适合指定的大小。
reduced_motion "reduce" | "no-preference" | "null" (可选)#

模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。有关更多详细信息，请参阅 page.emulate_media()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'。
screen 字典 (可选)#
- width 整数
  
  页面宽度（以像素为单位）。
- height 整数
  
  页面高度（以像素为单位）。
模拟通过 window.screen 在网页内部可用的固定窗口屏幕尺寸。仅当 viewport 设置时才会使用。
service_workers "allow" | "block" (可选)#

是否允许站点注册 Service Worker。默认为 'allow'。
- 'allow': 可以注册 Service Worker。
- 'block': Playwright 将阻止所有 Service Worker 的注册。
slow_mo 浮点数 (可选)#

将 Playwright 操作速度降低指定的毫秒数。这在您需要查看正在发生的事情时非常有用。
strict_selectors 布尔值 (可选)#

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

等待浏览器实例启动的最长时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。
timezone_id 字符串 (可选)#

更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。默认为系统时区。
traces_dir 联合类型[字符串, pathlib.Path] (可选)#

如果指定，则跟踪将保存到此目录中。
user_agent 字符串 (可选)#

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

返回值

BrowserContext #

属性

executable_path

在 v1.9 之前添加

browserType.executable_path

Playwright 预期在其中找到捆绑的浏览器可执行文件的路径。

用法

browser_type.executable_path

返回值

字符串 #

name

在 v1.9 之前添加

browserType.name

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

用法

browser_type.name

返回值

字符串 #

方法​

连接​

通过 CDP 连接​

启动​

launch_persistent_context​

属性​

executable_path​

name​

方法

连接

通过 CDP 连接

启动

launch_persistent_context

属性

executable_path

name