 |
Qucs-S S-parameter Viewer & RF Synthesis Tools
|
Loading...
Searching...
No Matches
|
Qucs-S S-parameter Viewer & RF Synthesis Tools
|
Public Member Functions | |
| "Page" | page (self) |
| "Locator" | first (self) |
| "Locator" | last (self) |
| "FrameLocator" | content_frame (self) |
| typing.Optional[str] | description (self) |
| typing.Optional[FloatRect] | bounding_box (self, *typing.Optional[float] timeout=None) |
| None | check (self, *typing.Optional[Position] position=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None) |
| None | click (self, *typing.Optional[typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]] modifiers=None, typing.Optional[Position] position=None, typing.Optional[float] delay=None, typing.Optional[Literal["left", "middle", "right"]] button=None, typing.Optional[int] click_count=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None, typing.Optional[int] steps=None) |
| None | dblclick (self, *typing.Optional[typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]] modifiers=None, typing.Optional[Position] position=None, typing.Optional[float] delay=None, typing.Optional[Literal["left", "middle", "right"]] button=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None, typing.Optional[int] steps=None) |
| None | dispatch_event (self, str type, typing.Optional[typing.Dict] event_init=None, *typing.Optional[float] timeout=None) |
| typing.Any | evaluate (self, str expression, typing.Optional[typing.Any] arg=None, *typing.Optional[float] timeout=None) |
| typing.Any | evaluate_all (self, str expression, typing.Optional[typing.Any] arg=None) |
| "JSHandle" | evaluate_handle (self, str expression, typing.Optional[typing.Any] arg=None, *typing.Optional[float] timeout=None) |
| None | fill (self, str value, *typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] force=None) |
| None | clear (self, *typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] force=None) |
| "Locator" | locator (self, typing.Union[str, "Locator"] selector_or_locator, *typing.Optional[typing.Union[typing.Pattern[str], str]] has_text=None, typing.Optional[typing.Union[typing.Pattern[str], str]] has_not_text=None, typing.Optional["Locator"] has=None, typing.Optional["Locator"] has_not=None) |
| "Locator" | get_by_alt_text (self, typing.Union[str, typing.Pattern[str]] text, *typing.Optional[bool] exact=None) |
| "Locator" | get_by_label (self, typing.Union[str, typing.Pattern[str]] text, *typing.Optional[bool] exact=None) |
| "Locator" | get_by_placeholder (self, typing.Union[str, typing.Pattern[str]] text, *typing.Optional[bool] exact=None) |
| "Locator" | get_by_role (self, Literal["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem",] role, *typing.Optional[bool] checked=None, typing.Optional[bool] disabled=None, typing.Optional[bool] expanded=None, typing.Optional[bool] include_hidden=None, typing.Optional[int] level=None, typing.Optional[typing.Union[typing.Pattern[str], str]] name=None, typing.Optional[bool] pressed=None, typing.Optional[bool] selected=None, typing.Optional[bool] exact=None) |
| "Locator" | get_by_test_id (self, typing.Union[str, typing.Pattern[str]] test_id) |
| "Locator" | get_by_text (self, typing.Union[str, typing.Pattern[str]] text, *typing.Optional[bool] exact=None) |
| "Locator" | get_by_title (self, typing.Union[str, typing.Pattern[str]] text, *typing.Optional[bool] exact=None) |
| "FrameLocator" | frame_locator (self, str selector) |
| "ElementHandle" | element_handle (self, *typing.Optional[float] timeout=None) |
| typing.List["ElementHandle"] | element_handles (self) |
| "Locator" | nth (self, int index) |
| "Locator" | describe (self, str description) |
| "Locator" | filter (self, *typing.Optional[typing.Union[typing.Pattern[str], str]] has_text=None, typing.Optional[typing.Union[typing.Pattern[str], str]] has_not_text=None, typing.Optional["Locator"] has=None, typing.Optional["Locator"] has_not=None, typing.Optional[bool] visible=None) |
| "Locator" | or_ (self, "Locator" locator) |
| "Locator" | and_ (self, "Locator" locator) |
| None | focus (self, *typing.Optional[float] timeout=None) |
| None | blur (self, *typing.Optional[float] timeout=None) |
| typing.List["Locator"] | all (self) |
| int | count (self) |
| None | drag_to (self, "Locator" target, *typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[float] timeout=None, typing.Optional[bool] trial=None, typing.Optional[Position] source_position=None, typing.Optional[Position] target_position=None, typing.Optional[int] steps=None) |
| typing.Optional[str] | get_attribute (self, str name, *typing.Optional[float] timeout=None) |
| None | hover (self, *typing.Optional[typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]] modifiers=None, typing.Optional[Position] position=None, typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] force=None, typing.Optional[bool] trial=None) |
| str | inner_html (self, *typing.Optional[float] timeout=None) |
| str | inner_text (self, *typing.Optional[float] timeout=None) |
| str | input_value (self, *typing.Optional[float] timeout=None) |
| bool | is_checked (self, *typing.Optional[float] timeout=None) |
| bool | is_disabled (self, *typing.Optional[float] timeout=None) |
| bool | is_editable (self, *typing.Optional[float] timeout=None) |
| bool | is_enabled (self, *typing.Optional[float] timeout=None) |
| bool | is_hidden (self, *typing.Optional[float] timeout=None) |
| bool | is_visible (self, *typing.Optional[float] timeout=None) |
| None | press (self, str key, *typing.Optional[float] delay=None, typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None) |
| bytes | screenshot (self, *typing.Optional[float] timeout=None, typing.Optional[Literal["jpeg", "png"]] type=None, typing.Optional[typing.Union[pathlib.Path, str]] path=None, typing.Optional[int] quality=None, typing.Optional[bool] omit_background=None, typing.Optional[Literal["allow", "disabled"]] animations=None, typing.Optional[Literal["hide", "initial"]] caret=None, typing.Optional[Literal["css", "device"]] scale=None, typing.Optional[typing.Sequence["Locator"]] mask=None, typing.Optional[str] mask_color=None, typing.Optional[str] style=None) |
| str | aria_snapshot (self, *typing.Optional[float] timeout=None) |
| None | scroll_into_view_if_needed (self, *typing.Optional[float] timeout=None) |
| typing.List[str] | select_option (self, typing.Optional[typing.Union[str, typing.Sequence[str]]] value=None, *typing.Optional[typing.Union[int, typing.Sequence[int]]] index=None, typing.Optional[typing.Union[str, typing.Sequence[str]]] label=None, typing.Optional[typing.Union["ElementHandle", typing.Sequence["ElementHandle"]]] element=None, typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] force=None) |
| None | select_text (self, *typing.Optional[bool] force=None, typing.Optional[float] timeout=None) |
| None | set_input_files (self, typing.Union[str, pathlib.Path, FilePayload, typing.Sequence[typing.Union[str, pathlib.Path]], typing.Sequence[FilePayload],] files, *typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None) |
| None | tap (self, *typing.Optional[typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]] modifiers=None, typing.Optional[Position] position=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None) |
| typing.Optional[str] | text_content (self, *typing.Optional[float] timeout=None) |
| None | type (self, str text, *typing.Optional[float] delay=None, typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None) |
| None | press_sequentially (self, str text, *typing.Optional[float] delay=None, typing.Optional[float] timeout=None, typing.Optional[bool] no_wait_after=None) |
| None | uncheck (self, *typing.Optional[Position] position=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None) |
| typing.List[str] | all_inner_texts (self) |
| typing.List[str] | all_text_contents (self) |
| None | wait_for (self, *typing.Optional[float] timeout=None, typing.Optional[Literal["attached", "detached", "hidden", "visible"]] state=None) |
| None | set_checked (self, bool checked, *typing.Optional[Position] position=None, typing.Optional[float] timeout=None, typing.Optional[bool] force=None, typing.Optional[bool] no_wait_after=None, typing.Optional[bool] trial=None) |
| None | highlight (self) |
 Public Member Functions inherited from playwright._impl._sync_base.SyncBase | |
| None | __init__ (self, Any impl_obj) |
| str | __str__ (self) |
| None | on (self, Any event, Any f) |
| None | once (self, Any event, Any f) |
| None | remove_listener (self, Any event, Any f) |
| Public Member Functions inherited from playwright._impl._impl_to_api_mapping.ImplWrapper | |
| str | __repr__ (self) |
Additional Inherited Members | |
| Protected Member Functions inherited from playwright._impl._sync_base.SyncBase | |
| Any | _sync (self, Union[Coroutine[Any, Any, Any], Generator[Any, Any, Any]] coro) |
| Callable[..., None] | _wrap_handler (self, Union[Callable[..., Any], Any] handler) |
| Protected Attributes inherited from playwright._impl._sync_base.SyncBase | |
| _dispatcher_fiber | |
| _loop | |
| Protected Attributes inherited from playwright._impl._impl_to_api_mapping.ImplWrapper | |
| _impl_obj | |
| typing.List["Locator"] playwright.sync_api._generated.Locator.all | ( | self | ) |
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**
```py
for li in page.get_by_role('listitem').all():
li.click();
```
Returns
-------
List[Locator]
| typing.List[str] playwright.sync_api._generated.Locator.all_inner_texts | ( | self | ) |
Locator.all_inner_texts Returns an array of `node.innerText` values for all matching nodes. **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` with `useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details. **Usage** ```py texts = page.get_by_role(\"link\").all_inner_texts() ``` Returns ------- List[str]
| typing.List[str] playwright.sync_api._generated.Locator.all_text_contents | ( | self | ) |
Locator.all_text_contents Returns an array of `node.textContent` values for all matching nodes. **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details. **Usage** ```py texts = page.get_by_role(\"link\").all_text_contents() ``` Returns ------- List[str]
| "Locator" playwright.sync_api._generated.Locator.and_ | ( | self, | |
| "Locator" | locator | ||
| ) |
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.
```py
button = page.get_by_role(\"button\").and_(page.get_by_title(\"Subscribe\"))
```
Parameters
----------
locator : Locator
Additional locator to match.
Returns
-------
Locator
| str playwright.sync_api._generated.Locator.aria_snapshot | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.aria_snapshot
Captures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/python/docs/aria-snapshots) and
`locator_assertions.to_match_aria_snapshot()` for the corresponding assertion.
**Usage**
```py
page.get_by_role(\"link\").aria_snapshot()
```
**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](https://yaml.org/spec/1.2.2/) markup language:
- The keys of the objects are the roles and optional accessible names of the elements.
- The values are either text content or an array of child elements.
- Generic static text can be represented with the `text` key.
Below is the HTML markup and the respective ARIA snapshot:
```html
<ul aria-label=\"Links\">
<li><a href=\"/\">Home</a></li>
<li><a href=\"/about\">About</a></li>
<ul>
```
```yml
- list \"Links\":
- listitem:
- link \"Home\"
- listitem:
- link \"About\"
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
str
| None playwright.sync_api._generated.Locator.blur | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.blur
Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
| typing.Optional[FloatRect] playwright.sync_api._generated.Locator.bounding_box | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
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.
**Details**
Scrolling affects the returned bounding box, similarly to
[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/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](https://developer.mozilla.org/en-US/docs/Web/API/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.
**Usage**
```py
box = page.get_by_role(\"button\").bounding_box()
page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
Union[{x: float, y: float, width: float, height: float}, None]
| None playwright.sync_api._generated.Locator.check | ( | self, | |
| *typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None |
||
| ) |
Locator.check
Ensure that checkbox or radio element is checked.
**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.
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. Use `page.mouse` to click in the center of the element.
1. 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.
**Usage**
```py
page.get_by_role(\"checkbox\").check()
```
Parameters
----------
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it.
| None playwright.sync_api._generated.Locator.clear | ( | self, | |
| *typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | force = None |
||
| ) |
Locator.clear
Clear the input field.
**Details**
This method waits for [actionability](https://playwright.dev/python/docs/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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be cleared
instead.
**Usage**
```py
page.get_by_role(\"textbox\").clear()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
| None playwright.sync_api._generated.Locator.click | ( | self, | |
| *typing.Optional[ typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]] ] | modifiers = None, |
||
| typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | delay = None, |
||
| typing.Optional[Literal["left", "middle", "right"]] | button = None, |
||
| typing.Optional[int] | click_count = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None, |
||
| typing.Optional[int] | steps = None |
||
| ) |
Locator.click
Click an element.
**Details**
This method clicks the element by performing the following steps:
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. Use `page.mouse` to click in the center of the element, or the specified `position`.
1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` 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.
**Usage**
Click a button:
```py
page.get_by_role(\"button\").click()
```
Shift-right-click at a specific position on a canvas:
```py
page.locator(\"canvas\").click(
button=\"right\", modifiers=[\"Shift\"], position={\"x\": 23, \"y\": 32}
)
```
Parameters
----------
modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
"Control" on Windows and Linux and to "Meta" on macOS.
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
delay : Union[float, None]
Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
button : Union["left", "middle", "right", None]
Defaults to `left`.
click_count : Union[int, None]
defaults to 1. See [UIEvent.detail].
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to `false`.
Deprecated: This option will default to `true` in the future.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
`modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
are pressed.
steps : Union[int, None]
Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
| "FrameLocator" playwright.sync_api._generated.Locator.content_frame | ( | self | ) |
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** ```py locator = page.locator(\"iframe[name=\\\"embedded\\\"]\") # ... frame_locator = locator.content_frame frame_locator.get_by_role(\"button\").click() ``` Returns ------- FrameLocator
| int playwright.sync_api._generated.Locator.count | ( | self | ) |
Locator.count Returns the number of elements matching the locator. **NOTE** If you need to assert the number of elements on the page, prefer `locator_assertions.to_have_count()` to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details. **Usage** ```py count = page.get_by_role(\"listitem\").count() ``` Returns ------- int
| None playwright.sync_api._generated.Locator.dblclick | ( | self, | |
| *typing.Optional[ typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]] ] | modifiers = None, |
||
| typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | delay = None, |
||
| typing.Optional[Literal["left", "middle", "right"]] | button = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None, |
||
| typing.Optional[int] | steps = None |
||
| ) |
Locator.dblclick
Double-click an element.
**Details**
This method double clicks the element by performing the following steps:
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. 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.
Parameters
----------
modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
"Control" on Windows and Linux and to "Meta" on macOS.
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
delay : Union[float, None]
Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
button : Union["left", "middle", "right", None]
Defaults to `left`.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
`modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
are pressed.
steps : Union[int, None]
Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
| "Locator" playwright.sync_api._generated.Locator.describe | ( | self, | |
| str | description | ||
| ) |
Locator.describe
Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the
same element.
**Usage**
```py
button = page.get_by_test_id(\"btn-sub\").describe(\"Subscribe button\")
button.click()
```
Parameters
----------
description : str
Locator description.
Returns
-------
Locator
| typing.Optional[str] playwright.sync_api._generated.Locator.description | ( | self | ) |
Locator.description Returns locator description previously set with `locator.describe()`. Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available. **Usage** ```py button = page.get_by_role(\"button\").describe(\"Subscribe button\") print(button.description()) # \"Subscribe button\" input = page.get_by_role(\"textbox\") print(input.description()) # None ``` Returns ------- Union[str, None]
| None playwright.sync_api._generated.Locator.dispatch_event | ( | self, | |
| str | type, | ||
| typing.Optional[typing.Dict] | event_init = None, |
||
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.dispatch_event
Programmatically dispatch an event on the matching element.
**Usage**
```py
locator.dispatch_event(\"click\")
```
**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()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`
properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
```py
data_transfer = page.evaluate_handle(\"new DataTransfer()\")
locator.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})
```
Parameters
----------
type : str
DOM event type: `"click"`, `"dragstart"`, etc.
event_init : Union[Dict, None]
Optional event-specific initialization properties.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
| None playwright.sync_api._generated.Locator.drag_to | ( | self, | |
| "Locator" | target, | ||
| *typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | trial = None, |
||
| typing.Optional[Position] | source_position = None, |
||
| typing.Optional[Position] | target_position = None, |
||
| typing.Optional[int] | steps = None |
||
| ) |
Locator.drag_to
Drag the source element towards the target element and drop it.
**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`.
**Usage**
```py
source = page.locator(\"#source\")
target = page.locator(\"#target\")
source.drag_to(target)
# or specify exact positions relative to the top-left corners of the elements:
source.drag_to(
target,
source_position={\"x\": 34, \"y\": 7},
target_position={\"x\": 10, \"y\": 20}
)
```
Parameters
----------
target : Locator
Locator of the element to drag to.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it.
source_position : Union[{x: float, y: float}, None]
Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not
specified, some visible point of the element is used.
target_position : Union[{x: float, y: float}, None]
Drops on the target element at this point relative to the top-left corner of the element's padding box. If not
specified, some visible point of the element is used.
steps : Union[int, None]
Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup`
of the drag. When set to 1, emits a single `mousemove` event at the destination location.
| "ElementHandle" playwright.sync_api._generated.Locator.element_handle | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.element_handle
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.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
ElementHandle
| typing.List["ElementHandle"] playwright.sync_api._generated.Locator.element_handles | ( | self | ) |
Locator.element_handles Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list. Returns ------- List[ElementHandle]
| typing.Any playwright.sync_api._generated.Locator.evaluate | ( | self, | |
| str | expression, | ||
| typing.Optional[typing.Any] | arg = None, |
||
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.evaluate
Execute JavaScript code in the page, taking the matching element as an argument.
**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.
**Usage**
Passing argument to `expression`:
```py
result = page.get_by_testid(\"myId\").evaluate(\"(element, [x, y]) => element.textContent + ' ' + x * y\", [7, 8])
print(result) # prints \"myId text 56\"
```
Parameters
----------
expression : str
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
function is automatically invoked.
arg : Union[Any, None]
Optional argument to pass to `expression`.
timeout : Union[float, None]
Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved,
evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
Returns
-------
Any
| typing.Any playwright.sync_api._generated.Locator.evaluate_all | ( | self, | |
| str | expression, | ||
| typing.Optional[typing.Any] | arg = None |
||
| ) |
Locator.evaluate_all
Execute JavaScript code in the page, taking all matching elements as an argument.
**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.
**Usage**
```py
locator = page.locator(\"div\")
more_than_ten = locator.evaluate_all(\"(divs, min) => divs.length > min\", 10)
```
Parameters
----------
expression : str
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
function is automatically invoked.
arg : Union[Any, None]
Optional argument to pass to `expression`.
Returns
-------
Any
| "JSHandle" playwright.sync_api._generated.Locator.evaluate_handle | ( | self, | |
| str | expression, | ||
| typing.Optional[typing.Any] | arg = None, |
||
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.evaluate_handle
Execute JavaScript code in the page, taking the matching element as an argument, and return a `JSHandle` with the
result.
**Details**
Returns the return value of `expression` as a`JSHandle`, 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.
Parameters
----------
expression : str
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
function is automatically invoked.
arg : Union[Any, None]
Optional argument to pass to `expression`.
timeout : Union[float, None]
Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved,
evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
Returns
-------
JSHandle
| None playwright.sync_api._generated.Locator.fill | ( | self, | |
| str | value, | ||
| *typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | force = None |
||
| ) |
Locator.fill
Set a value to the input field.
**Usage**
```py
page.get_by_role(\"textbox\").fill(\"example value\")
```
**Details**
This method waits for [actionability](https://playwright.dev/python/docs/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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
instead.
To send fine-grained keyboard events, use `locator.press_sequentially()`.
Parameters
----------
value : str
Value to set for the `<input>`, `<textarea>` or `[contenteditable]` element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
| "Locator" playwright.sync_api._generated.Locator.filter | ( | self, | |
| *typing.Optional[typing.Union[typing.Pattern[str], str]] | has_text = None, |
||
| typing.Optional[typing.Union[typing.Pattern[str], str]] | has_not_text = None, |
||
| typing.Optional["Locator"] | has = None, |
||
| typing.Optional["Locator"] | has_not = None, |
||
| typing.Optional[bool] | visible = None |
||
| ) |
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**
```py
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()
```
Parameters
----------
has_text : Union[Pattern[str], str, None]
Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
`<article><div>Playwright</div></article>`.
has_not_text : Union[Pattern[str], str, None]
Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
When passed a [string], matching is case-insensitive and searches for a substring.
has : Union[Locator, None]
Narrows down the results of the method to those which contain elements matching this relative locator. For example,
`article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
the document root. For example, you can find `content` that has `div` in
`<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
has_not : Union[Locator, None]
Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
visible : Union[bool, None]
Only matches visible or invisible elements.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.first | ( | self | ) |
Locator.first Returns locator to the first matching element. Returns ------- Locator
| None playwright.sync_api._generated.Locator.focus | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.focus
Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
| "FrameLocator" playwright.sync_api._generated.Locator.frame_locator | ( | self, | |
| str | selector | ||
| ) |
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**
```py
locator = page.frame_locator(\"iframe\").get_by_text(\"Submit\")
locator.click()
```
Parameters
----------
selector : str
A selector to use when resolving DOM element.
Returns
-------
FrameLocator
| typing.Optional[str] playwright.sync_api._generated.Locator.get_attribute | ( | self, | |
| str | name, | ||
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.get_attribute
Returns the matching element's attribute value.
**NOTE** If you need to assert an element's attribute, prefer `locator_assertions.to_have_attribute()` to
avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
Parameters
----------
name : str
Attribute name to get the value for.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
Union[str, None]
| "Locator" playwright.sync_api._generated.Locator.get_by_alt_text | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | text, | ||
| *typing.Optional[bool] | exact = None |
||
| ) |
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\":
```html
<img alt='Playwright logo'>
```
```py
page.get_by_alt_text(\"Playwright logo\").click()
```
Parameters
----------
text : Union[Pattern[str], str]
Text to locate the element for.
exact : Union[bool, None]
Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_label | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | text, | ||
| *typing.Optional[bool] | exact = None |
||
| ) |
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:
```html
<input aria-label=\"Username\">
<label for=\"password-input\">Password:</label>
<input id=\"password-input\">
```
```py
page.get_by_label(\"Username\").fill(\"john\")
page.get_by_label(\"Password\").fill(\"secret\")
```
Parameters
----------
text : Union[Pattern[str], str]
Text to locate the element for.
exact : Union[bool, None]
Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_placeholder | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | text, | ||
| *typing.Optional[bool] | exact = None |
||
| ) |
Locator.get_by_placeholder
Allows locating input elements by the placeholder text.
**Usage**
For example, consider the following DOM structure.
```html
<input type=\"email\" placeholder=\"name@example.com\" />
```
You can fill the input after locating it by the placeholder text:
```py
page.get_by_placeholder(\"name@example.com\").fill(\"playwright@microsoft.com\")
```
Parameters
----------
text : Union[Pattern[str], str]
Text to locate the element for.
exact : Union[bool, None]
Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_role | ( | self, | |
| Literal[ "alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem", ] | role, | ||
| *typing.Optional[bool] | checked = None, |
||
| typing.Optional[bool] | disabled = None, |
||
| typing.Optional[bool] | expanded = None, |
||
| typing.Optional[bool] | include_hidden = None, |
||
| typing.Optional[int] | level = None, |
||
| typing.Optional[typing.Union[typing.Pattern[str], str]] | name = None, |
||
| typing.Optional[bool] | pressed = None, |
||
| typing.Optional[bool] | selected = None, |
||
| typing.Optional[bool] | exact = None |
||
| ) |
Locator.get_by_role
Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
[ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
[accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
**Usage**
Consider the following DOM structure.
```html
<h3>Sign up</h3>
<label>
<input type=\"checkbox\" /> Subscribe
</label>
<br/>
<button>Submit</button>
```
You can locate each element by it's implicit role:
```py
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()
```
**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](https://w3c.github.io/html-aam/#html-element-role-mappings)
that is recognized by the role selector. You can find all the
[supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend**
duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
Parameters
----------
role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
Required aria role.
checked : Union[bool, None]
An attribute that is usually set by `aria-checked` or native `<input type=checkbox>` controls.
Learn more about [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked).
disabled : Union[bool, None]
An attribute that is usually set by `aria-disabled` or `disabled`.
**NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about
[`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled).
expanded : Union[bool, None]
An attribute that is usually set by `aria-expanded`.
Learn more about [`aria-expanded`](https://www.w3.org/TR/wai-aria-1.2/#aria-expanded).
include_hidden : Union[bool, None]
Option that controls whether hidden elements are matched. By default, only non-hidden elements, as
[defined by ARIA](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), are matched by role selector.
Learn more about [`aria-hidden`](https://www.w3.org/TR/wai-aria-1.2/#aria-hidden).
level : Union[int, None]
A number attribute that is usually present for roles `heading`, `listitem`, `row`, `treeitem`, with default values
for `<h1>-<h6>` elements.
Learn more about [`aria-level`](https://www.w3.org/TR/wai-aria-1.2/#aria-level).
name : Union[Pattern[str], str, None]
Option to match the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). By default, matching is
case-insensitive and searches for a substring, use `exact` to control this behavior.
Learn more about [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
pressed : Union[bool, None]
An attribute that is usually set by `aria-pressed`.
Learn more about [`aria-pressed`](https://www.w3.org/TR/wai-aria-1.2/#aria-pressed).
selected : Union[bool, None]
An attribute that is usually set by `aria-selected`.
Learn more about [`aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).
exact : Union[bool, None]
Whether `name` is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when `name` is a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_test_id | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | test_id | ||
| ) |
Locator.get_by_test_id
Locate element by the test id.
**Usage**
Consider the following DOM structure.
```html
<button data-testid=\"directions\">Itinéraire</button>
```
You can locate the element by it's test id:
```py
page.get_by_test_id(\"directions\").click()
```
**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.
Parameters
----------
test_id : Union[Pattern[str], str]
Id to locate the element by.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_text | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | text, | ||
| *typing.Optional[bool] | exact = None |
||
| ) |
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:
```html
<div>Hello <span>world</span></div>
<div>Hello</div>
```
You can locate by text substring, exact string, or a regular expression:
```py
# Matches <span>
page.get_by_text(\"world\")
# Matches first <div>
page.get_by_text(\"Hello world\")
# Matches second <div>
page.get_by_text(\"Hello\", exact=True)
# Matches both <div>s
page.get_by_text(re.compile(\"Hello\"))
# Matches second <div>
page.get_by_text(re.compile(\"^hello$\", re.IGNORECASE))
```
**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\">`.
Parameters
----------
text : Union[Pattern[str], str]
Text to locate the element for.
exact : Union[bool, None]
Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.get_by_title | ( | self, | |
| typing.Union[str, typing.Pattern[str]] | text, | ||
| *typing.Optional[bool] | exact = None |
||
| ) |
Locator.get_by_title
Allows locating elements by their title attribute.
**Usage**
Consider the following DOM structure.
```html
<span title='Issues count'>25 issues</span>
```
You can check the issues count after locating it by the title text:
```py
expect(page.get_by_title(\"Issues count\")).to_have_text(\"25 issues\")
```
Parameters
----------
text : Union[Pattern[str], str]
Text to locate the element for.
exact : Union[bool, None]
Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
regular expression. Note that exact match still trims whitespace.
Returns
-------
Locator
| None playwright.sync_api._generated.Locator.highlight | ( | self | ) |
Locator.highlight Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses `locator.highlight()`.
| None playwright.sync_api._generated.Locator.hover | ( | self, | |
| *typing.Optional[ typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]] ] | modifiers = None, |
||
| typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | trial = None |
||
| ) |
Locator.hover
Hover over the matching element.
**Usage**
```py
page.get_by_role(\"link\").hover()
```
**Details**
This method hovers over the element by performing the following steps:
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. 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.
Parameters
----------
modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
"Control" on Windows and Linux and to "Meta" on macOS.
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
`modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
are pressed.
| str playwright.sync_api._generated.Locator.inner_html | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.inner_html
Returns the [`element.innerHTML`](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML).
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
str
| str playwright.sync_api._generated.Locator.inner_text | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.inner_text
Returns the [`element.innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText).
**NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` with
`useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
str
| str playwright.sync_api._generated.Locator.input_value | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.input_value
Returns the value for the matching `<input>` or `<textarea>` or `<select>` element.
**NOTE** If you need to assert input value, prefer `locator_assertions.to_have_value()` to avoid flakiness.
See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
value = page.get_by_role(\"textbox\").input_value()
```
**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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the
control.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
str
| bool playwright.sync_api._generated.Locator.is_checked | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_checked
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
**NOTE** If you need to assert that checkbox is checked, prefer `locator_assertions.to_be_checked()` to avoid
flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
checked = page.get_by_role(\"checkbox\").is_checked()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
bool
| bool playwright.sync_api._generated.Locator.is_disabled | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_disabled
Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
**NOTE** If you need to assert that an element is disabled, prefer `locator_assertions.to_be_disabled()` to
avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
disabled = page.get_by_role(\"button\").is_disabled()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
bool
| bool playwright.sync_api._generated.Locator.is_editable | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_editable
Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#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.
**NOTE** If you need to assert that an element is editable, prefer `locator_assertions.to_be_editable()` to
avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
editable = page.get_by_role(\"textbox\").is_editable()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
bool
| bool playwright.sync_api._generated.Locator.is_enabled | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_enabled
Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
**NOTE** If you need to assert that an element is enabled, prefer `locator_assertions.to_be_enabled()` to
avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
enabled = page.get_by_role(\"button\").is_enabled()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
bool
| bool playwright.sync_api._generated.Locator.is_hidden | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_hidden
Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible).
**NOTE** If you need to assert that element is hidden, prefer `locator_assertions.to_be_hidden()` to avoid
flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
hidden = page.get_by_role(\"button\").is_hidden()
```
Parameters
----------
timeout : Union[float, None]
Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
Returns
-------
bool
| bool playwright.sync_api._generated.Locator.is_visible | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.is_visible
Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible).
**NOTE** If you need to assert that element is visible, prefer `locator_assertions.to_be_visible()` to avoid
flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
**Usage**
```py
visible = page.get_by_role(\"button\").is_visible()
```
Parameters
----------
timeout : Union[float, None]
Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
Returns
-------
bool
| "Locator" playwright.sync_api._generated.Locator.last | ( | self | ) |
Locator.last Returns locator to the last matching element. **Usage** ```py banana = page.get_by_role(\"listitem\").last ``` Returns ------- Locator
| "Locator" playwright.sync_api._generated.Locator.locator | ( | self, | |
| typing.Union[str, "Locator"] | selector_or_locator, | ||
| *typing.Optional[typing.Union[typing.Pattern[str], str]] | has_text = None, |
||
| typing.Optional[typing.Union[typing.Pattern[str], str]] | has_not_text = None, |
||
| typing.Optional["Locator"] | has = None, |
||
| typing.Optional["Locator"] | has_not = None |
||
| ) |
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](https://playwright.dev/python/docs/locators).
Parameters
----------
selector_or_locator : Union[Locator, str]
A selector or locator to use when resolving DOM element.
has_text : Union[Pattern[str], str, None]
Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
`<article><div>Playwright</div></article>`.
has_not_text : Union[Pattern[str], str, None]
Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
When passed a [string], matching is case-insensitive and searches for a substring.
has : Union[Locator, None]
Narrows down the results of the method to those which contain elements matching this relative locator. For example,
`article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
the document root. For example, you can find `content` that has `div` in
`<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
has_not : Union[Locator, None]
Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
Returns
-------
Locator
| "Locator" playwright.sync_api._generated.Locator.nth | ( | self, | |
| int | index | ||
| ) |
Locator.nth Returns locator to the n-th matching element. It's zero based, `nth(0)` selects the first element. **Usage** ```py banana = page.get_by_role(\"listitem\").nth(2) ``` Parameters ---------- index : int Returns ------- Locator
| "Locator" playwright.sync_api._generated.Locator.or_ | ( | self, | |
| "Locator" | locator | ||
| ) |
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](https://playwright.dev/python/docs/locators#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](https://playwright.dev/python/docs/locators#strictness). In this case, you can use
`locator.first()` to only match one of them.
```py
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()
```
Parameters
----------
locator : Locator
Alternative locator to match.
Returns
-------
Locator
| "Page" playwright.sync_api._generated.Locator.page | ( | self | ) |
Locator.page A page this locator belongs to. Returns ------- Page
| None playwright.sync_api._generated.Locator.press | ( | self, | |
| str | key, | ||
| *typing.Optional[float] | delay = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None |
||
| ) |
Locator.press
Focuses the matching element and presses a combination of the keys.
**Usage**
```py
page.get_by_role(\"textbox\").press(\"Backspace\")
```
**Details**
Focuses the element, and then uses `keyboard.down()` and `keyboard.up()`.
`key` can specify the intended
[keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
to generate the text for. A superset of the `key` values can be found
[here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). 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.
Parameters
----------
key : str
Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
delay : Union[float, None]
Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to `false`.
Deprecated: This option will default to `true` in the future.
| None playwright.sync_api._generated.Locator.press_sequentially | ( | self, | |
| str | text, | ||
| *typing.Optional[float] | delay = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None |
||
| ) |
Locator.press_sequentially
**NOTE** 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**
```py
locator.press_sequentially(\"hello\") # types instantly
locator.press_sequentially(\"world\", delay=100) # types slower, like a user
```
An example of typing into a text field and then submitting the form:
```py
locator = page.get_by_label(\"Password\")
locator.press_sequentially(\"my password\")
locator.press(\"Enter\")
```
Parameters
----------
text : str
String of characters to sequentially press into a focused element.
delay : Union[float, None]
Time to wait between key presses in milliseconds. Defaults to 0.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
| bytes playwright.sync_api._generated.Locator.screenshot | ( | self, | |
| *typing.Optional[float] | timeout = None, |
||
| typing.Optional[Literal["jpeg", "png"]] | type = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | path = None, |
||
| typing.Optional[int] | quality = None, |
||
| typing.Optional[bool] | omit_background = None, |
||
| typing.Optional[Literal["allow", "disabled"]] | animations = None, |
||
| typing.Optional[Literal["hide", "initial"]] | caret = None, |
||
| typing.Optional[Literal["css", "device"]] | scale = None, |
||
| typing.Optional[typing.Sequence["Locator"]] | mask = None, |
||
| typing.Optional[str] | mask_color = None, |
||
| typing.Optional[str] | style = None |
||
| ) |
Locator.screenshot
Take a screenshot of the element matching the locator.
**Usage**
```py
page.get_by_role(\"link\").screenshot()
```
Disable animations and save screenshot to a file:
```py
page.get_by_role(\"link\").screenshot(animations=\"disabled\", path=\"link.png\")
```
**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](https://playwright.dev/python/docs/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.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
type : Union["jpeg", "png", None]
Specify screenshot type, defaults to `png`.
path : Union[pathlib.Path, str, None]
The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a
relative path, then it is resolved relative to the current working directory. If no path is provided, the image
won't be saved to the disk.
quality : Union[int, None]
The quality of the image, between 0-100. Not applicable to `png` images.
omit_background : Union[bool, None]
Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images.
Defaults to `false`.
animations : Union["allow", "disabled", None]
When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
treatment depending on their duration:
- finite animations are fast-forwarded to completion, so they'll fire `transitionend` event.
- infinite animations are canceled to initial state, and then played over after the screenshot.
Defaults to `"allow"` that leaves animations untouched.
caret : Union["hide", "initial", None]
When set to `"hide"`, screenshot will hide text caret. When set to `"initial"`, text caret behavior will not be
changed. Defaults to `"hide"`.
scale : Union["css", "device", None]
When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so
screenshots of high-dpi devices will be twice as large or even larger.
Defaults to `"device"`.
mask : Union[Sequence[Locator], None]
Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to
invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable
that.
mask_color : Union[str, None]
Specify the color of the overlay box for masked elements, in
[CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`.
style : Union[str, None]
Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make
elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces
the Shadow DOM and applies to the inner frames.
Returns
-------
bytes
| None playwright.sync_api._generated.Locator.scroll_into_view_if_needed | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.scroll_into_view_if_needed
This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then tries to scroll element into view, unless
it is completely visible as defined by
[IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)'s `ratio`.
See [scrolling](https://playwright.dev/python/docs/input#scrolling) for alternative ways to scroll.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
| typing.List[str] playwright.sync_api._generated.Locator.select_option | ( | self, | |
| typing.Optional[typing.Union[str, typing.Sequence[str]]] | value = None, |
||
| *typing.Optional[typing.Union[int, typing.Sequence[int]]] | index = None, |
||
| typing.Optional[typing.Union[str, typing.Sequence[str]]] | label = None, |
||
| typing.Optional[ typing.Union["ElementHandle", typing.Sequence["ElementHandle"]] ] | element = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | force = None |
||
| ) |
Locator.select_option
Selects option or options in `<select>`.
**Details**
This method waits for [actionability](https://playwright.dev/python/docs/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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/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.
**Usage**
```html
<select multiple>
<option value=\"red\">Red</option>
<option value=\"green\">Green</option>
<option value=\"blue\">Blue</option>
</select>
```
```py
# single selection matching the value or label
element.select_option(\"blue\")
# single selection matching the label
element.select_option(label=\"blue\")
# multiple selection for blue, red and second option
element.select_option(value=[\"red\", \"green\", \"blue\"])
```
Parameters
----------
value : Union[Sequence[str], str, None]
Options to select by value. If the `<select>` has the `multiple` attribute, all given options are selected,
otherwise only the first option matching one of the passed options is selected. Optional.
index : Union[Sequence[int], int, None]
Options to select by index. Optional.
label : Union[Sequence[str], str, None]
Options to select by label. If the `<select>` has the `multiple` attribute, all given options are selected,
otherwise only the first option matching one of the passed options is selected. Optional.
element : Union[ElementHandle, Sequence[ElementHandle], None]
Option elements to select. Optional.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
Returns
-------
List[str]
| None playwright.sync_api._generated.Locator.select_text | ( | self, | |
| *typing.Optional[bool] | force = None, |
||
| typing.Optional[float] | timeout = None |
||
| ) |
Locator.select_text
This method waits for [actionability](https://playwright.dev/python/docs/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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in
the control instead.
Parameters
----------
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
| None playwright.sync_api._generated.Locator.set_checked | ( | self, | |
| bool | checked, | ||
| *typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None |
||
| ) |
Locator.set_checked
Set the state of a checkbox or a radio element.
**Usage**
```py
page.get_by_role(\"checkbox\").set_checked(True)
```
**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.
1. If the element already has the right checked state, this method returns immediately.
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
the element is detached during the checks, the whole action is retried.
1. Scroll the element into view if needed.
1. Use `page.mouse` to click in the center of the element.
1. 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.
Parameters
----------
checked : bool
Whether to check or uncheck the checkbox.
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it.
| None playwright.sync_api._generated.Locator.set_input_files | ( | self, | |
| typing.Union[ str, pathlib.Path, FilePayload, typing.Sequence[typing.Union[str, pathlib.Path]], typing.Sequence[FilePayload], ] | files, | ||
| *typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None |
||
| ) |
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**
```py
# Select one file
page.get_by_label(\"Upload file\").set_input_files('myfile.pdf')
# Select multiple files
page.get_by_label(\"Upload files\").set_input_files(['file1.txt', 'file2.txt'])
# Select a directory
page.get_by_label(\"Upload directory\").set_input_files('mydir')
# Remove all the selected files
page.get_by_label(\"Upload file\").set_input_files([])
# Upload buffer from memory
page.get_by_label(\"Upload file\").set_input_files(
files=[
{\"name\": \"test.txt\", \"mimeType\": \"text/plain\", \"buffer\": b\"this is a test\"}
],
)
```
**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](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside
the `<label>` element that has an associated
[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
Parameters
----------
files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
| None playwright.sync_api._generated.Locator.tap | ( | self, | |
| *typing.Optional[ typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]] ] | modifiers = None, |
||
| typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None |
||
| ) |
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](https://playwright.dev/python/docs/touch-events) page.
**Details**
This method taps the element by performing the following steps:
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. 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.
Parameters
----------
modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
"Control" on Windows and Linux and to "Meta" on macOS.
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
`modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
are pressed.
| typing.Optional[str] playwright.sync_api._generated.Locator.text_content | ( | self, | |
| *typing.Optional[float] | timeout = None |
||
| ) |
Locator.text_content
Returns the [`node.textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent).
**NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` to avoid
flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
Returns
-------
Union[str, None]
| None playwright.sync_api._generated.Locator.type | ( | self, | |
| str | text, | ||
| *typing.Optional[float] | delay = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | no_wait_after = None |
||
| ) |
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**
Parameters
----------
text : str
A text to type into a focused element.
delay : Union[float, None]
Time to wait between key presses in milliseconds. Defaults to 0.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
| None playwright.sync_api._generated.Locator.uncheck | ( | self, | |
| *typing.Optional[Position] | position = None, |
||
| typing.Optional[float] | timeout = None, |
||
| typing.Optional[bool] | force = None, |
||
| typing.Optional[bool] | no_wait_after = None, |
||
| typing.Optional[bool] | trial = None |
||
| ) |
Locator.uncheck
Ensure that checkbox or radio element is unchecked.
**Usage**
```py
page.get_by_role(\"checkbox\").uncheck()
```
**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.
1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
1. Scroll the element into view if needed.
1. Use `page.mouse` to click in the center of the element.
1. 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.
Parameters
----------
position : Union[{x: float, y: float}, None]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
the element.
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
force : Union[bool, None]
Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
no_wait_after : Union[bool, None]
This option has no effect.
Deprecated: This option has no effect.
trial : Union[bool, None]
When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
to `false`. Useful to wait until the element is ready for the action without performing it.
| None playwright.sync_api._generated.Locator.wait_for | ( | self, | |
| *typing.Optional[float] | timeout = None, |
||
| typing.Optional[ Literal["attached", "detached", "hidden", "visible"] ] | state = None |
||
| ) |
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**
```py
order_sent = page.locator(\"#order-sent\")
order_sent.wait_for()
```
Parameters
----------
timeout : Union[float, None]
Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
state : Union["attached", "detached", "hidden", "visible", None]
Defaults to `'visible'`. Can be either:
- `'attached'` - wait for element to be present in DOM.
- `'detached'` - wait for element to not be present in DOM.
- `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`. Note that element
without any content or with `display:none` has an empty bounding box and is not considered visible.
- `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or
`visibility:hidden`. This is opposite to the `'visible'` option.
1.9.8