Skip to main content

BrowserType

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

🌐 BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:

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)

方法​

🌐 Methods

connect​

Added before v1.9 browserType.connect

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

🌐 This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.

note

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

🌐 The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).

用法

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

参数

  • ws_endpoint str Added in: v1.10#

    一个 Playwright 浏览器 websocket 端点用于连接。你可以通过 BrowserServer.wsEndpoint 获取此端点。

  • expose_network str (optional) Added in: 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] (optional) Added in: v1.11#

    随 WebSocket 连接请求一起发送的其他 HTTP 头。可选。

  • slow_mo float (optional) Added in: v1.10#

    按指定的毫秒数减慢 Playwright 的操作。这样做很有用，可以让你看到正在发生的情况。默认值为 0。

  • timeout float (optional) Added in: v1.10#

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

返回

connect_over_cdp​

Added in: v1.9 browserType.connect_over_cdp

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

🌐 This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

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

🌐 The default browser context is accessible via browser.contexts.

note

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

🌐 Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.

note

此连接的保真度远低于通过 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]

参数

  • endpoint_url str Added in: 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] (optional) Added in: v1.11#

    要随连接请求发送的额外 HTTP 请求头。可选。

  • is_local bool (optional) Added in: v1.58#

    告诉 Playwright 它与 CDP 服务器运行在同一主机上。这将启用某些依赖于 Playwright 与浏览器之间文件系统相同的优化。

  • slow_mo float (optional) Added in: v1.11#

    按指定的毫秒数减慢 Playwright 的操作。这样做很有用，可以让你看到正在发生的情况。默认值为 0。

  • timeout float (optional) Added in: v1.11#

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

返回

launch​

Added before v1.9 browserType.launch

返回浏览器实例。

🌐 Returns the browser instance.

用法

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

🌐 You can use ignore_default_args to filter out --mute-audio from default arguments:

browser = 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] (optional)#

    warning

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

    传递给浏览器实例的额外参数。Chromium 标志列表可以在 这里 查看。

  • channel str (optional)#

    浏览器分发渠道。

    使用“chromium”来选择使用新的无头模式。

    使用“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”或“msedge-canary”来使用品牌化的 Google Chrome 和 Microsoft Edge。

  • chromium_sandbox bool (optional)#

    启用 Chromium 沙箱。默认值为 false。

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

    如果指定了目录，接收的下载内容会被下载到该目录中。否则，会创建临时目录，并在浏览器关闭时删除。无论哪种情况，下载的内容都会在创建它们的浏览器上下文关闭时被删除。

  • env Dict[str, str | float | bool] (optional)#

    指定将在浏览器中可见的环境变量。默认值为 process.env。

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

    用于运行的浏览器可执行文件路径，替代打包的浏览器。如果 executable_path 是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅兼容打包的 Chromium、Firefox 或 WebKit，请自行承担风险使用。

  • firefox_user_prefs Dict[str, str | float | bool] (optional)#

    Firefox 用户偏好设置。请在 about:config 了解有关 Firefox 用户偏好设置的更多信息。

    你也可以通过 PLAYWRIGHT_FIREFOX_POLICIES_JSON 环境变量提供自定义 policies.json 文件 的路径。

  • handle_sighup bool (optional)#

    在接收到 SIGHUP 信号时关闭浏览器进程。默认值为 true。

  • handle_sigint bool (optional)#

    在按 Ctrl-C 时关闭浏览器进程。默认为 true。

  • handle_sigterm bool (optional)#

    在收到 SIGTERM 时关闭浏览器进程。默认为 true。

  • headless bool (optional)#

    是否以无头模式运行浏览器。更多详情请参见 Chromium 和 Firefox。默认值为 true。

  • ignore_default_args bool | List[str] (optional)#

    如果 true，Playwright 不会传递其自己的配置参数，只使用来自 args 的参数。如果提供了数组，则会过滤掉给定的默认参数。危险选项；请谨慎使用。默认值为 false。

  • proxy Dict (optional)#

    • server str

      用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写 myproxy.com:3128 被视为 HTTP 代理。

    • bypass str (optional)

      可选的以逗号分隔的域名，用于绕过代理，例如 ".com, chromium.org, .domain.com"。

    • username str (optional)

      如果 HTTP 代理需要身份验证，则使用可选的用户名。

    • password str (optional)

      如果 HTTP 代理需要身份验证，则使用可选密码。

    网络代理设置。

  • slow_mo float (optional)#

    将 Playwright 操作延迟指定的毫秒数。这样做很有用，可以让你看到正在发生的情况。

  • timeout float (optional)#

    等待浏览器实例启动的最长时间，单位为毫秒。默认值为 30000（30 秒）。传入 0 可禁用超时。

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

    如果指定，跟踪将保存到此目录中。

返回

launch_persistent_context​

Added before v1.9 browserType.launch_persistent_context

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

🌐 Returns the persistent browser context instance.

启动使用位于 user_data_dir 的持久存储的浏览器，并返回唯一的上下文。关闭此上下文将自动关闭浏览器。

🌐 Launches browser that uses persistent storage located at user_data_dir and returns the only context. Closing this context will automatically close the browser.

用法

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 所示“配置文件路径”的上级目录。

    请注意，浏览器不允许使用同一个用户数据目录启动多个实例。

    warning

    Chromium/Chrome：由于近期 Chrome 政策的变化，不支持自动化默认的 Chrome 用户配置文件。将 userDataDir 指向 Chrome 的主“用户数据”目录（即你平时浏览使用的配置文件）可能会导致页面无法加载或浏览器退出。请创建并使用一个单独的目录（例如一个空文件夹）作为你的自动化配置文件。详细信息请参见 https://developer.chrome.com/blog/remote-debugging-port。

  • accept_downloads bool (optional)#

    是否自动下载所有附件。默认值为 true，表示接受所有下载。

  • args List[str] (optional)#

    warning

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

    传递给浏览器实例的额外参数。Chromium 标志列表可以在 这里 查看。

  • base_url str (optional)#

    在使用 page.goto()、page.route()、page.wait_for_url()、page.expect_request() 或 page.expect_response() 时，会通过使用 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 (optional)#

    切换是否绕过页面的内容安全策略。默认值为 false。

  • channel str (optional)#

    浏览器分发渠道。

    使用“chromium”来选择使用新的无头模式。

    使用“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”或“msedge-canary”来使用品牌化的 Google Chrome 和 Microsoft Edge。

  • chromium_sandbox bool (optional)#

    启用 Chromium 沙箱。默认值为 false。

  • client_certificates List[Dict] (optional) Added in: 1.46#

    • origin str

      证书有效的确切来源。来源包括 https 协议、主机名以及可选的端口。

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

      PEM 格式的证书文件路径。

    • cert bytes (optional)

      PEM 格式的证书的直接值。

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

      PEM 格式的私钥文件路径。

    • key bytes (optional)

      PEM 格式的私钥的直接值。

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

      PFX 或 PKCS12 编码的私钥和证书链的路径。

    • pfx bytes (optional)

      PFX 或 PKCS12 编码的私钥和证书链的直接值。

    • passphrase str (optional)

      私钥的密码（PEM 或 PFX）。

    TLS 客户端身份验证允许服务器请求客户端证书并对其进行验证。

    详情

    要使用的一组客户端证书。每个证书对象必须同时具有 certPath 和 keyPath，或者单独具有 pfxPath，或它们对应的直接值等效项（cert 和 key，或 pfx）。如果证书是加密的，则可选择提供 passphrase 属性。origin 属性应提供与证书有效的请求来源完全匹配的值。

    客户端证书认证仅在提供至少一个客户端证书时才有效。如果你想拒绝服务器发送的所有客户端证书，你需要提供一个 origin 与你计划访问的任何域名都不匹配的客户端证书。

    note

    在 macOS 上使用 WebKit 时，访问 localhost 不会使用客户端证书。你可以通过将 localhost 替换为 local.playwright 来使其正常工作。

  • color_scheme "light" | "dark" | "no-preference" | "null" (optional)#

    模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。更多详情请参见 page.emulate_media()。传递 'null' 会将模拟重置为系统默认值。默认值为 'light'。

  • contrast "no-preference" | "more" | "null" (optional)#

    模拟 'prefers-contrast' 媒体特性，支持的值为 'no-preference'、'more'。更多详情请参见 page.emulate_media()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'。

  • device_scale_factor float (optional)#

    指定设备缩放因子（可以理解为 DPR）。默认值为 1。了解有关使用设备缩放因子模拟设备的更多信息。

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

    如果指定了目录，接收的下载内容会被下载到该目录中。否则，会创建临时目录，并在浏览器关闭时删除。无论哪种情况，下载的内容都会在创建它们的浏览器上下文关闭时被删除。

  • env Dict[str, str | float | bool] (optional)#

    指定将在浏览器中可见的环境变量。默认值为 process.env。

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

    用于运行的浏览器可执行文件路径，替代打包的浏览器。如果 executable_path 是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅兼容打包的 Chromium、Firefox 或 WebKit，请自行承担风险使用其他浏览器。

  • extra_http_headers Dict[str, str] (optional)#

    一个包含附加 HTTP 头的对象，这些头将随每个请求发送。默认为无。

  • firefox_user_prefs Dict[str, str | float | bool] (optional) Added in: v1.40#

    Firefox 用户偏好设置。请在 about:config 了解有关 Firefox 用户偏好设置的更多信息。

    你也可以通过 PLAYWRIGHT_FIREFOX_POLICIES_JSON 环境变量提供自定义 policies.json 文件 的路径。

  • forced_colors "active" | "none" | "null" (optional)#

    模拟 'forced-colors' 媒体特性，支持的值为 'active'、'none'。更多详情请参见 page.emulate_media()。传递 'null' 会将模拟重置为系统默认值。默认为 'none'。

  • geolocation Dict (optional)#

    • latitude float

      纬度在 -90 到 90 之间。

    • longitude float

      经度在 -180 到 180 之间。

    • accuracy float (optional)

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

  • handle_sighup bool (optional)#

    在接收到 SIGHUP 信号时关闭浏览器进程。默认值为 true。

  • handle_sigint bool (optional)#

    在按 Ctrl-C 时关闭浏览器进程。默认为 true。

  • handle_sigterm bool (optional)#

    在收到 SIGTERM 时关闭浏览器进程。默认为 true。

  • has_touch bool (optional)#

    指定视口是否支持触摸事件。默认值为 false。了解更多关于 移动模拟 的信息。

  • headless bool (optional)#

    是否以无头模式运行浏览器。更多详情请参见 Chromium 和 Firefox。默认值为 true。

  • http_credentials Dict (optional)#

    • username str

    • password str

    • origin str (optional)

      限制在特定来源 (scheme://host:port) 上发送 http 凭据。

    • send "unauthorized" | "always" (optional)

      此选项仅适用于从对应的 APIRequestContext 发送的请求，并不影响从浏览器发送的请求。'always' - Authorization 头信息会随每个 API 请求发送基本认证凭据。'unauthorized - 凭据仅在收到带有 WWW-Authenticate 头的 401（未授权）响应时发送。默认为 'unauthorized'。

    HTTP 认证 的凭据。如果未指定来源，用户名和密码将在收到未授权响应时发送到任何服务器。

  • ignore_default_args bool | List[str] (optional)#

    如果 true，Playwright 不会传递其自己的配置参数，只使用来自 args 的参数。如果提供了数组，则会过滤掉给定的默认参数。危险选项；请谨慎使用。默认值为 false。

  • ignore_https_errors bool (optional)#

    发送网络请求时是否忽略 HTTPS 错误。默认值为 false。

  • is_mobile bool (optional)#

    是否考虑 meta viewport 标签并启用触摸事件。isMobile 是 device 的一部分，因此你实际上不需要手动设置它。默认值为 false，并且在 Firefox 中不受支持。了解更多关于 移动端模拟 的信息。

  • java_script_enabled bool (optional)#

    是否在此环境中启用 JavaScript。默认为 true。了解更多关于禁用 JavaScript的信息。

  • locale str (optional)#

    指定用户区域设置，例如 en-GB、de-DE 等。区域设置会影响 navigator.language 的值、Accept-Language 请求头的值以及数字和日期的格式规则。默认为系统默认区域设置。有关模拟的更多信息，请参阅我们的 模拟指南。

  • no_viewport bool (optional)#

    不强制固定视口，允许在头显模式下调整窗口大小。

  • offline bool (optional)#

    是否模拟网络离线。默认为 false。了解更多关于 网络模拟 的信息。

  • permissions List[str] (optional)#

    在此上下文中授予所有页面的权限列表。有关更多详细信息，请参阅 browser_context.grant_permissions()。默认情况下为无。

  • proxy Dict (optional)#

    • server str

      用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写 myproxy.com:3128 被视为 HTTP 代理。

    • bypass str (optional)

      可选的以逗号分隔的域名，用于绕过代理，例如 ".com, chromium.org, .domain.com"。

    • username str (optional)

      如果 HTTP 代理需要身份验证，则使用可选的用户名。

    • password str (optional)

      如果 HTTP 代理需要身份验证，则使用可选密码。

    网络代理设置。

  • record_har_content "omit" | "embed" | "attach" (optional)#

    可选设置，用于控制资源内容管理。如果指定 omit，内容不会被保存。如果指定 attach，资源将作为单独的文件保存，并且所有这些文件会与 HAR 文件一起归档。默认值为 embed，根据 HAR 规范将内容以内联方式存储在 HAR 文件中。

  • record_har_mode "full" | "minimal" (optional)#

    当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略在从 HAR 回放时不使用的大小、时间、页面、Cookies、安全性以及其他类型的 HAR 信息。默认值为 full。

  • record_har_omit_content bool (optional)#

    可选设置，用于控制是否从 HAR 中省略请求内容。默认值为 false。

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

    启用将所有页面的 HAR 记录到文件系统中指定的 HAR 文件。如果未指定，则不会记录 HAR。请确保调用 browser_context.close() 以保存 HAR。

  • record_har_url_filter str | Pattern (optional)#

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

    启用将所有页面的视频录制到指定目录。如果未指定，则不记录视频。请确保调用 browser_context.close() 以保存视频。

  • record_video_size Dict (optional)#

    • width int

      视频帧宽度。

    • height int

      视频帧高度。

    录制视频的尺寸。如果未指定，尺寸将等于 viewport，并缩小以适应 800x800。如果未明确配置 viewport，视频尺寸默认为 800x450。如有必要，每一页的实际图片将被缩小以适应指定尺寸。

  • reduced_motion "reduce" | "no-preference" | "null" (optional)#

    模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。更多详情请参见 page.emulate_media()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'。

  • screen Dict (optional)#

    • width int

      页面宽度（以像素为单位）。

    • height int

      页面高度（以像素为单位）。

    通过 window.screen 模拟网页内可用的一致窗口屏幕大小。仅在设置了 viewport 时使用。

  • service_workers "allow" | "block" (optional)#

    是否允许网站注册服务工作进程。默认值为 'allow'。

    • 'allow'：服务工作者 可以被注册。
    • 'block'：Playwright 将阻止所有服务工作进程的注册。

  • slow_mo float (optional)#

    将 Playwright 操作延迟指定的毫秒数。这样做很有用，可以让你看到正在发生的情况。

  • strict_selectors bool (optional)#

    如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，对选择器进行的所有操作，如果操作意图是单个目标 DOM 元素，当有多个元素匹配选择器时将会抛出错误。此选项不会影响任何定位器（Locator）API（定位器始终是严格的）。默认值为 false。请参阅 Locator 了解有关严格模式的更多信息。

  • timeout float (optional)#

    等待浏览器实例启动的最长时间，单位为毫秒。默认值为 30000（30 秒）。传入 0 可禁用超时。

  • timezone_id str (optional)#

    更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。默认使用系统时区。

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

    如果指定，跟踪将保存到此目录中。

  • user_agent str (optional)#

    在此上下文中使用的特定用户代理。

  • viewport NoneType | Dict (optional)#

    • width int

      页面宽度（以像素为单位）。

    • height int

      页面高度（以像素为单位）。

    为每个页面设置一致的视口。默认视口为1280x720。no_viewport 禁用固定视口。了解更多关于视口模拟的信息。

返回

属性​

🌐 Properties

executable_path​

Added before v1.9 browserType.executable_path

Playwright 希望找到打包的浏览器可执行文件的路径。

🌐 A path where Playwright expects to find a bundled browser executable.

用法

browser_type.executable_path

返回

name​

Added before v1.9 browserType.name

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

🌐 Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.

用法

browser_type.name

返回