Selectors

セレクターはカスタムセレクターエンジンをインストールするために使用できます。拡張性の詳細については、そちらをご覧ください。

---

メソッド

register

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)

非同期

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 (任意)#

  生のスクリプトコンテンツ。

• 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属性名。