跳至主要内容

选择器

选择器可用于安装自定义选择器引擎。更多信息请参阅extensibility


方法

注册

Added before v1.9 selectors.register

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

用法

一个注册选择器引擎的示例,该引擎基于标签名称查询元素:

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)

参数

  • name str#

    在selectors中用作前缀的名称,例如{name: 'foo'}启用foo=myselectorbody选择器。只能包含[a-zA-Z0-9_]字符。

  • script str (可选)#

    原始脚本内容。

  • content_script bool (可选)#

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

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

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

返回


set_test_id_attribute

Added in: 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属性名称。