ElementHandle

继承自: JSHandle

ElementHandle 代表页面中的一个 DOM 元素。可以使用 page.query_selector() 方法创建 ElementHandles。

不推荐

不建议使用 ElementHandle，请使用 Locator 对象和基于 Web 的断言。

同步
异步

href_element = page.query_selector("a")
href_element.click()

href_element = await page.query_selector("a")
await href_element.click()

ElementHandle 会阻止 DOM 元素被垃圾回收，除非使用 js_handle.dispose() 处置该句柄。当其源框架导航时，ElementHandles 会被自动处置。

ElementHandle 实例可用作 page.eval_on_selector() 和 page.evaluate() 方法的参数。

Locator 和 ElementHandle 的区别在于，ElementHandle 指向一个特定的元素，而 Locator 捕获检索元素的方式的逻辑。

在下面的示例中，handle 指向页面上一个特定的 DOM 元素。如果该元素更改文本或被 React 用于渲染一个完全不同的组件，handle 仍然指向该 DOM 元素。这可能导致意外的行为。

同步
异步

handle = page.query_selector("text=Submit")
handle.hover()
handle.click()

handle = await page.query_selector("text=Submit")
await handle.hover()
await handle.click()

使用 locator，每次使用 element 时，都会使用选择器在页面中定位最新的 DOM 元素。因此在下面的代码片段中，底层 DOM 元素将被定位两次。

同步
异步

locator = page.get_by_text("Submit")
locator.hover()
locator.click()

locator = page.get_by_text("Submit")
await locator.hover()
await locator.click()

方法

bounding_box

v1.9 之前添加

elementHandle.bounding_box

此方法返回元素的边界框，如果元素不可见，则返回 null。边界框是相对于主帧视口计算的，主帧视口通常与浏览器窗口相同。

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和/或 y 可能是负数。

子帧中的元素返回相对于主帧的边界框，与 Element.getBoundingClientRect 不同。

假设页面是静态的，使用边界框坐标执行输入是安全的。例如，以下代码片段应该单击元素的中心。

用法

同步
异步

box = element_handle.bounding_box()
page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)

box = await element_handle.bounding_box()
await page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)

NoneType | Dict#
- x float
  
  元素的 x 坐标（以像素为单位）。
- y float
  
  元素的 y 坐标（以像素为单位）。
- width float
  
  元素的宽度（以像素为单位）。
- height float
  
  元素的高度（以像素为单位）。

content_frame

v1.9 之前添加

elementHandle.content_frame

对于引用 iframe 节点的元素句柄，返回内容帧，否则返回 null。

用法

element_handle.content_frame()

NoneType | Frame #

owner_frame

v1.9 之前添加

elementHandle.owner_frame

返回包含给定元素的帧。

用法

element_handle.owner_frame()

NoneType | Frame #

wait_for_element_state

v1.9 之前添加

elementHandle.wait_for_element_state

当元素满足 state 时返回。

根据 state 参数，此方法等待其中一个可操作性检查通过。当元素在等待时分离，此方法将抛出异常，除非等待 "hidden" 状态。

"visible" 等待元素可见。
"hidden" 等待元素不可见或从 DOM 中分离。请注意，等待隐藏状态不会在元素分离时抛出异常。
"stable" 等待元素同时可见且稳定。
"enabled" 等待元素启用。
"disabled" 等待元素未启用。
"editable" 等待元素可编辑。

如果在 timeout 毫秒内元素未满足条件，此方法将抛出异常。

用法

element_handle.wait_for_element_state(state)
element_handle.wait_for_element_state(state, **kwargs)

参数

state "visible" | "hidden" | "stable" | "enabled" | "disabled" | "editable"#

要等待的状态，更多详情见下文。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

已弃用

check

v1.9 之前添加

elementHandle.check

不推荐

请改用基于定位符的 locator.check()。阅读有关定位符的更多信息。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已选中，此方法将立即返回。
等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此操作。

用法

element_handle.check()
element_handle.check(**kwargs)

参数

force bool (可选)#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
position Dict (可选)添加于：v1.11#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

click

v1.9 之前添加

elementHandle.click

不推荐

请改用基于定位符的 locator.click()。阅读有关定位符的更多信息。

此方法通过执行以下步骤单击元素

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素中心，或点击指定的 position。
等待已启动的导航成功或失败，除非设置了 no_wait_after 选项。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此操作。

用法

element_handle.click()
element_handle.click(**kwargs)

参数

button "left" | "right" | "middle" (可选)#

默认为 left。
click_count int (可选)#

默认为 1。参见 UIEvent.detail。
delay float (可选)#

mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
force bool (可选)#

是否绕过可操作性检查。默认为 false。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
no_wait_after bool (可选)#

已弃用
此选项将来默认为 true。

发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
position Dict (可选)#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
steps int (可选)Added in: v1.57#

默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

dblclick

v1.9 之前添加

elementHandle.dblclick

不推荐

请改用基于定位符的 locator.dblclick()。阅读有关定位符的更多信息。

此方法通过执行以下步骤双击元素

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 双击元素中心，或双击指定的 position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此操作。

注意

elementHandle.dblclick() 会分派两次 click 事件和一次 dblclick 事件。

用法

element_handle.dblclick()
element_handle.dblclick(**kwargs)

参数

button "left" | "right" | "middle" (可选)#

默认为 left。
delay float (可选)#

mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
force bool (可选)#

是否绕过可操作性检查。默认为 false。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
position Dict (可选)#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
steps int (可选)Added in: v1.57#

默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

dispatch_event

v1.9 之前添加

elementHandle.dispatch_event

不推荐

请改用基于定位符的 locator.dispatch_event()。阅读有关定位符的更多信息。

下面的代码片段会分派 click 事件到元素上。无论元素的可见状态如何，都会分派 click 事件。这等同于调用 element.click()。

用法

同步
异步

element_handle.dispatch_event("click")

await element_handle.dispatch_event("click")

在底层，它根据给定的 type 创建一个事件实例，使用 event_init 属性初始化它，并将其分派到元素上。事件默认是 composed、cancelable 且冒泡的。

由于 event_init 是事件特定的，请参阅事件文档以获取初始属性列表

您还可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中

同步
异步

# note you can only create data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
element_handle.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

# note you can only create data_transfer in chromium and firefox
data_transfer = await page.evaluate_handle("new DataTransfer()")
await element_handle.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

参数

type str #

DOM 事件类型："click"、"dragstart" 等。
event_init EvaluationArgument (可选)#

可选的事件特定初始化属性。

NoneType #

eval_on_selector

添加于：v1.9

elementHandle.eval_on_selector

不推荐

此方法不等待元素通过可操作性检查，因此可能导致测试不稳定。请使用 locator.evaluate()、其他 Locator 辅助方法或基于 Web 的断言。

返回 expression 的返回值。

该方法在 ElementHandle 的子树中查找与指定选择器匹配的元素，并将该元素作为第一个参数传递给 expression。如果找不到匹配的元素，该方法将抛出错误。

如果 expression 返回一个 Promise，那么 element_handle.eval_on_selector() 将等待 Promise 解析并返回其值。

用法

同步
异步

tweet_handle = page.query_selector(".tweet")
assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") == "10"

tweet_handle = await page.query_selector(".tweet")
assert await tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
assert await tweet_handle.eval_on_selector(".retweets", "node => node.innerText") == "10"

参数

selector str #

要查询的选择器。
expression str #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument (可选)#

要传递给 expression 的可选参数。

Dict #

eval_on_selector_all

添加于：v1.9

elementHandle.eval_on_selector_all

不推荐

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 web-first 断言会做得更好。

返回 expression 的返回值。

该方法在 ElementHandle 的子树中查找所有匹配指定选择器的元素，并将匹配元素的数组作为第一个参数传递给 expression。

如果 expression 返回一个 Promise，那么 element_handle.eval_on_selector_all() 将等待 Promise 解析并返回其值。

用法

<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

同步
异步

feed_handle = page.query_selector(".feed")
assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]

feed_handle = await page.query_selector(".feed")
assert await feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]

参数

selector str #

要查询的选择器。
expression str #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument (可选)#

要传递给 expression 的可选参数。

Dict #

fill

v1.9 之前添加

elementHandle.fill

不推荐

请改用基于定位符的 locator.fill()。阅读有关定位符的更多信息。

此方法等待可操作性检查，聚焦元素，填充内容并触发一个 input 事件。请注意，您可以传递一个空字符串来清除输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则会填充该 control。

要发送细粒度键盘事件，请使用 locator.press_sequentially()。

用法

element_handle.fill(value)
element_handle.fill(value, **kwargs)

参数

value str #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
force bool (可选)添加于：v1.13#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

focus

v1.9 之前添加

elementHandle.focus

不推荐

请改用基于定位符的 locator.focus()。阅读有关定位符的更多信息。

调用元素上的 focus。

用法

element_handle.focus()

NoneType #

get_attribute

v1.9 之前添加

elementHandle.get_attribute

不推荐

请改用基于定位符的 locator.get_attribute()。阅读有关定位符的更多信息。

返回元素属性值。

用法

element_handle.get_attribute(name)

参数

name str #

要获取值的属性名称。

NoneType | str #

hover

v1.9 之前添加

elementHandle.hover

不推荐

请改用基于定位符的 locator.hover()。阅读有关定位符的更多信息。

此方法通过执行以下步骤将鼠标悬停在元素上

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 悬停在元素中心，或悬停在指定的 position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此操作。

用法

element_handle.hover()
element_handle.hover(**kwargs)

参数

force bool (可选)#

是否绕过可操作性检查。默认为 false。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
no_wait_after bool (可选)新增于: v1.28#

已弃用
此选项无效。

此选项无效。
position Dict (可选)#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

inner_html

v1.9 之前添加

elementHandle.inner_html

不推荐

请改用基于定位符的 locator.inner_html()。阅读有关定位符的更多信息。

返回 element.innerHTML。

用法

element_handle.inner_html()

str #

inner_text

v1.9 之前添加

elementHandle.inner_text

不推荐

请改用基于定位符的 locator.inner_text()。阅读有关定位符的更多信息。

返回 element.innerText。

用法

element_handle.inner_text()

str #

input_value

添加于：v1.13

elementHandle.input_value

不推荐

请改用基于定位符的 locator.input_value()。阅读有关定位符的更多信息。

返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。

对非输入元素抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则返回 control 的值。

用法

element_handle.input_value()
element_handle.input_value(**kwargs)

参数

timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

str #

is_checked

v1.9 之前添加

elementHandle.is_checked

不推荐

请改用基于定位符的 locator.is_checked()。阅读有关定位符的更多信息。

返回元素是否已选中。如果元素不是复选框或单选输入，则抛出异常。

用法

element_handle.is_checked()

bool #

is_disabled

v1.9 之前添加

elementHandle.is_disabled

不推荐

请改用基于定位符的 locator.is_disabled()。阅读有关定位符的更多信息。

返回元素是否禁用，与启用相反。

用法

element_handle.is_disabled()

bool #

is_editable

v1.9 之前添加

elementHandle.is_editable

不推荐

请改用基于定位符的 locator.is_editable()。阅读有关定位符的更多信息。

返回元素是否可编辑。

用法

element_handle.is_editable()

bool #

is_enabled

v1.9 之前添加

elementHandle.is_enabled

不推荐

请使用基于定位器的 locator.is_enabled() 代替。阅读有关定位器的更多信息。

返回元素是否启用。

用法

element_handle.is_enabled()

bool #

is_hidden

v1.9 之前添加

elementHandle.is_hidden

不推荐

请改用基于定位符的 locator.is_hidden()。阅读有关定位符的更多信息。

返回元素是否隐藏，即 visible 的反面。

用法

element_handle.is_hidden()

bool #

is_visible

v1.9 之前添加

elementHandle.is_visible

不推荐

请改用基于定位符的 locator.is_visible()。阅读有关定位符的更多信息。

返回元素是否可见。

用法

element_handle.is_visible()

bool #

press

v1.9 之前添加

elementHandle.press

不推荐

请改用基于定位符的 locator.press()。阅读有关定位符的更多信息。

聚焦元素，然后使用 keyboard.down() 和 keyboard.up()。

key 可以指定预期的 keyboardEvent.key 值或用于生成文本的单个字符。可以在此处找到 key 值的超集。按键的示例包括

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp 等。

还支持以下修改快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。

按住 Shift 会以大写形式输入与 key 对应的文本。

如果 key 是单个字符，则区分大小写，因此 a 和 A 的值将分别生成不同的文本。

也支持快捷键，例如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

element_handle.press(key)
element_handle.press(key, **kwargs)

参数

key str #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
delay float (可选)#

keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
no_wait_after bool (可选)#

已弃用
此选项将来默认为 true。

发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

query_selector

添加于：v1.9

elementHandle.query_selector

不推荐

请使用基于定位器的 page.locator() 代替。阅读有关定位器的更多信息。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的元素。如果没有元素匹配选择器，则返回 null。

用法

element_handle.query_selector(selector)

参数

selector str #

要查询的选择器。

NoneType | ElementHandle #

query_selector_all

添加于：v1.9

elementHandle.query_selector_all

不推荐

请使用基于定位器的 page.locator() 代替。阅读有关定位器的更多信息。

此方法在 ElementHandle 的子树中查找所有与指定选择器匹配的元素。如果没有元素匹配选择器，则返回空数组。

用法

element_handle.query_selector_all(selector)

参数

selector str #

要查询的选择器。

List[ElementHandle]#

screenshot

v1.9 之前添加

elementHandle.screenshot

不推荐

请使用基于定位器的 locator.screenshot() 代替。阅读有关定位器的更多信息。

此方法捕获页面的屏幕截图，裁剪到此特定元素的大小和位置。如果元素被其他元素覆盖，它将不会真正显示在截图中。如果元素是可滚动的容器，截图中将仅显示当前滚动的内容。

此方法等待可操作性检查，然后将元素滚动到视图中，然后截取屏幕截图。如果元素从 DOM 中分离，该方法将抛出错误。

返回包含捕获的屏幕截图的缓冲区。

用法

element_handle.screenshot()
element_handle.screenshot(**kwargs)

参数

animations "disabled" | "allow" (可选)#

设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异
- 有限动画会快进到完成，因此它们会触发 transitionend 事件。
- 无限动画会取消到初始状态，然后在截图后重新播放。
默认为 "allow"，保持动画不变。
caret "hide" | "initial" (可选)#

设置为 "hide" 时，截图将隐藏文本插入符号。设置为 "initial" 时，文本插入符号行为不会更改。默认为 "hide"。
mask List[Locator] (可选)#

指定在截取屏幕截图时应被遮盖的定位器。被遮盖的元素将在其边界框上覆盖一个粉色框 #FF00FF（由 mask_color 自定义）。遮罩也会应用于不可见元素，请参阅仅匹配可见元素以禁用此行为。
mask_color str (可选)添加于：v1.35#

指定遮盖元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。
omit_background bool (可选)#

隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false。
path Union[str, pathlib.Path] (可选)#

要保存图像的文件路径。屏幕截图类型将从文件扩展名推断。如果提供了 path 是相对路径，则相对于当前工作目录解析。如果未提供路径，图像将不会保存到磁盘。
quality int (可选)#

图像质量，介于 0-100 之间。不适用于 png 图像。
scale "css" | "device" (可选)#

设置为 "css" 时，截屏将具有页面上每个 CSS 像素的单个像素。对于高 DPI 设备，这将保持截屏较小。使用 "device" 选项将产生每个设备像素的单个像素，因此高 DPI 设备的截屏将大两倍或更大。

默认为 "device"。
style str (可选)新增于: v1.41#

在截屏时应用的样式表文本。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截屏。此样式表会穿透 Shadow DOM 并应用于内部框架。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
type "png" | "jpeg" (可选)#

指定截图类型，默认为 png。

bytes #

scroll_into_view_if_needed

v1.9 之前添加

elementHandle.scroll_into_view_if_needed

不推荐

请使用基于定位器的 locator.scroll_into_view_if_needed() 代替。阅读有关定位器的更多信息。

此方法等待可操作性检查，然后尝试将元素滚动到视图中，除非它根据 IntersectionObserver 的 ratio 完全可见。

当 elementHandle 不指向与文档或 ShadowRoot 连接的元素时，抛出异常。

有关滚动的其他方法，请参阅 scrolling。

用法

element_handle.scroll_into_view_if_needed()
element_handle.scroll_into_view_if_needed(**kwargs)

参数

timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

select_option

v1.9 之前添加

elementHandle.select_option

不推荐

请改用基于定位符的 locator.select_option()。阅读有关定位符的更多信息。

此方法等待可操作性检查，等待指定的选项全部出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，则此方法会引发错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将使用该 control。

返回已成功选择的选项值数组。

一旦所有提供的选项都已选中，将触发 change 和 input 事件。

用法

同步
异步

# Single selection matching the value or label
handle.select_option("blue")
# single selection matching both the label
handle.select_option(label="blue")
# multiple selection
handle.select_option(value=["red", "green", "blue"])

# Single selection matching the value or label
await handle.select_option("blue")
# single selection matching the label
await handle.select_option(label="blue")
# multiple selection
await handle.select_option(value=["red", "green", "blue"])

参数

force bool (可选)添加于：v1.13#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
element ElementHandle | List[ElementHandle] (可选)#

要选择的选项元素。可选。
index int | List[int] (可选)#

按索引选择的选项。可选。
value str | List[str] (可选)#

按值选择的选项。如果 <select> 具有 multiple 属性，则选择所有给定的选项，否则只选择与传入选项之一匹配的第一个选项。可选。
label str | List[str] (可选)#

按标签选择的选项。如果 <select> 具有 multiple 属性，则选择所有给定的选项，否则只选择与传入选项之一匹配的第一个选项。可选。

List[str]#

select_text

v1.9 之前添加

elementHandle.select_text

不推荐

请使用基于定位器的 locator.select_text()。了解更多关于定位器的信息。

此方法会等待可操作性检查，然后聚焦元素并选择其所有文本内容。

如果元素在具有关联控件的 <label> 元素内，则聚焦并选择该控件的文本。

用法

element_handle.select_text()
element_handle.select_text(**kwargs)

参数

force bool (可选)添加于：v1.13#

是否绕过可操作性检查。默认为 false。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

set_checked

新增于: v1.15

elementHandle.set_checked

不推荐

请改用基于定位符的 locator.set_checked()。阅读有关定位符的更多信息。

此方法通过执行以下步骤选中或取消选中元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。
如果元素已经处于正确的选中状态，此方法将立即返回。
等待匹配元素的可操作性检查，除非设置了 `force` 选项。如果在检查期间元素被分离，整个操作将重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素中心。
确保元素现在已选中或未选中。如果不是，此方法将抛出异常。

当所有组合步骤在指定 timeout 内未完成时，此方法将抛出 `TimeoutError`。传递零 timeout 会禁用此功能。

用法

element_handle.set_checked(checked)
element_handle.set_checked(checked, **kwargs)

参数

checked bool #

是否选中或取消选中复选框。
force bool (可选)#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
position Dict (可选)#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

set_input_files

v1.9 之前添加

elementHandle.set_input_files

不推荐

请改用基于定位符的 locator.set_input_files()。阅读有关定位符的更多信息。

将文件输入的值设置为这些文件路径或文件。如果一些 filePaths 是相对路径，则它们相对于当前工作目录解析。空数组会清除选定的文件。对于带有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

此方法期望 `ElementHandle` 指向一个 `` 元素。但是，如果该元素位于一个具有关联 `` 控件的 `` 元素内部，则会转而定位该控件。

用法

element_handle.set_input_files(files)
element_handle.set_input_files(files, **kwargs)

参数

files Union[str, pathlib.Path] | List[Union[str, pathlib.Path]] | Dict | List[Dict]#
- name str
  
  文件名
- mimeType str
  
  文件类型
- buffer bytes
  
  文件内容
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

tap

v1.9 之前添加

elementHandle.tap

不推荐

请改用基于定位符的 locator.tap()。阅读有关定位符的更多信息。

此方法通过执行以下步骤来点击元素

等待元素的可操作性检查，除非设置了 `force` 选项。
如果需要，将元素滚动到视图中。
使用 page.touchscreen 来点击元素的中心，或点击指定的 position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有组合步骤在指定 timeout 内未完成时，此方法将抛出 `TimeoutError`。传递零 timeout 会禁用此功能。

注意

elementHandle.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

element_handle.tap()
element_handle.tap(**kwargs)

参数

force bool (可选)#

是否绕过可操作性检查。默认为 false。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
position Dict (可选)#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

text_content

v1.9 之前添加

elementHandle.text_content

不推荐

请改用基于定位符的 locator.text_content()。阅读有关定位符的更多信息。

返回 node.textContent。

用法

element_handle.text_content()

NoneType | str #

type

v1.9 之前添加

elementHandle.type

已弃用

在大多数情况下，您应该改用 locator.fill()。只有当页面上有特殊的键盘处理时，才需要一个接一个地按下按键——在这种情况下，使用 locator.press_sequentially()。

聚焦元素，然后为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。

要按下特殊按键，例如 `Control` 或 `ArrowDown`，请使用 element_handle.press()。

用法

参数

text str #

要输入到聚焦元素的文本。
delay float (可选)#

按键之间等待的时间，以毫秒为单位。默认为 0。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType #

uncheck

v1.9 之前添加

elementHandle.uncheck

不推荐

请改用基于定位符的 locator.uncheck()。阅读有关定位符的更多信息。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已经未选中，此方法将立即返回。
等待元素的可操作性检查，除非设置了 `force` 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素中心。
确保元素现在未选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有组合步骤在指定 timeout 内未完成时，此方法将抛出 `TimeoutError`。传递零 timeout 会禁用此功能。

用法

element_handle.uncheck()
element_handle.uncheck(**kwargs)

参数

force bool (可选)#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
position Dict (可选)添加于：v1.11#
- x float
- y float
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)添加于：v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

NoneType #

wait_for_selector

v1.9 之前添加

elementHandle.wait_for_selector

不推荐

请使用断言可见性或基于定位器的 locator.wait_for() 的 Web 断言。

当选择器在满足 `state` 选项时返回指定元素。如果等待 `hidden` 或 `detached`，则返回 `null`。

等待元素句柄相对的选择器满足 `state` 选项（出现/消失于 DOM，或变为可见/隐藏）。如果在调用方法时，选择器已满足条件，则方法将立即返回。如果在 `timeout` 毫秒内选择器未满足条件，则函数将抛出异常。

用法

同步
异步

page.set_content("<div><span></span></div>")
div = page.query_selector("div")
# waiting for the "span" selector relative to the div.
span = div.wait_for_selector("span", state="attached")

await page.set_content("<div><span></span></div>")
div = await page.query_selector("div")
# waiting for the "span" selector relative to the div.
span = await div.wait_for_selector("span", state="attached")

注意

此方法不能跨导航工作，请使用 page.wait_for_selector()。

参数

selector str #

要查询的选择器。
state "attached" | "detached" | "visible" | "hidden" (可选)#

默认为 'visible'。可以是以下之一：
- 'attached' - 等待元素出现在 DOM 中。
- 'detached' - 等待元素不在 DOM 中。
- 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，不被视为可见。
- 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
strict bool (可选)新增于: v1.15#

如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

NoneType | ElementHandle #

方法​

bounding_box​

content_frame​

owner_frame​

wait_for_element_state​

已弃用​

check​

click​

dblclick​

dispatch_event​

eval_on_selector​

eval_on_selector_all​

fill​

focus​

get_attribute​

hover​

inner_html​

inner_text​

input_value​

is_checked​

is_disabled​

is_editable​

is_enabled​

is_hidden​

is_visible​

press​

query_selector​

query_selector_all​

screenshot​

scroll_into_view_if_needed​

select_option​

select_text​

set_checked​

set_input_files​

tap​

text_content​

type​

uncheck​

wait_for_selector​

方法

bounding_box

content_frame

owner_frame

wait_for_element_state

已弃用

check

click

dblclick

dispatch_event

eval_on_selector

eval_on_selector_all

fill

focus

get_attribute

hover

inner_html

inner_text

input_value

is_checked

is_disabled

is_editable

is_enabled

is_hidden

is_visible

press

query_selector

query_selector_all

screenshot

scroll_into_view_if_needed

select_option

select_text

set_checked

set_input_files

tap

text_content

type

uncheck

wait_for_selector