Browser
浏览器是通过 browser_type.launch() 创建的。使用 Browser 创建 Page 的示例:
- 同步
- 异步
from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
firefox = playwright.firefox
browser = firefox.launch()
page = browser.new_page()
page.goto("https://example.com")
browser.close()
with sync_playwright() as playwright:
run(playwright)
import asyncio
from playwright.async_api import async_playwright, Playwright
async def run(playwright: Playwright):
firefox = playwright.firefox
browser = await firefox.launch()
page = await browser.new_page()
await page.goto("https://example.com")
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
方法
close
v1.9 之前添加如果此浏览器是通过 browser_type.launch() 获取的,则关闭浏览器及其所有页面(如果已打开)。
如果此浏览器已连接,则清除属于此浏览器的所有已创建的上下文并断开与浏览器服务器的连接。
这类似于强制退出浏览器。要优雅地关闭页面并确保收到页面关闭事件,请在调用 browser.close() **之前**,对您之前使用 browser.new_context() 明确创建的任何 BrowserContext 实例调用 browser_context.close()。
浏览器对象本身被视为已销毁,不能再使用。
用法
browser.close()
browser.close(**kwargs)
参数
返回
new_browser_cdp_session
添加于:v1.11CDP 会话仅在基于 Chromium 的浏览器上受支持。
返回新创建的浏览器会话。
用法
browser.new_browser_cdp_session()
返回
new_context
v1.9 之前添加创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。
如果直接使用此方法创建 BrowserContext,最佳实践是在代码完成使用 BrowserContext 后,以及在调用 browser.close() 之前,通过 browser_context.close() 显式关闭返回的上下文。这将确保 `context` 优雅关闭,并且所有工件(例如 HAR 和视频)都完全刷新并保存。
用法
- 同步
- 异步
browser = playwright.firefox.launch() # or "chromium" or "webkit".
# create a new incognito browser context.
context = browser.new_context()
# create a new page in a pristine context.
page = context.new_page()
page.goto("https://example.com")
# gracefully close up everything
context.close()
browser.close()
browser = await playwright.firefox.launch() # or "chromium" or "webkit".
# create a new incognito browser context.
context = await browser.new_context()
# create a new page in a pristine context.
page = await context.new_page()
await page.goto("https://example.com")
# gracefully close up everything
await context.close()
await browser.close()
参数
-
是否自动下载所有附件。默认为
true
,即接受所有下载。 -
使用 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
- baseURL:
-
切换是否绕过页面的 Content-Security-Policy。默认为
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`。了解有关 使用设备缩放因子模拟设备 的更多信息。
-
extra_http_headers
Dict[str, str] (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
forced_colors
"active" | "none" | "null" (可选)#模拟
'forced-colors'
媒体功能,支持的值为'active'
、'none'
。有关更多详细信息,请参阅 page.emulate_media()。传递'null'
将模拟重置为系统默认值。默认为'none'
。 -
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟 的更多信息。
-
-
username
str -
password
str -
origin
str (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
send
"unauthorized" | "always" (可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。`'always'` - 带有基本认证凭据的 `Authorization` 标头将随每个 API 请求发送。`'unauthorized` - 仅当收到带有 `WWW-Authenticate` 标头的 401(未授权)响应时,才发送凭据。默认为 `'unauthorized'`。
HTTP 认证 的凭据。如果未指定来源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
ignore_https_errors
bool (可选)#发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,Firefox 不支持。了解有关 移动设备模拟 的更多信息。 -
java_script_enabled
bool (可选)#是否在上下文中启用 JavaScript。默认为 `true`。了解有关 禁用 JavaScript 的更多信息。
-
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的 模拟指南 中了解有关模拟的更多信息。 -
不强制使用固定视口,允许在有头模式下调整窗口大小。
-
是否模拟网络离线。默认为
false
。了解有关 网络模拟 的更多信息。 -
要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 browser_context.grant_permissions()。默认为无。
-
-
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_video_dir
Union[str, pathlib.Path] (可选)#为所有页面启用视频录制到指定目录。如果未指定,则不录制视频。请务必调用 browser_context.close() 以保存视频。
-
录制视频的尺寸。如果未指定,大小将等于
viewport
,并缩小以适应 800x800。如果未明确配置viewport
,则视频大小默认为 800x450。每个页面的实际图像将在必要时缩小以适应指定大小。 -
reduced_motion
"reduce" | "no-preference" | "null" (可选)#模拟
'prefers-reduced-motion'
媒体功能,支持的值为'reduce'
、'no-preference'
。有关更多详细信息,请参阅 page.emulate_media()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
通过
window.screen
模拟网页内部可用的统一窗口屏幕尺寸。仅当设置了 视口 时使用。 -
service_workers
"allow" | "block" (可选)#是否允许站点注册 Service Workers。默认为
'allow'
。'allow'
: Service Workers 可以注册。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
storage_state
Union[str, pathlib.Path] | Dict (可选)#-
-
name
str -
value
str -
domain
str域名和路径是必需的。要使 cookie 也适用于所有子域,请在域名前面加上一个点,例如:".example.com"
-
path
str域名和路径是必需的
-
expires
floatUnix 时间戳,单位为秒。
-
httpOnly
bool -
secure
bool -
sameSite
"Strict" | "Lax" | "None"sameSite 标志
为上下文设置的 Cookie
-
了解有关 存储状态和身份验证 的更多信息。
用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 获取的登录信息初始化上下文。
-
-
如果设置为 `true`,则为此上下文启用严格选择器模式。在严格选择器模式下,当有多个元素匹配选择器时,对暗示单个目标 DOM 元素的选择器执行的所有操作都将抛出错误。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为 `false`。请参阅 Locator 以了解有关严格模式的更多信息。
-
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
viewport
NoneType | Dict (可选)#为每个页面设置一致的视口。默认为 1280x720 视口。`no_viewport` 禁用固定视口。了解有关 视口模拟 的更多信息。
返回
new_page
v1.9 之前添加在新的浏览器上下文中创建一个新页面。关闭此页面也会关闭上下文。
这是一个便捷的 API,应仅用于单页场景和简短代码片段。生产代码和测试框架应显式创建 browser.new_context(),然后创建 browser_context.new_page() 以控制它们的精确生命周期。
用法
browser.new_page()
browser.new_page(**kwargs)
参数
-
是否自动下载所有附件。默认为
true
,即接受所有下载。 -
使用 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
- baseURL:
-
切换是否绕过页面的 Content-Security-Policy。默认为
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`。了解有关 使用设备缩放因子模拟设备 的更多信息。
-
extra_http_headers
Dict[str, str] (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
forced_colors
"active" | "none" | "null" (可选)#模拟
'forced-colors'
媒体功能,支持的值为'active'
、'none'
。有关更多详细信息,请参阅 page.emulate_media()。传递'null'
将模拟重置为系统默认值。默认为'none'
。 -
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟 的更多信息。
-
-
username
str -
password
str -
origin
str (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
send
"unauthorized" | "always" (可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。`'always'` - 带有基本认证凭据的 `Authorization` 标头将随每个 API 请求发送。`'unauthorized` - 仅当收到带有 `WWW-Authenticate` 标头的 401(未授权)响应时,才发送凭据。默认为 `'unauthorized'`。
HTTP 认证 的凭据。如果未指定来源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
ignore_https_errors
bool (可选)#发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,Firefox 不支持。了解有关 移动设备模拟 的更多信息。 -
java_script_enabled
bool (可选)#是否在上下文中启用 JavaScript。默认为 `true`。了解有关 禁用 JavaScript 的更多信息。
-
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的 模拟指南 中了解有关模拟的更多信息。 -
不强制使用固定视口,允许在有头模式下调整窗口大小。
-
是否模拟网络离线。默认为
false
。了解有关 网络模拟 的更多信息。 -
要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 browser_context.grant_permissions()。默认为无。
-
-
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_video_dir
Union[str, pathlib.Path] (可选)#为所有页面启用视频录制到指定目录。如果未指定,则不录制视频。请务必调用 browser_context.close() 以保存视频。
-
录制视频的尺寸。如果未指定,大小将等于
viewport
,并缩小以适应 800x800。如果未明确配置viewport
,则视频大小默认为 800x450。每个页面的实际图像将在必要时缩小以适应指定大小。 -
reduced_motion
"reduce" | "no-preference" | "null" (可选)#模拟
'prefers-reduced-motion'
媒体功能,支持的值为'reduce'
、'no-preference'
。有关更多详细信息,请参阅 page.emulate_media()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
通过
window.screen
模拟网页内部可用的统一窗口屏幕尺寸。仅当设置了 视口 时使用。 -
service_workers
"allow" | "block" (可选)#是否允许站点注册 Service Workers。默认为
'allow'
。'allow'
: Service Workers 可以注册。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
storage_state
Union[str, pathlib.Path] | Dict (可选)#-
-
name
str -
value
str -
domain
str域名和路径是必需的。要使 cookie 也适用于所有子域,请在域名前面加上一个点,例如:".example.com"
-
path
str域名和路径是必需的
-
expires
floatUnix 时间戳,单位为秒。
-
httpOnly
bool -
secure
bool -
sameSite
"Strict" | "Lax" | "None"sameSite 标志
为上下文设置的 Cookie
-
了解有关 存储状态和身份验证 的更多信息。
用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 获取的登录信息初始化上下文。
-
-
如果设置为 `true`,则为此上下文启用严格选择器模式。在严格选择器模式下,当有多个元素匹配选择器时,对暗示单个目标 DOM 元素的选择器执行的所有操作都将抛出错误。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为 `false`。请参阅 Locator 以了解有关严格模式的更多信息。
-
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
viewport
NoneType | Dict (可选)#为每个页面设置一致的视口。默认为 1280x720 视口。`no_viewport` 禁用固定视口。了解有关 视口模拟 的更多信息。
返回
start_tracing
添加于:v1.11此 API 控制 Chromium Tracing,这是一个低级的 Chromium 专用调试工具。用于控制 Playwright Tracing 的 API 可以在这里找到。
您可以使用 browser.start_tracing() 和 browser.stop_tracing() 创建可在 Chrome DevTools 性能面板中打开的跟踪文件。
用法
- 同步
- 异步
browser.start_tracing(page, path="trace.json")
page.goto("https://www.google.com")
browser.stop_tracing()
await browser.start_tracing(page, path="trace.json")
await page.goto("https://www.google.com")
await browser.stop_tracing()
参数
-
可选,如果指定,跟踪将包含给定页面的屏幕截图。
-
指定要使用的自定义类别而不是默认类别。
-
path
Union[str, pathlib.Path] (可选)#写入跟踪文件的路径。
-
在跟踪中捕获屏幕截图。
返回
stop_tracing
添加于:v1.11此 API 控制 Chromium Tracing,这是一个低级的 Chromium 专用调试工具。用于控制 Playwright Tracing 的 API 可以在这里找到。
返回包含跟踪数据的缓冲区。
用法
browser.stop_tracing()
返回
属性
browser_type
添加于:v1.23获取浏览器所属的浏览器类型(chromium、firefox 或 webkit)。
用法
browser.browser_type
返回
contexts
v1.9 之前添加返回所有打开的浏览器上下文的数组。在新建的浏览器中,这将返回零个浏览器上下文。
用法
- 同步
- 异步
browser = pw.webkit.launch()
print(len(browser.contexts)) # prints `0`
context = browser.new_context()
print(len(browser.contexts)) # prints `1`
browser = await pw.webkit.launch()
print(len(browser.contexts)) # prints `0`
context = await browser.new_context()
print(len(browser.contexts)) # prints `1`
返回
is_connected
v1.9 之前添加指示浏览器是否已连接。
用法
browser.is_connected()
返回
version
v1.9 之前添加返回浏览器版本。
用法
browser.version
返回
事件
on("disconnected")
v1.9 之前添加浏览器与浏览器应用程序断开连接时触发。这可能是由于以下原因之一:
- 浏览器应用程序已关闭或崩溃。
- 调用了 browser.close() 方法。
用法
browser.on("disconnected", handler)
事件数据