跳转到主要内容

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

with sync_playwright() as playwright:
    run(playwright)

方法​

connect​

v1.9 之前添加 browserType.connect

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

注意

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

用法

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

参数

  • 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（无超时）。

返回

connect_over_cdp​

添加于：v1.9 browserType.connect_over_cdp

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

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

注意

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

注意

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

用法

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

参数

  • endpoint_url str添加于：v1.11#

    要连接的 CDP WebSocket 端点或 HTTP URL。例如 https://:9222/ 或 ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。

  • artifacts_dir Union[str, pathlib.Path] (可选)添加于：v1.61#

    如果指定，浏览器产物（如追踪记录和下载文件）将被保存到此目录中。

  • headers Dict[str, str] (可选)添加于：v1.11#

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

  • is_local bool (可选)添加于: v1.58#

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

  • no_defaults bool (可选)添加于: v1.60#

    当为 true 时，Playwright 不会将默认覆盖应用于现有的默认浏览器上下文。具体来说，accept_downloads 将保持浏览器的原始设置，焦点模拟不会被启用，并且媒体模拟选项（例如 color_scheme、reduced_motion、forced_colors 和 contrast）将不会被应用。当连接到用户日常使用的浏览器且这些覆盖会干扰现有浏览器状态时，此选项非常有用。通过 browser.new_context() 创建的新上下文不受影响。默认为 false。

  • slow_mo float (可选)添加于：v1.11#

    将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。

  • timeout float (可选)添加于：v1.11#

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

返回

launch​

v1.9 之前添加 browserType.launch

返回浏览器实例。

用法

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

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 或 Dev Channel 构建版本。

像 Google Chrome 和 Microsoft Edge 这样的现成浏览器适合需要专有媒体编解码器进行视频播放的测试。参见 这篇文章 了解 Chromium 和 Chrome 之间的其他差异。这篇文章 描述了 Linux 用户的一些差异。

参数

  • args List[str] (可选)#

    警告

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

    传递给浏览器实例的附加参数。Chromium 标志列表可以在 这里 找到。

  • artifacts_dir Union[str, pathlib.Path] (可选)#

    如果指定，产物（追踪记录、视频、下载文件、HAR 文件等）将保存到此目录中。当浏览器关闭时，该目录不会被自动清理。如果未指定，则使用临时目录，并在浏览器关闭时清理。

  • 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。

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

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

  • handle_sighup bool (可选)#

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

  • handle_sigint bool (可选)#

    在收到 Ctrl-C 信号时关闭浏览器进程。默认为 true。

  • handle_sigterm bool (可选)#

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

  • headless bool (可选)#

    是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为 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] (可选)#

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

返回

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 中显示的“个人资料路径 (Profile Path)”的父目录。

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

    警告

    Chromium/Chrome：由于 Chrome 最近的政策变更，不支持自动化处理默认的 Chrome 用户个人资料。将 userDataDir 指向 Chrome 的主要“用户数据”目录（您日常浏览使用的个人资料）可能会导致页面无法加载或浏览器退出。请改为创建并使用一个单独的目录（例如，一个空文件夹）作为您的自动化个人资料。有关详情，请参见 https://developer.chrome.com/blog/remote-debugging-port。

  • accept_downloads bool (可选)#

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

  • args List[str] (可选)#

    警告

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

    传递给浏览器实例的附加参数。Chromium 标志列表可以在 这里 找到。

  • artifacts_dir Union[str, pathlib.Path] (可选)#

    如果指定，产物（追踪记录、视频、下载文件、HAR 文件等）将保存到此目录中。当浏览器关闭时，该目录不会被自动清理。如果未指定，则使用临时目录，并在浏览器关闭时清理。

  • base_url str (可选)#

    当使用 page.goto()、page.route()、page.wait_for_url()、page.expect_request() 或 page.expect_response() 时，它会通过使用 URL() 构造函数构建相应 URL 来考虑基本 URL。默认未设置。示例：

    • baseURL: https://:3000，导航到 /bar.html 会得到 https://:3000/bar.html
    • baseURL: https://:3000/foo/，导航到 ./bar.html 会得到 https://:3000/foo/bar.html
    • baseURL: https://:3000/foo (不带尾部斜杠)，导航到 ./bar.html，结果为 https://: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] (可选)添加于: 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 属性应提供与证书有效的请求源的确切匹配。

    仅当提供至少一个客户端证书时，客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书，您需要提供一个 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。了解更多关于 设备缩放比例设备模拟 的信息。

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

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

  • 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。

  • http_credentials Dict (可选)#

    • username str

    • password str

    • origin str (可选)

      限制在特定源（scheme://host:port）上发送 http 凭据).

    • send "unauthorized" | "always" (可选)

      此选项仅适用于从相应的 APIRequestContext 发送的请求，不会影响从浏览器发送的请求。'always' - 带有基本身份验证凭据的 Authorization 标头将随每个 API 请求一起发送。'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 等。区域设置会影响 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 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 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 (可选)#

    更改上下文的时区。查看 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。

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

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

  • user_agent str (可选)#

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

  • viewport NoneType | Dict (可选)#

    • width int

      页面宽度（像素）。

    • height int

      页面高度（像素）。

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

返回

属性​

executable_path​

v1.9 之前添加 browserType.executable_path

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

用法

browser_type.executable_path

返回

name​

v1.9 之前添加 browserType.name

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

用法

browser_type.name

返回