跳到主要内容

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 启动的浏览器时，主版本号和次版本号需要与客户端版本匹配 (1.2.3 → 与 1.2.x 兼容)。

用法

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

参数

  • ws_endpoint 字符串添加于: v1.10#

    要连接的浏览器 WebSocket 端点。

  • expose_network 字符串 (可选)添加于: 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>" 暴露 localhost 网络。
    3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" 暴露测试/预发布部署和 localhost。

  • headers 字典[字符串, 字符串] (可选)添加于: v1.11#

    与 WebSocket 连接请求一起发送的附加 HTTP 标头。可选。

  • slow_mo 浮点数 (可选)添加于: v1.10#

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

  • timeout 浮点数 (可选)添加于: v1.10#

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

返回值

connect_over_cdp​

添加于: v1.9 browserType.connect_over_cdp

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

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

注意

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

用法

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

参数

  • endpoint_url 字符串添加于: 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 字典[字符串, 字符串] (可选)添加于: v1.11#

    与连接请求一起发送的附加 HTTP 标头。可选。

  • slow_mo 浮点数 (可选)添加于: v1.11#

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

  • timeout 浮点数 (可选)添加于: v1.11#

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

返回值

启动​

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 列表[字符串] (可选)#

    警告

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

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

  • channel 字符串 (可选)#

    浏览器分发渠道。

    使用 “chromium” 可选择加入新的无头模式。

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

  • chromium_sandbox 布尔值 (可选)#

    启用 Chromium 沙箱。默认为 false。

  • devtools 布尔值 (可选)#

    已弃用

    请改用 调试工具。

    Chromium 独有 是否为每个选项卡自动打开开发者工具面板。如果此选项为 true，则 headless 选项将设置为 false。

  • downloads_path 联合类型[字符串, pathlib.Path] (可选)#

    如果指定，接受的下载项将下载到此目录中。否则，将创建临时目录并在浏览器关闭时删除。在任何情况下，下载项都会在创建它们的浏览器上下文关闭时删除。

  • env 字典[字符串, 字符串 | 浮点数 | 布尔值] (可选)#

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

  • executable_path 联合类型[字符串, pathlib.Path] (可选)#

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

  • firefox_user_prefs 字典[字符串, 字符串 | 浮点数 | 布尔值] (可选)#

    Firefox 用户首选项。在 about:config 了解有关 Firefox 用户首选项的更多信息。

  • handle_sighup 布尔值 (可选)#

    在 SIGHUP 上关闭浏览器进程。默认为 true。

  • handle_sigint 布尔值 (可选)#

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

  • handle_sigterm 布尔值 (可选)#

    在 SIGTERM 上关闭浏览器进程。默认为 true。

  • headless 布尔值 (可选)#

    是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为 true，除非 devtools 选项为 true。

  • ignore_default_args 布尔值 | 列表[字符串] (可选)#

    如果为 true，Playwright 不传递自己的配置参数，而仅使用 args 中的参数。如果给定一个数组，则过滤掉给定的默认参数。危险选项；谨慎使用。默认为 false。

  • proxy 字典 (可选)#

    • server 字符串

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

    • bypass 字符串 (可选)

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

    • username 字符串 (可选)

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

    • password 字符串 (可选)

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

    网络代理设置。

  • slow_mo 浮点数 (可选)#

    以指定的毫秒数减慢 Playwright 操作的速度。有助于查看正在发生的事情。

  • timeout 浮点数 (可选)#

    等待浏览器实例启动的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。

  • traces_dir 联合类型[字符串, 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 联合类型[字符串, pathlib.Path]#

    用户数据目录的路径，该目录存储浏览器会话数据，如 Cookie 和本地存储。有关 Chromium 和 Firefox 的更多详细信息。请注意，Chromium 的用户数据目录是 chrome://version 中看到的“Profile Path”的父目录。传递空字符串以使用临时目录代替。

  • accept_downloads 布尔值 (可选)#

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

  • args 列表[字符串] (可选)#

    警告

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

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

  • base_url 字符串 (可选)#

    当使用 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 布尔值 (可选)#

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

  • channel 字符串 (可选)#

    浏览器分发渠道。

    使用 “chromium” 可选择加入新的无头模式。

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

  • chromium_sandbox 布尔值 (可选)#

    启用 Chromium 沙箱。默认为 false。

  • client_certificates 列表[字典] (可选)添加于: 1.46#

    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'。有关更多详细信息，请参阅 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 Dict[str, str] (可选)#

    一个包含要随每个请求一起发送的额外 HTTP 标头的对象。默认为 none。

  • firefox_user_prefs Dict[str, str | float | bool] (可选)添加于: v1.40#

    Firefox 用户首选项。在 about:config 了解有关 Firefox 用户首选项的更多信息。

  • 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).

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

      此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。'always' - 带有基本身份验证凭据的 Authorization 标头将随每个 API 请求一起发送。'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 中不支持。了解更多关于移动设备模拟的信息。

  • 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()。默认为 none。

  • proxy Dict (可选)#

    • server 字符串

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

    • bypass 字符串 (可选)

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

    • username 字符串 (可选)

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

    • password 字符串 (可选)

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

    网络代理设置。

  • record_har_content "omit" | "embed" | "attach" (可选)#

    用于控制资源内容管理的可选设置。如果指定 omit，则不会持久化内容。如果指定 attach，则资源将持久化为单独的文件，并且所有这些文件都将与 HAR 文件一起存档。默认为 embed，它根据 HAR 规范内联存储内容在 HAR 文件中。

  • record_har_mode "full" | "minimal" (可选)#

    当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这省略了在从 HAR 重放时未使用的尺寸、计时、页面、cookies、安全和其他类型的 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 的 metaZones.txt。默认为系统时区。

  • 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

返回值