Selectors

选择器可用于安装自定义选择器引擎。详见可扩展性获取更多信息。

---

方法

register

v1.9 之前添加 selectors.register

选择器必须在创建页面之前注册。

用法

以下是注册一个基于标签名查询元素的选择器引擎的示例：

同步

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    tag_selector = """
      {
          // 返回在根节点子树中匹配给定选择器的第一个元素。
          query(root, selector) {
              return root.querySelector(selector);
          },
          // 返回在根节点子树中匹配给定选择器的所有元素。
          queryAll(root, selector) {
              return Array.from(root.querySelectorAll(selector));
          }
      }"""

    # 注册引擎。选择器将以 "tag=" 为前缀。
    playwright.selectors.register("tag", tag_selector)
    browser = playwright.chromium.launch()
    page = browser.new_page()
    page.set_content('<div><button>Click me</button></div>')

    # 使用带有名称前缀的选择器。
    button = page.locator('tag=button')
    # 可以与内置定位器组合使用。
    page.locator('tag=div').get_by_text('Click me').click()
    # 可以在任何支持选择器的方法中使用。
    button_count = page.locator('tag=button').count()
    print(button_count)
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

异步

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    tag_selector = """
      {
          // 返回在根节点子树中匹配给定选择器的第一个元素。
          query(root, selector) {
              return root.querySelector(selector);
          },
          // 返回在根节点子树中匹配给定选择器的所有元素。
          queryAll(root, selector) {
              return Array.from(root.querySelectorAll(selector));
          }
      }"""

    # 注册引擎。选择器将以 "tag=" 为前缀。
    await playwright.selectors.register("tag", tag_selector)
    browser = await playwright.chromium.launch()
    page = await browser.new_page()
    await page.set_content('<div><button>Click me</button></div>')

    # 使用带有名称前缀的选择器。
    button = await page.query_selector('tag=button')
    # 可以与内置定位器组合使用。
    await page.locator('tag=div').get_by_text('Click me').click()
    # 可以在任何支持选择器的方法中使用。
    button_count = await page.locator('tag=button').count()
    print(button_count)
    await browser.close()

async def main():
    async with async_playwright() as playwright:
        await run(playwright)

asyncio.run(main())

参数

• name str#

  用作选择器前缀的名称，例如 {name: 'foo'} 允许使用 foo=myselectorbody 选择器。只能包含 [a-zA-Z0-9_] 字符。

• script str (可选)#

  原始脚本内容。

• content_script bool (可选)#

  是否在隔离的 JavaScript 环境中运行该选择器引擎。该环境可以访问相同的 DOM，但无法访问页面脚本中的任何 JavaScript 对象。默认为 false。注意，当该引擎与其他已注册引擎一起使用时，作为内容脚本运行并不保证。

• path Union[str, pathlib.Path] (可选)#

  JavaScript 文件的路径。如果 path 是相对路径，则相对于当前工作目录解析。

返回值

• NoneType#

---

set_test_id_attribute

新增于: v1.27 selectors.set_test_id_attribute

定义用于 page.get_by_test_id() 的自定义属性名。默认使用 data-testid。

用法

selectors.set_test_id_attribute(attribute_name)

参数

• attribute_name str#

  测试 id 属性名。