ElementHandle

继承自: JSHandle

ElementHandle 表示页面内的 DOM 元素。ElementHandle 可以使用 page.query_selector() 方法创建。

不推荐使用

不鼓励使用 ElementHandle，请改用 Locator 对象和 web-first 断言。

同步
异步

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() 释放句柄。当它们的原始 frame 导航时，ElementHandle 会自动释放。

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。边界框是相对于主 frame 视口计算的 - 这通常与浏览器窗口相同。

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

来自子 frame 的元素返回相对于主 frame 的边界框，这与 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 节点的元素句柄的内容 frame，否则返回 null

用法

element_handle.content_frame()

返回值

NoneType | Frame #

owner_frame

在 v1.9 之前添加

elementHandle.owner_frame

返回包含给定元素的 frame。

用法

element_handle.owner_frame()

返回值

NoneType | Frame #

wait_for_element_state

在 v1.9 之前添加

elementHandle.wait_for_element_state

当元素满足 state 时返回。

根据 state 参数，此方法等待 actionability 检查之一通过。当元素在等待时分离时，此方法会抛出异常，除非等待 "hidden" 状态。

"visible" 等待直到元素可见。
"hidden" 等待直到元素不可见或未附加。请注意，等待隐藏状态时，元素分离不会抛出异常。
"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 的 locator.check()。阅读更多关于 locators 的信息。

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

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

如果在操作期间的任何时刻元素从 DOM 中分离，则此方法将抛出异常。

如果所有步骤组合在指定的 timeout 期间未完成，则此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

force bool (可选)#

是否绕过 actionability 检查。默认为 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

click

在 v1.9 之前添加

elementHandle.click

不推荐使用

请改用基于 locator 的 locator.click()。阅读更多关于 locators 的信息。

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

等待元素上的 actionability 检查，除非设置了 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 (可选)#

是否绕过 actionability 检查。默认为 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
相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

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

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

dblclick

在 v1.9 之前添加

elementHandle.dblclick

不推荐使用

请改用基于 locator 的 locator.dblclick()。阅读更多关于 locators 的信息。

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

等待元素上的 actionability 检查，除非设置了 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 (可选)#

是否绕过 actionability 检查。默认为 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

dispatch_event

在 v1.9 之前添加

elementHandle.dispatch_event

不推荐使用

请改用基于 locator 的 locator.dispatch_event()。阅读更多关于 locators 的信息。

下面的代码片段在元素上派发 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

不推荐使用

此方法不等待元素通过 actionability 检查，因此可能导致测试不稳定。请改用 locator.evaluate()、其他 Locator 辅助方法或 web-first 断言。

返回 expression 的返回值。

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

如果 expression 返回 Promise，则 element_handle.eval_on_selector() 将等待 promise resolve 并返回其值。

用法

同步
异步

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 resolve 并返回其值。

用法

<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 的 locator.fill()。阅读更多关于 locators 的信息。

此方法等待 actionability 检查，聚焦元素，填充它，并在填充后触发 input 事件。请注意，您可以传递空字符串以清除输入字段。

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

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

用法

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

参数

value str #

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

是否绕过 actionability 检查。默认为 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 的 locator.focus()。阅读更多关于 locators 的信息。

在元素上调用 focus。

用法

element_handle.focus()

返回值

NoneType #

get_attribute

在 v1.9 之前添加

elementHandle.get_attribute

不推荐使用

请改用基于 locator 的 locator.get_attribute()。阅读更多关于 locators 的信息。

返回元素属性值。

用法

element_handle.get_attribute(name)

参数

name str #

要获取值的属性名称。

返回值

NoneType | str #

hover

在 v1.9 之前添加

elementHandle.hover

不推荐使用

请改用基于 locator 的 locator.hover()。阅读更多关于 locators 的信息。

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

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

如果在操作期间的任何时刻元素从 DOM 中分离，则此方法将抛出异常。

如果所有步骤组合在指定的 timeout 期间未完成，则此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

force bool (可选)#

是否绕过 actionability 检查。默认为 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

inner_html

在 v1.9 之前添加

elementHandle.inner_html

不推荐使用

请改用基于 locator 的 locator.inner_html()。阅读更多关于 locators 的信息。

返回 element.innerHTML。

用法

element_handle.inner_html()

返回值

str #

inner_text

在 v1.9 之前添加

elementHandle.inner_text

不推荐使用

请改用基于 locator 的 locator.inner_text()。阅读更多关于 locators 的信息。

返回 element.innerText。

用法

element_handle.inner_text()

返回值

str #

input_value

添加于: v1.13

elementHandle.input_value

不推荐使用

请改用基于 locator 的 locator.input_value()。阅读更多关于 locators 的信息。

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

对于非输入元素抛出异常。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回该控件的值。

用法

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 的 locator.is_checked() 代替。阅读更多关于 locators 的信息。

返回元素是否被选中。如果元素不是复选框或单选输入框，则抛出错误。

用法

element_handle.is_checked()

返回值

bool #

is_disabled

在 v1.9 之前添加

elementHandle.is_disabled

不推荐使用

请使用基于 locator 的 locator.is_disabled() 代替。阅读更多关于 locators 的信息。

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

用法

element_handle.is_disabled()

返回值

bool #

is_editable

在 v1.9 之前添加

elementHandle.is_editable

不推荐使用

请使用基于 locator 的 locator.is_editable() 代替。阅读更多关于 locators 的信息。

返回元素是否是可编辑的。

用法

element_handle.is_editable()

返回值

bool #

is_enabled

在 v1.9 之前添加

elementHandle.is_enabled

不推荐使用

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

返回元素是否是启用的。

用法

element_handle.is_enabled()

返回值

bool #

is_hidden

在 v1.9 之前添加

elementHandle.is_hidden

不推荐使用

请使用基于 locator 的 locator.is_hidden() 代替。阅读更多关于 locators 的信息。

返回元素是否隐藏，与 visible 相反。

用法

element_handle.is_hidden()

返回值

bool #

is_visible

在 v1.9 之前添加

elementHandle.is_visible

不推荐使用

请使用基于 locator 的 locator.is_visible() 代替。阅读更多关于 locators 的信息。

返回元素是否可见。

用法

element_handle.is_visible()

返回值

bool #

press

在 v1.9 之前添加

elementHandle.press

不推荐使用

请使用基于 locator 的 locator.press() 代替。阅读更多关于 locators 的信息。

聚焦元素，然后使用 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

不推荐使用

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

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

用法

element_handle.query_selector(selector)

参数

selector str #

要查询的选择器。

返回值

NoneType | ElementHandle #

query_selector_all

添加于: v1.9

elementHandle.query_selector_all

不推荐使用

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

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

用法

element_handle.query_selector_all(selector)

参数

selector str #

要查询的选择器。

返回值

List[ElementHandle]#

screenshot

在 v1.9 之前添加

elementHandle.screenshot

不推荐使用

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

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

此方法等待 actionability 检查，然后在拍摄屏幕截图之前将元素滚动到视图中。如果元素从 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] (可选)#

指定在拍摄屏幕截图时应被遮罩的 locator。被遮罩的元素将覆盖一个粉红色框 #FF00FF (可通过 mask_color 自定义颜色) ，该框完全覆盖其边界框。遮罩也适用于不可见元素，请参阅仅匹配可见元素以禁用该功能。
mask_color str (可选)Added in: 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 (可选)Added in: 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 的 locator.scroll_into_view_if_needed() 代替。阅读更多关于 locators 的信息。

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

当 elementHandle 未指向连接到 Document 或 ShadowRoot 的元素时，会抛出错误。

有关滚动的替代方法，请参阅滚动。

用法

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 的 locator.select_option() 代替。阅读更多关于 locators 的信息。

此方法等待 actionability 检查，等待直到所有指定的选项都出现在 <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#

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

已弃用
此选项无效。

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

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

要选择的 Option 元素。可选。
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 的 locator.select_text() 代替。阅读更多关于 locators 的信息。

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

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

用法

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

参数

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

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

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

返回值

NoneType #

set_checked

Added in: v1.15

elementHandle.set_checked

不推荐使用

请使用基于 locator 的 locator.set_checked() 代替。阅读更多关于 locators 的信息。

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

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

当所有步骤在指定的 timeout 期间未完成时，此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

checked bool #

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

是否绕过 actionability 检查。默认为 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 (可选)#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

set_input_files

在 v1.9 之前添加

elementHandle.set_input_files

不推荐使用

请使用基于 locator 的 locator.set_input_files() 代替。阅读更多关于 locators 的信息。

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

此方法期望 ElementHandle 指向 input 元素。但是，如果元素在具有关联 control 的 <label> 元素内，则目标将改为 control。

用法

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 的 locator.tap() 代替。阅读更多关于 locators 的信息。

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

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

如果在操作期间的任何时刻元素从 DOM 中分离，则此方法将抛出异常。

当所有步骤在指定的 timeout 期间未完成时，此方法会抛出 TimeoutError。传递零超时将禁用此功能。

注意

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

用法

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

参数

force bool (可选)#

是否绕过 actionability 检查。默认为 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

text_content

在 v1.9 之前添加

elementHandle.text_content

不推荐使用

请使用基于 locator 的 locator.text_content() 代替。阅读更多关于 locators 的信息。

返回 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 的 locator.uncheck() 代替。阅读更多关于 locators 的信息。

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

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

如果在操作期间的任何时刻元素从 DOM 中分离，则此方法将抛出异常。

当所有步骤在指定的 timeout 期间未完成时，此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

force bool (可选)#

是否绕过 actionability 检查。默认为 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待直到元素准备好执行操作而无需执行它。

返回值

NoneType #

wait_for_selector

在 v1.9 之前添加

elementHandle.wait_for_selector

不推荐使用

使用 Web 断言来断言可见性，或者使用基于定位器的 locator.wait_for() 代替。

当元素满足 state 选项时，返回由 selector 指定的元素。如果等待 hidden 或 detached 状态，则返回 null。

等待相对于元素句柄的 selector 满足 state 选项（在 DOM 中出现/消失，或变为可见/隐藏）。如果在调用此方法时，selector 已经满足条件，则该方法将立即返回。如果 selector 在 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 (可选)Added in: v1.15#

当为 true 时，调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。
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