跳至主要内容

ElementHandle

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

不建议

不建议使用 ElementHandle，请改用 Locator 对象和 Web 优先断言。

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

除非使用 js_handle.dispose() 处置句柄，否则 ElementHandle 会阻止 DOM 元素被垃圾回收。当其来源框架被导航时，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()

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

locator = page.get_by_text("Submit")
locator.hover()
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)

返回值

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

返回值

owner_frame​

在 v1.9 之前添加 elementHandle.owner_frame

返回包含给定元素的框架。

用法

element_handle.owner_frame()

返回值

wait_for_element_state​

在 v1.9 之前添加 elementHandle.wait_for_element_state

当元素满足 state 时返回。

根据 state 参数，此方法等待其中一个 可操作性 检查通过。除非等待 "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() 方法更改默认值。

返回值

已弃用​

check​

在 v1.9 之前添加 elementHandle.check
不建议

请改用基于定位器的 locator.check()。详细了解 定位器。

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

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

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

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

用法

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

参数

  • force bool (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)在以下版本中添加：v1.11#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout float (可选)#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

click​

在 v1.9 之前添加 elementHandle.click
不建议

请改用基于定位器的 locator.click()。详细了解 定位器。

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

  1. 等待元素上的 可操作性 检查，除非设置了 force 选项。

  2. 如果需要，将元素滚动到视图中。
  3. 使用 page.mouse 点击元素中心，或指定 位置。
  4. 等待已发起的导航成功或失败，除非设置了 no_wait_after 选项。

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

如果在指定的 超时时间 内所有步骤都未完成，则此方法会抛出 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 (可选)#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout float (可选)#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

dblclick​

在 v1.9 之前添加 elementHandle.dblclick
不建议

改用基于定位器的 locator.dblclick()。 详细了解 定位器。

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

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

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

如果在指定的 超时时间 内所有步骤都未完成，则此方法会抛出 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 (可选)#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout float (可选)#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

dispatch_event​

在 v1.9 之前添加 elementHandle.dispatch_event
不建议

改用基于定位器的 locator.dispatch_event()。 详细了解 定位器。

以下代码片段在元素上分派 click 事件。无论元素的可见性状态如何，都会分派 click。这相当于调用 element.click()。

用法

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})

参数

  • type str#

    DOM 事件类型："click"、"dragstart" 等。

  • event_init EvaluationArgument (可选)#

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

返回值

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"

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    可选参数，传递给 expression。

返回值

eval_on_selector_all​

新增于：v1.9 elementHandle.eval_on_selector_all
不建议

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 Web优先断言可以更好地完成工作。

返回 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!"]

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument （可选）#

    传递给 expression 的可选参数。

返回值

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() 方法更改默认值。

返回值

focus​

在 v1.9 之前添加 elementHandle.focus
不建议

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

在元素上调用 focus。

用法

element_handle.focus()

返回值

get_attribute​

在 v1.9 之前添加 elementHandle.get_attribute
不建议

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

返回元素属性值。

用法

element_handle.get_attribute(name)

参数

  • name str#

    要获取其值的属性名称。

返回值

hover​

在 v1.9 之前添加 elementHandle.hover
不建议

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

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

  1. 等待元素上的 可操作性 检查，除非设置了 force 选项。
  2. 如果需要，将元素滚动到视图中。
  3. 使用 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 （可选）#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout float （可选）#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

inner_html​

在 v1.9 之前添加 elementHandle.inner_html
不建议

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

返回 element.innerHTML。

用法

element_handle.inner_html()

返回值

inner_text​

在 v1.9 之前添加 elementHandle.inner_text
不建议

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

返回 element.innerText。

用法

element_handle.inner_text()

返回值

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)

参数

返回值

is_checked​

在 v1.9 之前添加 elementHandle.is_checked
不建议

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

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

用法

element_handle.is_checked()

返回值

is_disabled​

在 v1.9 之前添加 elementHandle.is_disabled
不建议

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

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

用法

element_handle.is_disabled()

返回值

is_editable​

在 v1.9 之前添加 elementHandle.is_editable
不建议

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

返回元素是否 可编辑。

用法

element_handle.is_editable()

返回值

is_enabled​

在 v1.9 之前添加 elementHandle.is_enabled
不建议

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

返回元素是否 启用。

用法

element_handle.is_enabled()

返回值

is_hidden​

在 v1.9 之前添加 elementHandle.is_hidden
不建议

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

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

用法

element_handle.is_hidden()

返回值

is_visible​

在 v1.9 之前添加 elementHandle.is_visible
不建议

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

返回元素是否 可见。

用法

element_handle.is_visible()

返回值

按下​

在 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() 方法更改默认值。

返回值

query_selector​

新增于：v1.9 elementHandle.query_selector
不建议

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

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

用法

element_handle.query_selector(selector)

参数

  • selector str#

    要查询的选择器。

返回值

query_selector_all​

新增于：v1.9 elementHandle.query_selector_all
不建议

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

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

用法

element_handle.query_selector_all(selector)

参数

  • selector str#

    要查询的选择器。

返回值

截图​

在 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。

返回值

scroll_into_view_if_needed​

在 v1.9 之前添加 elementHandle.scroll_into_view_if_needed
不建议

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

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

当 elementHandle 不指向连接到 Document 或 ShadowRoot 的元素时抛出异常 connected。

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

用法

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

参数

返回值

  • 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"])

参数

  • force bool （可选）新增于：v1.13#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after 布尔值 （可选）#

    已弃用

    此选项无效。

    此选项无效。

  • timeout 浮点数 （可选）#

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

  • element ElementHandle | 列表[ElementHandle] （可选）#

    要选择的选项元素。可选。

  • index 整数 | 列表[整数] （可选）#

    按索引选择的选项。可选。

  • value 字符串 | 列表[字符串] （可选）#

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

  • label 字符串 | 列表[字符串] （可选）#

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

返回值

select_text​

在 v1.9 之前添加 elementHandle.select_text
不建议

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

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

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

用法

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

参数

返回值

  • NoneType#

set_checked​

新增于：v1.15 elementHandle.set_checked
不建议

请使用基于定位器的 locator.set_checked() 方法代替。了解更多关于 定位器 的信息。

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

  1. 确保元素是复选框或单选输入。如果不是，则此方法会抛出错误。
  2. 如果元素已具有正确的选中状态，则此方法会立即返回。
  3. 等待匹配元素的 可操作性 检查，除非设置了 force 选项。如果元素在检查过程中被分离，则会重试整个操作。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 点击元素的中心。
  6. 确保元素现在已选中或取消选中。如果不是，则此方法会抛出错误。

如果在指定的 timeout 内所有步骤都未完成，则此方法会抛出 TimeoutError 错误。传递零超时将禁用此功能。

用法

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

参数

  • checked 布尔值#

    是否选中或取消选中复选框。

  • force 布尔值 （可选）#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after 布尔值 （可选）#

    已弃用

    此选项无效。

    此选项无效。

  • position 字典 （可选）#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout 浮点数 （可选）#

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

  • trial 布尔值 （可选）#

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

返回值

  • NoneType#

set_input_files​

在 v1.9 之前添加 elementHandle.set_input_files
不建议

请使用基于定位器的 locator.set_input_files() 方法代替。了解更多关于 定位器 的信息。

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

此方法期望 ElementHandle 指向一个 input 元素。但是，如果元素位于具有关联 control 的 <label> 元素内部，则会将目标定位到该 control。

用法

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

参数

返回值

  • NoneType#

tap​

在 v1.9 之前添加 elementHandle.tap
不建议

请使用基于定位器的 locator.tap() 方法代替。了解更多关于 定位器 的信息。

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

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

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

如果在指定的 timeout 内所有步骤都未完成，则此方法会抛出 TimeoutError 错误。传递零超时将禁用此功能。

注意

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

用法

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

参数

  • force 布尔值 （可选）#

    是否绕过 可操作性 检查。默认为 false。

  • modifiers 列表["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

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

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position 字典 (可选)#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout 浮点数 (可选)#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

text_content​

在 v1.9 之前添加 elementHandle.text_content
不建议

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

返回 node.textContent。

用法

element_handle.text_content()

返回值

type​

在 v1.9 之前添加 elementHandle.type
已弃用

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

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

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

用法

参数

返回值

uncheck​

在 v1.9 之前添加 elementHandle.uncheck
不建议

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

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

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

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

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

用法

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

参数

  • force 布尔值 (可选)#

    是否绕过 可操作性 检查。默认为 false。

  • no_wait_after 布尔值 (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)在以下版本中添加：v1.11#

    相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。

  • timeout 浮点数 (可选)#

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

  • trial bool (可选)在以下版本中添加：v1.11#

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

返回值

wait_for_selector​

在 v1.9 之前添加 elementHandle.wait_for_selector
不建议

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

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

等待相对于元素句柄的 selector 满足 state 选项（出现在 DOM 中/从 DOM 中消失，或变为可见/隐藏）。如果在调用方法时 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")
注意

此方法不适用于跨导航，请改用 page.wait_for_selector()。

参数

  • selector 字符串#

    要查询的选择器。

  • state "attached" | "detached" | "visible" | "hidden" (可选)#

    默认为 'visible'。可以是以下之一：

    • 'attached' - 等待元素出现在 DOM 中。
    • 'detached' - 等待元素不再出现在 DOM 中。
    • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空边界框，并且不被视为可见。
    • 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。

  • strict 布尔值 (可选)新增于：v1.15#

    如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。

  • timeout 浮点数 (可选)#

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

返回值