Selectors

选择器可用于安装自定义选择器引擎。有关更多信息，请参阅可扩展性。

🌐 Selectors can be used to install custom selector engines. See extensibility for more information.

---

方法

🌐 Methods

register

Added before v1.9 selectors.register

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

🌐 Selectors must be registered before creating the page.

用法

注册根据标签名称查询元素的选择器引擎的示例：

🌐 An example of registering selector engine that queries elements based on a tag name:

Sync

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    tag_selector = """
      {
          // Returns the first element matching given selector in the root's subtree.
          query(root, selector) {
              return root.querySelector(selector);
          },
          // Returns all elements matching given selector in the root's subtree.
          queryAll(root, selector) {
              return Array.from(root.querySelectorAll(selector));
          }
      }"""

    # Register the engine. Selectors will be prefixed with "tag=".
    playwright.selectors.register("tag", tag_selector)
    browser = playwright.chromium.launch()
    page = browser.new_page()
    page.set_content('<div><button>Click me</button></div>')

    # Use the selector prefixed with its name.
    button = page.locator('tag=button')
    # Combine it with built-in locators.
    page.locator('tag=div').get_by_text('Click me').click()
    # Can use it in any methods supporting selectors.
    button_count = page.locator('tag=button').count()
    print(button_count)
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

Async

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    tag_selector = """
      {
          // Returns the first element matching given selector in the root's subtree.
          query(root, selector) {
              return root.querySelector(selector);
          },
          // Returns all elements matching given selector in the root's subtree.
          queryAll(root, selector) {
              return Array.from(root.querySelectorAll(selector));
          }
      }"""

    # Register the engine. Selectors will be prefixed with "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>')

    # Use the selector prefixed with its name.
    button = await page.query_selector('tag=button')
    # Combine it with built-in locators.
    await page.locator('tag=div').get_by_text('Click me').click()
    # Can use it in any methods supporting selectors.
    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 (optional)#

  原始脚本内容。

• content_script bool (optional)#

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

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

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

返回

• NoneType#

---

set_test_id_attribute

Added in: v1.27 selectors.set_test_id_attribute

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

🌐 Defines custom attribute name to be used in page.get_by_test_id(). data-testid is used by default.

用法

selectors.set_test_id_attribute(attribute_name)

参数

• attribute_name str#

  测试 id 属性名称。