A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://playwright.dev/python/docs/api/class-locator below:

Locator | Playwright Python

Locator

Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way to find element(s) on the page at any moment. A locator can be created with the page.locator() method.

Learn more about locators.

Methods allAdded in: v1.29 locator.all

When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.

note

locator.all() does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.

When the list of elements changes dynamically, locator.all() will produce unpredictable and flaky results.

When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before calling locator.all().

Usage

for li in page.get_by_role('listitem').all():
li.click();
for li in await page.get_by_role('listitem').all():
await li.click();

Returns

all_inner_textsAdded in: v1.14 locator.all_inner_texts

Returns an array of node.innerText values for all matching nodes.

Usage

texts = page.get_by_role("link").all_inner_texts()
texts = await page.get_by_role("link").all_inner_texts()

Returns

all_text_contentsAdded in: v1.14 locator.all_text_contents

Returns an array of node.textContent values for all matching nodes.

Usage

texts = page.get_by_role("link").all_text_contents()
texts = await page.get_by_role("link").all_text_contents()

Returns

and_Added in: v1.34 locator.and_

Creates a locator that matches both this locator and the argument locator.

Usage

The following example finds a button with a specific title.

button = page.get_by_role("button").and_(page.getByTitle("Subscribe"))
button = page.get_by_role("button").and_(page.getByTitle("Subscribe"))

Arguments

Returns

aria_snapshotAdded in: v1.49 locator.aria_snapshot

Captures the aria snapshot of the given element. Read more about aria snapshots and expect(locator).to_match_aria_snapshot() for the corresponding assertion.

Usage

page.get_by_role("link").aria_snapshot()
await page.get_by_role("link").aria_snapshot()

Arguments

Returns

Details

This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children. The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.

The ARIA snapshot is represented using YAML markup language:

Below is the HTML markup and the respective ARIA snapshot:

<ul aria-label="Links">
<li><a href="/">Home</a></li>
<li><a href="/about">About</a></li>
<ul>
- list "Links":
- listitem:
- link "Home"
- listitem:
- link "About"
blurAdded in: v1.28 locator.blur

Calls blur on the element.

Usage

locator.blur()
locator.blur(**kwargs)

Arguments

Returns

bounding_boxAdded in: v1.14 locator.bounding_box

This method returns the bounding box of the element matching the locator, or null if the element is not visible. The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser window.

Usage

box = page.get_by_role("button").bounding_box()
page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
box = await page.get_by_role("button").bounding_box()
await page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)

Arguments

Returns

Details

Scrolling affects the returned bounding box, similarly to Element.getBoundingClientRect. That means x and/or y may be negative.

Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.

Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.

checkAdded in: v1.14 locator.check

Ensure that checkbox or radio element is checked.

Usage

page.get_by_role("checkbox").check()
await page.get_by_role("checkbox").check()

Arguments

Returns

Details

Performs the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Ensure that the element is now checked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

clearAdded in: v1.28 locator.clear

Clear the input field.

Usage

page.get_by_role("textbox").clear()
await page.get_by_role("textbox").clear()

Arguments

Returns

Details

This method waits for actionability checks, focuses the element, clears it and triggers an input event after clearing.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be cleared instead.

clickAdded in: v1.14 locator.click

Click an element.

Usage

Click a button:

page.get_by_role("button").click()
await page.get_by_role("button").click()

Shift-right-click at a specific position on a canvas:

page.locator("canvas").click(
button="right", modifiers=["Shift"], position={"x": 23, "y": 32}
)
await page.locator("canvas").click(
button="right", modifiers=["Shift"], position={"x": 23, "y": 32}
)

Arguments

Returns

Details

This method clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to click in the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless no_wait_after option is set.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

countAdded in: v1.14 locator.count

Returns the number of elements matching the locator.

Usage

count = page.get_by_role("listitem").count()
count = await page.get_by_role("listitem").count()

Returns

dblclickAdded in: v1.14 locator.dblclick

Double-click an element.

Usage

locator.dblclick()
locator.dblclick(**kwargs)

Arguments

Returns

Details

This method double clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to double click in the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

element.dblclick() dispatches two click events and a single dblclick event.

describeAdded in: v1.53 locator.describe

Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.

Usage

button = page.get_by_test_id("btn-sub").describe("Subscribe button")
button.click()
button = page.get_by_test_id("btn-sub").describe("Subscribe button")
await button.click()

Arguments

Returns

dispatch_eventAdded in: v1.14 locator.dispatch_event

Programmatically dispatch an event on the matching element.

Usage

locator.dispatch_event("click")
await locator.dispatch_event("click")

Arguments

Returns

Details

The snippet above dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().

Under the hood, it creates an instance of an event based on the given type, initializes it with event_init properties and dispatches it on the element. Events are composed, cancelable and bubble by default.

Since event_init is event-specific, please refer to the events documentation for the lists of initial properties:

You can also specify JSHandle as the property value if you want live objects to be passed into the event:

data_transfer = page.evaluate_handle("new DataTransfer()")
locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
data_transfer = await page.evaluate_handle("new DataTransfer()")
await locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
drag_toAdded in: v1.18 locator.drag_to

Drag the source element towards the target element and drop it.

Usage

source = page.locator("#source")
target = page.locator("#target")

source.drag_to(target)

source.drag_to(
target,
source_position={"x": 34, "y": 7},
target_position={"x": 10, "y": 20}
)
source = page.locator("#source")
target = page.locator("#target")

await source.drag_to(target)

await source.drag_to(
target,
source_position={"x": 34, "y": 7},
target_position={"x": 10, "y": 20}
)

Arguments

Returns

Details

This method drags the locator to another target locator or target position. It will first move to the source element, perform a mousedown, then move to the target element or position and perform a mouseup.

evaluateAdded in: v1.14 locator.evaluate

Execute JavaScript code in the page, taking the matching element as an argument.

Usage

Passing argument to expression:

result = page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
print(result)
result = await page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
print(result)

Arguments

Returns

Details

Returns the return value of expression, called with the matching element as a first argument, and arg as a second argument.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

evaluate_allAdded in: v1.14 locator.evaluate_all

Execute JavaScript code in the page, taking all matching elements as an argument.

Usage

locator = page.locator("div")
more_than_ten = locator.evaluate_all("(divs, min) => divs.length > min", 10)
locator = page.locator("div")
more_than_ten = await locator.evaluate_all("(divs, min) => divs.length > min", 10)

Arguments

Returns

Details

Returns the return value of expression, called with an array of all matching elements as a first argument, and arg as a second argument.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

evaluate_handleAdded in: v1.14 locator.evaluate_handle

Execute JavaScript code in the page, taking the matching element as an argument, and return a JSHandle with the result.

Usage

locator.evaluate_handle(expression)
locator.evaluate_handle(expression, **kwargs)

Arguments

Returns

Details

Returns the return value of expression as aJSHandle, called with the matching element as a first argument, and arg as a second argument.

The only difference between locator.evaluate() and locator.evaluate_handle() is that locator.evaluate_handle() returns JSHandle.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

See page.evaluate_handle() for more details.

fillAdded in: v1.14 locator.fill

Set a value to the input field.

Usage

page.get_by_role("textbox").fill("example value")
await page.get_by_role("textbox").fill("example value")

Arguments

Returns

Details

This method waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

To send fine-grained keyboard events, use locator.press_sequentially().

filterAdded in: v1.22 locator.filter

This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.

Usage

row_locator = page.locator("tr")

row_locator.filter(has_text="text in column 1").filter(
has=page.get_by_role("button", name="column 2 button")
).screenshot()
row_locator = page.locator("tr")

await row_locator.filter(has_text="text in column 1").filter(
has=page.get_by_role("button", name="column 2 button")
).screenshot()

Arguments

Returns

focusAdded in: v1.14 locator.focus

Calls focus on the matching element.

Usage

locator.focus()
locator.focus(**kwargs)

Arguments

Returns

frame_locatorAdded in: v1.17 locator.frame_locator

When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in that iframe:

Usage

locator = page.frame_locator("iframe").get_by_text("Submit")
locator.click()
locator = page.frame_locator("iframe").get_by_text("Submit")
await locator.click()

Arguments

Returns

get_attributeAdded in: v1.14 locator.get_attribute

Returns the matching element's attribute value.

Usage

locator.get_attribute(name)
locator.get_attribute(name, **kwargs)

Arguments

Returns

get_by_alt_textAdded in: v1.27 locator.get_by_alt_text

Allows locating elements by their alt text.

Usage

For example, this method will find the image by alt text "Playwright logo":

<img alt='Playwright logo'>
page.get_by_alt_text("Playwright logo").click()
await page.get_by_alt_text("Playwright logo").click()

Arguments

Returns

get_by_labelAdded in: v1.27 locator.get_by_label

Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

Usage

For example, this method will find inputs by label "Username" and "Password" in the following DOM:

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")
await page.get_by_label("Username").fill("john")
await page.get_by_label("Password").fill("secret")

Arguments

Returns

get_by_placeholderAdded in: v1.27 locator.get_by_placeholder

Allows locating input elements by the placeholder text.

Usage

For example, consider the following DOM structure.

<input type="email" placeholder="name@example.com" />

You can fill the input after locating it by the placeholder text:

page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
await page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")

Arguments

Returns

get_by_roleAdded in: v1.27 locator.get_by_role

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

Usage

Consider the following DOM structure.

<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

You can locate each element by it's implicit role:

expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

page.get_by_role("checkbox", name="Subscribe").check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()
await expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

await page.get_by_role("checkbox", name="Subscribe").check()

await page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

Arguments

Returns

Details

Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

get_by_test_idAdded in: v1.27 locator.get_by_test_id

Locate element by the test id.

Usage

Consider the following DOM structure.

<button data-testid="directions">Itinéraire</button>

You can locate the element by it's test id:

page.get_by_test_id("directions").click()
await page.get_by_test_id("directions").click()

Arguments

Returns

Details

By default, the data-testid attribute is used as a test id. Use selectors.set_test_id_attribute() to configure a different test id attribute if necessary.

get_by_textAdded in: v1.27 locator.get_by_text

Allows locating elements that contain given text.

See also locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.

Usage

Consider the following DOM structure:

<div>Hello <span>world</span></div>
<div>Hello</div>

You can locate by text substring, exact string, or a regular expression:


page.get_by_text("world")


page.get_by_text("Hello world")


page.get_by_text("Hello", exact=True)


page.get_by_text(re.compile("Hello"))


page.get_by_text(re.compile("^hello$", re.IGNORECASE))

page.get_by_text("world")


page.get_by_text("Hello world")


page.get_by_text("Hello", exact=True)


page.get_by_text(re.compile("Hello"))


page.get_by_text(re.compile("^hello$", re.IGNORECASE))

Arguments

Returns

Details

Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

get_by_titleAdded in: v1.27 locator.get_by_title

Allows locating elements by their title attribute.

Usage

Consider the following DOM structure.

<span title='Issues count'>25 issues</span>

You can check the issues count after locating it by the title text:

expect(page.get_by_title("Issues count")).to_have_text("25 issues")
await expect(page.get_by_title("Issues count")).to_have_text("25 issues")

Arguments

Returns

highlightAdded in: v1.20 locator.highlight

Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses locator.highlight().

Usage

Returns

hoverAdded in: v1.14 locator.hover

Hover over the matching element.

Usage

page.get_by_role("link").hover()
await page.get_by_role("link").hover()

Arguments

Returns

Details

This method hovers over the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to hover over the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

inner_htmlAdded in: v1.14 locator.inner_html

Returns the element.innerHTML.

Usage

locator.inner_html()
locator.inner_html(**kwargs)

Arguments

Returns

inner_textAdded in: v1.14 locator.inner_text

Returns the element.innerText.

Usage

locator.inner_text()
locator.inner_text(**kwargs)

Arguments

Returns

input_valueAdded in: v1.14 locator.input_value

Returns the value for the matching <input> or <textarea> or <select> element.

Usage

value = page.get_by_role("textbox").input_value()
value = await page.get_by_role("textbox").input_value()

Arguments

Returns

Details

Throws elements that are not an input, textarea or a select. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

is_checkedAdded in: v1.14 locator.is_checked

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

Usage

checked = page.get_by_role("checkbox").is_checked()
checked = await page.get_by_role("checkbox").is_checked()

Arguments

Returns

is_disabledAdded in: v1.14 locator.is_disabled

Returns whether the element is disabled, the opposite of enabled.

Usage

disabled = page.get_by_role("button").is_disabled()
disabled = await page.get_by_role("button").is_disabled()

Arguments

Returns

is_editableAdded in: v1.14 locator.is_editable

Returns whether the element is editable. If the target element is not an <input>, <textarea>, <select>, [contenteditable] and does not have a role allowing [aria-readonly], this method throws an error.

Usage

editable = page.get_by_role("textbox").is_editable()
editable = await page.get_by_role("textbox").is_editable()

Arguments

Returns

is_enabledAdded in: v1.14 locator.is_enabled

Returns whether the element is enabled.

Usage

enabled = page.get_by_role("button").is_enabled()
enabled = await page.get_by_role("button").is_enabled()

Arguments

Returns

is_hiddenAdded in: v1.14 locator.is_hidden

Returns whether the element is hidden, the opposite of visible.

Usage

hidden = page.get_by_role("button").is_hidden()
hidden = await page.get_by_role("button").is_hidden()

Arguments

Returns

is_visibleAdded in: v1.14 locator.is_visible

Returns whether the element is visible.

Usage

visible = page.get_by_role("button").is_visible()
visible = await page.get_by_role("button").is_visible()

Arguments

Returns

locatorAdded in: v1.14 locator.locator

The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter() method.

Learn more about locators.

Usage

locator.locator(selector_or_locator)
locator.locator(selector_or_locator, **kwargs)

Arguments

Returns

nthAdded in: v1.14 locator.nth

Returns locator to the n-th matching element. It's zero based, nth(0) selects the first element.

Usage

banana = page.get_by_role("listitem").nth(2)
banana = await page.get_by_role("listitem").nth(2)

Arguments

Returns

or_Added in: v1.33 locator.or_

Creates a locator matching all elements that match one or both of the two locators.

Note that when both locators match something, the resulting locator will have multiple matches, potentially causing a locator strictness violation.

Usage

Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.

note

If both "New email" button and security dialog appear on screen, the "or" locator will match both of them, possibly throwing the "strict mode violation" error. In this case, you can use locator.first to only match one of them.

new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
expect(new_email.or_(dialog).first).to_be_visible()
if (dialog.is_visible()):
page.get_by_role("button", name="Dismiss").click()
new_email.click()
new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
await expect(new_email.or_(dialog).first).to_be_visible()
if (await dialog.is_visible()):
await page.get_by_role("button", name="Dismiss").click()
await new_email.click()

Arguments

Returns

pressAdded in: v1.14 locator.press

Focuses the matching element and presses a combination of the keys.

Usage

page.get_by_role("textbox").press("Backspace")
await page.get_by_role("textbox").press("Backspace")

Arguments

Returns

Details

Focuses the element, and then uses keyboard.down() and keyboard.up().

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o", key: "Control++ or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

press_sequentiallyAdded in: v1.38 locator.press_sequentially

tip

In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page.

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use locator.press().

Usage

locator.press_sequentially("hello") 
locator.press_sequentially("world", delay=100)
await locator.press_sequentially("hello") 
await locator.press_sequentially("world", delay=100)

An example of typing into a text field and then submitting the form:

locator = page.get_by_label("Password")
locator.press_sequentially("my password")
locator.press("Enter")
locator = page.get_by_label("Password")
await locator.press_sequentially("my password")
await locator.press("Enter")

Arguments

Returns

screenshotAdded in: v1.14 locator.screenshot

Take a screenshot of the element matching the locator.

Usage

page.get_by_role("link").screenshot()
await page.get_by_role("link").screenshot()

Disable animations and save screenshot to a file:

page.get_by_role("link").screenshot(animations="disabled", path="link.png")
await page.get_by_role("link").screenshot(animations="disabled", path="link.png")

Arguments

Returns

Details

This method captures a screenshot of the page, clipped to the size and position of a particular element matching the locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.

This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.

Returns the buffer with the captured screenshot.

scroll_into_view_if_neededAdded in: v1.14 locator.scroll_into_view_if_needed

This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's ratio.

See scrolling for alternative ways to scroll.

Usage

locator.scroll_into_view_if_needed()
locator.scroll_into_view_if_needed(**kwargs)

Arguments

Returns

select_optionAdded in: v1.14 locator.select_option

Selects option or options in <select>.

Usage

<select multiple>
<option value="red">Red</option>
<option value="green">Green</option>
<option value="blue">Blue</option>
</select>

element.select_option("blue")

element.select_option(label="blue")

element.select_option(value=["red", "green", "blue"])

await element.select_option("blue")

await element.select_option(label="blue")

await element.select_option(value=["red", "green", "blue"])

Arguments

Returns

Details

This method waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.

If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

Returns the array of option values that have been successfully selected.

Triggers a change and input event once all the provided options have been selected.

select_textAdded in: v1.14 locator.select_text

This method waits for actionability checks, then focuses the element and selects all its text content.

If the element is inside the <label> element that has an associated control, focuses and selects text in the control instead.

Usage

locator.select_text()
locator.select_text(**kwargs)

Arguments

Returns

set_checkedAdded in: v1.15 locator.set_checked

Set the state of a checkbox or a radio element.

Usage

page.get_by_role("checkbox").set_checked(True)
await page.get_by_role("checkbox").set_checked(True)

Arguments

Returns

Details

This method checks or unchecks an element by performing the following steps:

  1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  2. If the element already has the right checked state, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

set_input_filesAdded in: v1.14 locator.set_input_files

Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.

Usage


page.get_by_label("Upload file").set_input_files('myfile.pdf')


page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])


page.get_by_label("Upload directory").set_input_files('mydir')


page.get_by_label("Upload file").set_input_files([])


page.get_by_label("Upload file").set_input_files(
files=[
{"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
],
)

await page.get_by_label("Upload file").set_input_files('myfile.pdf')


await page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])


await page.get_by_label("Upload directory").set_input_files('mydir')


await page.get_by_label("Upload file").set_input_files([])


await page.get_by_label("Upload file").set_input_files(
files=[
{"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
],
)

Arguments

Returns

Details

Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

This method expects Locator to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

tapAdded in: v1.14 locator.tap

Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually dispatching touch events, see the emulating legacy touch events page.

Usage

locator.tap()
locator.tap(**kwargs)

Arguments

Returns

Details

This method taps the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.touchscreen to tap the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

element.tap() requires that the hasTouch option of the browser context be set to true.

text_contentAdded in: v1.14 locator.text_content

Returns the node.textContent.

Usage

locator.text_content()
locator.text_content(**kwargs)

Arguments

Returns

uncheckAdded in: v1.14 locator.uncheck

Ensure that checkbox or radio element is unchecked.

Usage

page.get_by_role("checkbox").uncheck()
await page.get_by_role("checkbox").uncheck()

Arguments

Returns

Details

This method unchecks the element by performing the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Ensure that the element is now unchecked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

wait_forAdded in: v1.16 locator.wait_for

Returns when element specified by locator satisfies the state option.

If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to timeout milliseconds until the condition is met.

Usage

order_sent = page.locator("#order-sent")
order_sent.wait_for()
order_sent = page.locator("#order-sent")
await order_sent.wait_for()

Arguments

Returns

Properties content_frameAdded in: v1.43 locator.content_frame

Returns a FrameLocator object pointing to the same iframe as this locator.

Useful when you have a Locator object obtained somewhere, and later on would like to interact with the content inside the frame.

For a reverse operation, use frame_locator.owner.

Usage

locator = page.locator("iframe[name=\"embedded\"]")

frame_locator = locator.content_frame
frame_locator.get_by_role("button").click()
locator = page.locator("iframe[name=\"embedded\"]")

frame_locator = locator.content_frame
await frame_locator.get_by_role("button").click()

Returns

firstAdded in: v1.14 locator.first

Returns locator to the first matching element.

Usage

Returns

lastAdded in: v1.14 locator.last

Returns locator to the last matching element.

Usage

banana = page.get_by_role("listitem").last
banana = await page.get_by_role("listitem").last

Returns

pageAdded in: v1.19 locator.page

A page this locator belongs to.

Usage

Returns

Deprecated element_handleAdded in: v1.14 locator.element_handle

Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If multiple elements match the locator, throws.

Usage

locator.element_handle()
locator.element_handle(**kwargs)

Arguments

Returns

element_handlesAdded in: v1.14 locator.element_handles

Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.

Usage

locator.element_handles()

Returns

typeAdded in: v1.14 locator.type

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use locator.press().

Usage

Arguments

Returns


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4