浏览器 (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 对象本身被视为已处置,无法再使用。
用法
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://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
- baseURL:
-
切换是否绕过页面的内容安全策略。默认为
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
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
字符串 -
password
字符串 -
origin
字符串 (可选)限制在特定来源(scheme://host:port)发送 HTTP 凭据。).
-
send
"unauthorized" | "always" (可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'
- 每个 API 请求都会发送包含基本身份验证凭据的Authorization
标头。'unauthorized
- 仅在收到带有WWW-Authenticate
标头的 401(未授权)响应时才发送凭据。默认为'unauthorized'
。
用于 HTTP 身份验证 的凭据。如果未指定来源,则在收到未授权响应时,用户名和密码将发送到任何服务器。
-
-
发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
meta viewport
标签是否被考虑在内以及是否启用了触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
并且在 Firefox 中不受支持。了解更多关于 移动设备模拟。 -
是否在上下文中启用 JavaScript。默认为
true
。了解更多关于 禁用 JavaScript。 -
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。了解更多关于模拟的信息,请参阅我们的 模拟指南。 -
不强制使用固定视口,允许在 headed 模式下调整窗口大小。
-
是否模拟网络脱机状态。默认为
false
。了解更多关于 网络模拟。 -
要授予此上下文中的所有页面的权限列表。有关更多详细信息,请参阅 browser_context.grant_permissions()。默认为无。
-
-
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 路由所需的信息。这省略了大小、时间、页面、cookie、安全性和 HAR 中未在从 HAR 重新播放时使用的其他类型的信息。默认为full
。 -
record_har_omit_content
布尔值 (可选)#可选设置,用于控制是否从 HAR 中省略请求内容。默认为
false
。 -
record_har_path
联合类型[字符串, pathlib.Path] (可选)#启用对所有页面进行 HAR 记录,并将记录结果写入文件系统上的指定 HAR 文件。如果未指定,则不会记录 HAR。请确保调用 browser_context.close() 以保存 HAR。
-
record_video_dir
联合类型[字符串, 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
在网页内部可用的固定窗口屏幕尺寸。仅当设置了 viewport 时才使用。 -
service_workers
"allow" | "block" (可选)#是否允许站点注册 Service Workers。默认为
'allow'
。'allow'
: 可以注册 Service Workers。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
storage_state
Union[str, pathlib.Path] | Dict (可选)#了解更多关于 存储状态和身份验证。
使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 获取的登录信息初始化上下文。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有暗示单个目标 DOM 元素的选择器操作,当多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false
。查看 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。查看 ICU 的 metaZones.txt 以获取受支持的时区 ID 列表。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
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://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
- baseURL:
-
切换是否绕过页面的内容安全策略。默认为
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
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
字符串 -
password
字符串 -
origin
字符串 (可选)限制在特定来源(scheme://host:port)发送 HTTP 凭据。).
-
send
"unauthorized" | "always" (可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'
- 每个 API 请求都会发送包含基本身份验证凭据的Authorization
标头。'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
请求头值以及数字和日期格式规则。默认为系统默认区域设置。了解更多关于模拟的信息,请参阅我们的 模拟指南。 -
不强制使用固定视口,允许在 headed 模式下调整窗口大小。
-
是否模拟网络脱机状态。默认为
false
。了解更多关于 网络模拟。 -
要授予此上下文中的所有页面的权限列表。有关更多详细信息,请参阅 browser_context.grant_permissions()。默认为无。
-
-
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 路由所需的信息。这省略了大小、时间、页面、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 (可选)#了解更多关于 存储状态和身份验证。
使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 获取的登录信息初始化上下文。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有暗示单个目标 DOM 元素的选择器操作,当多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false
。查看 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。查看 ICU 的 metaZones.txt 以获取受支持的时区 ID 列表。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
viewport
NoneType | Dict (可选)#为每个页面设置一致的视口。默认为 1280x720 视口。
no_viewport
禁用固定视口。了解更多关于 视口模拟。
返回值
start_tracing
添加于:v1.11此 API 控制Chromium 追踪,这是一种低级别的特定于 chromium 的调试工具。控制Playwright 追踪的 API 可以在此处找到。
您可以使用browser.start_tracing() 和 browser.stop_tracing() 创建一个跟踪文件,该文件可以在 Chrome 开发者工具性能面板中打开。
用法
- 同步
- 异步
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 追踪,这是一种低级别的特定于 chromium 的调试工具。控制Playwright 追踪的 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)
事件数据