Page
- extends: EventEmitter
Page provides methods to interact with a single tab in a Browser, or an extension background page in Chromium. One Browser instance might have multiple Page instances.
This example creates a page, navigates it to a URL, and then saves a screenshot:
- Sync
- Async
The Page class emits various events (described below) which can be handled using any of Node's native EventEmitter
methods, such as on
, once
or removeListener
.
This example logs a message for a single page load
event:
To unsubscribe from events use the removeListener
method:
- page.on("close")
- page.on("console")
- page.on("crash")
- page.on("dialog")
- page.on("domcontentloaded")
- page.on("download")
- page.on("filechooser")
- page.on("frameattached")
- page.on("framedetached")
- page.on("framenavigated")
- page.on("load")
- page.on("pageerror")
- page.on("popup")
- page.on("request")
- page.on("requestfailed")
- page.on("requestfinished")
- page.on("response")
- page.on("websocket")
- page.on("worker")
- page.add_init_script(**kwargs)
- page.add_script_tag(**kwargs)
- page.add_style_tag(**kwargs)
- page.bring_to_front()
- page.check(selector, **kwargs)
- page.click(selector, **kwargs)
- page.close(**kwargs)
- page.content()
- page.context
- page.dblclick(selector, **kwargs)
- page.dispatch_event(selector, type, **kwargs)
- page.emulate_media(**kwargs)
- page.eval_on_selector(selector, expression, **kwargs)
- page.eval_on_selector_all(selector, expression, **kwargs)
- page.evaluate(expression, **kwargs)
- page.evaluate_handle(expression, **kwargs)
- page.expect_console_message(**kwargs)
- page.expect_download(**kwargs)
- page.expect_event(event, **kwargs)
- page.expect_file_chooser(**kwargs)
- page.expect_navigation(**kwargs)
- page.expect_popup(**kwargs)
- page.expect_request(url_or_predicate, **kwargs)
- page.expect_response(url_or_predicate, **kwargs)
- page.expect_worker(**kwargs)
- page.expose_binding(name, callback, **kwargs)
- page.expose_function(name, callback)
- page.fill(selector, value, **kwargs)
- page.focus(selector, **kwargs)
- page.frame(**kwargs)
- page.frames
- page.get_attribute(selector, name, **kwargs)
- page.go_back(**kwargs)
- page.go_forward(**kwargs)
- page.goto(url, **kwargs)
- page.hover(selector, **kwargs)
- page.inner_html(selector, **kwargs)
- page.inner_text(selector, **kwargs)
- page.is_checked(selector, **kwargs)
- page.is_closed()
- page.is_disabled(selector, **kwargs)
- page.is_editable(selector, **kwargs)
- page.is_enabled(selector, **kwargs)
- page.is_hidden(selector, **kwargs)
- page.is_visible(selector, **kwargs)
- page.main_frame
- page.opener()
- page.pause()
- page.pdf(**kwargs)
- page.press(selector, key, **kwargs)
- page.query_selector(selector)
- page.query_selector_all(selector)
- page.reload(**kwargs)
- page.route(url, handler)
- page.screenshot(**kwargs)
- page.select_option(selector, **kwargs)
- page.set_content(html, **kwargs)
- page.set_default_navigation_timeout(timeout)
- page.set_default_timeout(timeout)
- page.set_extra_http_headers(headers)
- page.set_input_files(selector, files, **kwargs)
- page.set_viewport_size(viewport_size)
- page.tap(selector, **kwargs)
- page.text_content(selector, **kwargs)
- page.title()
- page.type(selector, text, **kwargs)
- page.uncheck(selector, **kwargs)
- page.unroute(url, **kwargs)
- page.url
- page.video
- page.viewport_size
- page.wait_for_event(event, **kwargs)
- page.wait_for_function(expression, **kwargs)
- page.wait_for_load_state(**kwargs)
- page.wait_for_selector(selector, **kwargs)
- page.wait_for_timeout(timeout)
- page.workers
- page.accessibility
- page.keyboard
- page.mouse
- page.touchscreen
#
page.on("close")- type: <Page>
Emitted when the page closes.
#
page.on("console")- type: <ConsoleMessage>
Emitted when JavaScript within the page calls one of console API methods, e.g. console.log
or console.dir
. Also emitted if the page throws an error or a warning.
The arguments passed into console.log
appear as arguments on the event handler.
An example of handling console
event:
- Sync
- Async
#
page.on("crash")- type: <Page>
Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.
The most common way to deal with crashes is to catch an exception:
- Sync
- Async
#
page.on("dialog")- type: <Dialog>
Emitted when a JavaScript dialog appears, such as alert
, prompt
, confirm
or beforeunload
. Listener must either dialog.accept(**kwargs) or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.
note
When no page.on("dialog") listeners are present, all dialogs are automatically dismissed.
#
page.on("domcontentloaded")- type: <Page>
Emitted when the JavaScript DOMContentLoaded
event is dispatched.
#
page.on("download")- type: <Download>
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed Download instance.
note
Browser context must be created with the accept_downloads
set to true
when user needs access to the downloaded content. If accept_downloads
is not set, download events are emitted, but the actual download is not performed and user has no access to the downloaded files.
#
page.on("filechooser")- type: <FileChooser>
Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>
. Playwright can respond to it via setting the input files using file_chooser.set_files(files, **kwargs) that can be uploaded after that.
#
page.on("frameattached")- type: <Frame>
Emitted when a frame is attached.
#
page.on("framedetached")- type: <Frame>
Emitted when a frame is detached.
#
page.on("framenavigated")- type: <Frame>
Emitted when a frame is navigated to a new url.
#
page.on("load")- type: <Page>
Emitted when the JavaScript load
event is dispatched.
#
page.on("pageerror")- type: <[Error]>
Emitted when an uncaught exception happens within the page.
#
page.on("popup")- type: <Page>
Emitted when the page opens a new tab or window. This event is emitted in addition to the browser_context.on("page"), but only for popups relevant to this page.
The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com')
, this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.
- Sync
- Async
note
Use page.wait_for_load_state(**kwargs) to wait until the page gets to a particular state (you should not need it in most cases).
#
page.on("request")- type: <Request>
Emitted when a page issues a request. The request object is read-only. In order to intercept and mutate requests, see page.route(url, handler) or browser_context.route(url, handler).
#
page.on("requestfailed")- type: <Request>
Emitted when a request fails, for example by timing out.
note
HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on("requestfinished") event and not with page.on("requestfailed").
#
page.on("requestfinished")- type: <Request>
Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request
, response
and requestfinished
.
#
page.on("response")- type: <Response>
Emitted when response status and headers are received for a request. For a successful response, the sequence of events is request
, response
and requestfinished
.
#
page.on("websocket")- type: <WebSocket>
Emitted when <WebSocket> request is sent.
#
page.on("worker")- type: <Worker>
Emitted when a dedicated WebWorker is spawned by the page.
#
page.add_init_script(**kwargs)script
<str> Script to be evaluated in all pages in the browser context. Optional.path
<Union[str, pathlib.Path]> Path to the JavaScript file. Ifpath
is a relative path, then it is resolved relative to the current working directory. Optional.
Adds a script which would be evaluated in one of the following scenarios:
- Whenever the page is navigated.
- Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the newly attached frame.
The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random
.
An example of overriding Math.random
before the page loads:
- Sync
- Async
note
The order of evaluation of multiple scripts installed via browser_context.add_init_script(**kwargs) and page.add_init_script(**kwargs) is not defined.
#
page.add_script_tag(**kwargs)content
<str> Raw JavaScript content to be injected into frame.path
<Union[str, pathlib.Path]> Path to the JavaScript file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to the current working directory.type
<str> Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.url
<str> URL of a script to be added.- returns: <ElementHandle>
Adds a <script>
tag into the page with the desired url or content. Returns the added tag when the script's onload fires or when the script content was injected into frame.
Shortcut for main frame's frame.add_script_tag(**kwargs).
#
page.add_style_tag(**kwargs)content
<str> Raw CSS content to be injected into frame.path
<Union[str, pathlib.Path]> Path to the CSS file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to the current working directory.url
<str> URL of the<link>
tag.- returns: <ElementHandle>
Adds a <link rel="stylesheet">
tag into the page with the desired url or a <style type="text/css">
tag with the content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
Shortcut for main frame's frame.add_style_tag(**kwargs).
#
page.bring_to_front()Brings page to front (activates tab).
#
page.check(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method checks an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.
- Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element.
- Wait for initiated navigations to either succeed or fail, unless
no_wait_after
option is set. - Ensure that the element is now checked. If not, this method rejects.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.check(selector, **kwargs).
#
page.click(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.button
<"left"|"right"|"middle"> Defaults toleft
.click_count
<int> defaults to 1. See UIEvent.detail.delay
<float> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> 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.no_wait_after
<bool> 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 tofalse
.position
<Dict> 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
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method clicks an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element, or the specified
position
. - Wait for initiated navigations to either succeed or fail, unless
no_wait_after
option is set.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.click(selector, **kwargs).
#
page.close(**kwargs)run_before_unload
<bool> Defaults tofalse
. Whether to run the before unload page handlers.
If run_before_unload
is false
, does not run any unload handlers and waits for the page to be closed. If run_before_unload
is true
the method will run unload handlers, but will not wait for the page to close.
By default, page.close()
does not run beforeunload
handlers.
note
if run_before_unload
is passed as true, a beforeunload
dialog might be summoned and should be handled manually via page.on("dialog") event.
#
page.content()- returns: <str>
Gets the full HTML contents of the page, including the doctype.
#
page.context- returns: <BrowserContext>
Get the browser context that the page belongs to.
#
page.dblclick(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.button
<"left"|"right"|"middle"> Defaults toleft
.delay
<float> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> 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.no_wait_after
<bool> 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 tofalse
.position
<Dict> 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
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method double clicks an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to double click in the center of the element, or the specified
position
. - Wait for initiated navigations to either succeed or fail, unless
no_wait_after
option is set. Note that if the first click of thedblclick()
triggers a navigation event, this method will reject.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
note
page.dblclick()
dispatches two click
events and a single dblclick
event.
Shortcut for main frame's frame.dblclick(selector, **kwargs).
#
page.dispatch_event(selector, type, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.type
<str> DOM event type:"click"
,"dragstart"
, etc.event_init
<[EvaluationArgument]> Optional event-specific initialization properties.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
The snippet below dispatches the click
event on the element. Regardless of the visibility state of the elment, click
is dispatched. This is equivalend to calling element.click().
- Sync
- Async
Under the hood, it creates an instance of an event based on the given type
, initializes it with event_init
properties and dispatches it on the element. Events are composed
, cancelable
and bubble by default.
Since event_init
is event-specific, please refer to the events documentation for the lists of initial properties:
You can also specify JSHandle
as the property value if you want live objects to be passed into the event:
- Sync
- Async
#
page.emulate_media(**kwargs)color_scheme
<NoneType|"light"|"dark"|"no-preference"> Emulates'prefers-colors-scheme'
media feature, supported values are'light'
,'dark'
,'no-preference'
. Passingnull
disables color scheme emulation.media
<NoneType|"screen"|"print"> Changes the CSS media type of the page. The only allowed values are'screen'
,'print'
andnull
. Passingnull
disables CSS media emulation.
- Sync
- Async
- Sync
- Async
#
page.eval_on_selector(selector, expression, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
The method finds an element matching the specified selector within the page and passes it as a first argument to expression
. If no elements match the selector, the method throws an error. Returns the value of expression
.
If expression
returns a Promise, then page.eval_on_selector(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
- Sync
- Async
Shortcut for main frame's frame.eval_on_selector(selector, expression, **kwargs).
#
page.eval_on_selector_all(selector, expression, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to expression
. Returns the result of expression
invocation.
If expression
returns a Promise, then page.eval_on_selector_all(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
- Sync
- Async
#
page.evaluate(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
Returns the value of the expression
invocation.
If the function passed to the page.evaluate(expression, **kwargs) returns a Promise, then page.evaluate(expression, **kwargs) would wait for the promise to resolve and return its value.
If the function passed to the page.evaluate(expression, **kwargs) returns a non-Serializable value, then page.evaluate(expression, **kwargs) resolves to undefined
. Playwright also supports transferring some additional values that are not serializable by JSON
: -0
, NaN
, Infinity
, -Infinity
.
Passing argument to expression
:
- Sync
- Async
A string can also be passed in instead of a function:
- Sync
- Async
ElementHandle instances can be passed as an argument to the page.evaluate(expression, **kwargs):
- Sync
- Async
Shortcut for main frame's frame.evaluate(expression, **kwargs).
#
page.evaluate_handle(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <JSHandle>
Returns the value of the expression
invocation as a JSHandle.
The only difference between page.evaluate(expression, **kwargs) and page.evaluate_handle(expression, **kwargs) is that page.evaluate_handle(expression, **kwargs) returns JSHandle.
If the function passed to the page.evaluate_handle(expression, **kwargs) returns a Promise, then page.evaluate_handle(expression, **kwargs) would wait for the promise to resolve and return its value.
- Sync
- Async
A string can also be passed in instead of a function:
- Sync
- Async
JSHandle instances can be passed as an argument to the page.evaluate_handle(expression, **kwargs):
- Sync
- Async
#
page.expect_console_message(**kwargs)predicate
<Callable[ConsoleMessage]:bool> Receives the ConsoleMessage object and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager[ConsoleMessage]>
Performs action and waits for a [ConoleMessage] to be logged by in the page. If predicate is provided, it passes ConsoleMessage value into the predicate
function and waits for predicate(message)
to return a truthy value. Will throw an error if the page is closed before the console event is fired.
#
page.expect_download(**kwargs)predicate
<Callable[Download]:bool> Receives the Download object and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager[Download]>
Performs action and waits for a new Download. If predicate is provided, it passes Download value into the predicate
function and waits for predicate(download)
to return a truthy value. Will throw an error if the page is closed before the download event is fired.
#
page.expect_event(event, **kwargs)event
<str> Event name, same one typically passed into*.on(event)
.predicate
<Callable> Receives the event data and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager>
Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the page is closed before the event is fired. Returns the event data value.
- Sync
- Async
#
page.expect_file_chooser(**kwargs)predicate
<Callable[FileChooser]:bool> Receives the FileChooser object and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager[FileChooser]>
Performs action and waits for a new FileChooser to be created. If predicate is provided, it passes FileChooser value into the predicate
function and waits for predicate(fileChooser)
to return a truthy value. Will throw an error if the page is closed before the file chooser is opened.
#
page.expect_navigation(**kwargs)timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.url
<str|Pattern|Callable[URL]:bool> A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <EventContextManager[Response]>
Waits for the main frame navigation and returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null
.
This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly cause the page to navigate. e.g. The click target has an onclick
handler that triggers navigation from a setTimeout
. Consider this example:
- Sync
- Async
note
Usage of the History API to change the URL is considered a navigation.
Shortcut for main frame's frame.expect_navigation(**kwargs).
#
page.expect_popup(**kwargs)predicate
<Callable[Page]:bool> Receives the Page object and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager[Page]>
Performs action and waits for a popup Page. If predicate is provided, it passes [Popup] value into the predicate
function and waits for predicate(page)
to return a truthy value. Will throw an error if the page is closed before the popup event is fired.
#
page.expect_request(url_or_predicate, **kwargs)url_or_predicate
<str|Pattern|Callable[Request]:bool> Request URL string, regex or predicate receiving Request object.timeout
<float> Maximum wait time in milliseconds, defaults to 30 seconds, pass0
to disable the timeout. The default value can be changed by using the page.set_default_timeout(timeout) method.- returns: <EventContextManager[Request]>
Waits for the matching request and returns it.
- Sync
- Async
#
page.expect_response(url_or_predicate, **kwargs)url_or_predicate
<str|Pattern|Callable[Response]:bool> Request URL string, regex or predicate receiving Response object.timeout
<float> Maximum wait time in milliseconds, defaults to 30 seconds, pass0
to disable the timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <EventContextManager[Response]>
Returns the matched response.
- Sync
- Async
#
page.expect_worker(**kwargs)predicate
<Callable[Worker]:bool> Receives the Worker object and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <EventContextManager[Worker]>
Performs action and waits for a new Worker. If predicate is provided, it passes Worker value into the predicate
function and waits for predicate(worker)
to return a truthy value. Will throw an error if the page is closed before the worker event is fired.
#
page.expose_binding(name, callback, **kwargs)name
<str> Name of the function on the window object.callback
<Callable> Callback function that will be called in the Playwright's context.handle
<bool> Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
The method adds a function called name
on the window
object of every frame in this page. When called, the function executes callback
and returns a Promise which resolves to the return value of callback
. If the callback
returns a Promise, it will be awaited.
The first argument of the callback
function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }
.
See browser_context.expose_binding(name, callback, **kwargs) for the context-wide version.
note
Functions installed via page.expose_binding(name, callback, **kwargs) survive navigations.
An example of exposing page URL to all frames in a page:
- Sync
- Async
An example of passing an element handle:
- Sync
- Async
#
page.expose_function(name, callback)name
<str> Name of the function on the window objectcallback
<Callable> Callback function which will be called in Playwright's context.
The method adds a function called name
on the window
object of every frame in the page. When called, the function executes callback
and returns a Promise which resolves to the return value of callback
.
If the callback
returns a Promise, it will be awaited.
See browser_context.expose_function(name, callback) for context-wide exposed function.
note
Functions installed via page.expose_function(name, callback) survive navigations.
An example of adding an sha1
function to the page:
- Sync
- Async
#
page.fill(selector, value, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.value
<str> Value to fill for the<input>
,<textarea>
or[contenteditable]
element.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method waits for an element matching selector
, waits for actionability checks, focuses the element, fills it and triggers an input
event after filling. If the element is inside the <label>
element that has associated control, that control will be filled instead. If the element to be filled is not an <input>
, <textarea>
or [contenteditable]
element, this method throws an error. Note that you can pass an empty string to clear the input field.
To send fine-grained keyboard events, use page.type(selector, text, **kwargs).
Shortcut for main frame's frame.fill(selector, value, **kwargs)
#
page.focus(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method fetches an element with selector
and focuses it. If there's no element matching selector
, the method waits until a matching element appears in the DOM.
Shortcut for main frame's frame.focus(selector, **kwargs).
#
page.frame(**kwargs)name
<str> Frame name specified in theiframe
'sname
attribute. Optional.url
<str|Pattern|Callable[URL]:bool> A glob pattern, regex pattern or predicate receiving frame'surl
as a URL object. Optional.- returns: <NoneType|Frame>
Returns frame matching the specified criteria. Either name
or url
must be specified.
#
page.framesAn array of all frames attached to the page.
#
page.get_attribute(selector, name, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.name
<str> Attribute name to get the value for.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|str>
Returns element attribute value.
#
page.go_back(**kwargs)timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <NoneType|Response>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go back, returns null
.
Navigate to the previous page in history.
#
page.go_forward(**kwargs)timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <NoneType|Response>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go forward, returns null
.
Navigate to the next page in history.
#
page.goto(url, **kwargs)url
<str> URL to navigate page to. The url should include scheme, e.g.https://
.referer
<str> Referer header value. If provided it will take preference over the referer header value set by page.set_extra_http_headers(headers).timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <NoneType|Response>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
page.goto
will throw an error if:
- there's an SSL error (e.g. in case of self-signed certificates).
- target URL is invalid.
- the
timeout
is exceeded during navigation. - the remote server does not respond or is unreachable.
- the main resource failed to load.
page.goto
will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling response.status.
note
page.goto
either throws an error or returns a main resource response. The only exceptions are navigation to about:blank
or navigation to the same URL with a different hash, which would succeed and return null
.
note
Headless mode doesn't support navigation to a PDF document. See the upstream issue.
Shortcut for main frame's frame.goto(url, **kwargs)
#
page.hover(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> 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.position
<Dict> 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
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method hovers over an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to hover over the center of the element, or the specified
position
. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfter
option is set.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.hover(selector, **kwargs).
#
page.inner_html(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <str>
Returns element.innerHTML
.
#
page.inner_text(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <str>
Returns element.innerText
.
#
page.is_checked(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
#
page.is_closed()- returns: <bool>
Indicates that the page has been closed.
#
page.is_disabled(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is disabled, the opposite of enabled.
#
page.is_editable(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is editable.
#
page.is_enabled(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is enabled.
#
page.is_hidden(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is hidden, the opposite of visible. selector
that does not match any elements is considered hidden.
#
page.is_visible(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is visible. selector
that does not match any elements is considered not visible.
#
page.main_frame- returns: <Frame>
The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
#
page.opener()Returns the opener for popup pages and null
for others. If the opener has been closed already the returns null
.
#
page.pause()Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button in the page overlay or to call playwright.resume()
in the DevTools console.
User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from the place it was paused.
note
This method requires Playwright to be started in a headed mode, with a falsy headless
value in the browser_type.launch(**kwargs).
#
page.pdf(**kwargs)display_header_footer
<bool> Display header and footer. Defaults tofalse
.footer_template
<str> HTML template for the print footer. Should use the same format as theheader_template
.format
<str> Paper format. If set, takes priority overwidth
orheight
options. Defaults to 'Letter'.header_template
<str> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:'date'
formatted print date'title'
document title'url'
document location'pageNumber'
current page number'totalPages'
total pages in the document
height
<str|float> Paper height, accepts values labeled with units.landscape
<bool> Paper orientation. Defaults tofalse
.margin
<Dict> Paper margins, defaults to none.top
<str|float> Top margin, accepts values labeled with units. Defaults to0
.right
<str|float> Right margin, accepts values labeled with units. Defaults to0
.bottom
<str|float> Bottom margin, accepts values labeled with units. Defaults to0
.left
<str|float> Left margin, accepts values labeled with units. Defaults to0
.
page_ranges
<str> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.path
<Union[str, pathlib.Path]> The file path to save the PDF to. Ifpath
is a relative path, then it is resolved relative to the current working directory. If no path is provided, the PDF won't be saved to the disk.prefer_css_page_size
<bool> Give any CSS@page
size declared in the page priority over what is declared inwidth
andheight
orformat
options. Defaults tofalse
, which will scale the content to fit the paper size.print_background
<bool> Print background graphics. Defaults tofalse
.scale
<float> Scale of the webpage rendering. Defaults to1
. Scale amount must be between 0.1 and 2.width
<str|float> Paper width, accepts values labeled with units.- returns: <[Buffer]>
Returns the PDF buffer.
note
Generating a pdf is currently only supported in Chromium headless.
page.pdf()
generates a pdf of the page with print
css media. To generate a pdf with screen
media, call page.emulate_media(**kwargs) before calling page.pdf()
:
note
By default, page.pdf()
generates a pdf with modified colors for printing. Use the -webkit-print-color-adjust
property to force rendering of exact colors.
- Sync
- Async
The width
, height
, and margin
options accept values labeled with units. Unlabeled values are treated as pixels.
A few examples:
page.pdf({width: 100})
- prints with width set to 100 pixelspage.pdf({width: '100px'})
- prints with width set to 100 pixelspage.pdf({width: '10cm'})
- prints with width set to 10 centimeters.
All possible units are:
px
- pixelin
- inchcm
- centimetermm
- millimeter
The format
options are:
Letter
: 8.5in x 11inLegal
: 8.5in x 14inTabloid
: 11in x 17inLedger
: 17in x 11inA0
: 33.1in x 46.8inA1
: 23.4in x 33.1inA2
: 16.54in x 23.4inA3
: 11.7in x 16.54inA4
: 8.27in x 11.7inA5
: 5.83in x 8.27inA6
: 4.13in x 5.83in
note
header_template
and footer_template
markup have the following limitations: > 1. Script tags inside templates are not evaluated. > 2. Page styles are not visible inside templates.
#
page.press(selector, key, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.key
<str> Name of the key to press or a character to generate, such asArrowLeft
ora
.delay
<float> Time to wait betweenkeydown
andkeyup
in milliseconds. Defaults to 0.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
Focuses the element, and then uses keyboard.down(key) and keyboard.up(key).
key
can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key
values can be found here. Examples of the keys are:
F1
- F12
, Digit0
- Digit9
, KeyA
- KeyZ
, Backquote
, Minus
, Equal
, Backslash
, Backspace
, Tab
, Delete
, Escape
, ArrowDown
, End
, Enter
, Home
, Insert
, PageDown
, PageUp
, ArrowRight
, ArrowUp
, etc.
Following modification shortcuts are also supported: Shift
, Control
, Alt
, Meta
, ShiftLeft
.
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"
or key: "Control+Shift+T"
are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- Sync
- Async
#
page.query_selector(selector)selector
<str> A selector to query for. See working with selectors for more details.- returns: <NoneType|ElementHandle>
The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null
.
Shortcut for main frame's frame.query_selector(selector).
#
page.query_selector_all(selector)selector
<str> A selector to query for. See working with selectors for more details.- returns: <List[ElementHandle]>
The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to []
.
Shortcut for main frame's frame.query_selector_all(selector).
#
page.reload(**kwargs)timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <NoneType|Response>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
#
page.route(url, handler)url
<str|Pattern|Callable[URL]:bool> A glob pattern, regex pattern or predicate receiving URL to match while routing.handler
<Callable[Route, Request]> handler function to route the request.
Routing provides the capability to modify network requests that are made by a page.
Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
note
The handler will only be called for the first url if the response is a redirect.
An example of a naïve handler that aborts all image requests:
- Sync
- Async
or the same snippet using a regex pattern instead:
- Sync
- Async
Page routes take precedence over browser context routes (set up with browser_context.route(url, handler)) when request matches both handlers.
note
Enabling routing disables http cache.
#
page.screenshot(**kwargs)clip
<Dict> An object which specifies clipping of the resulting image. Should have the following fields:full_page
<bool> When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults tofalse
.omit_background
<bool> Hides default white background and allows capturing screenshots with transparency. Not applicable tojpeg
images. Defaults tofalse
.path
<Union[str, pathlib.Path]> The file path to save the image to. The screenshot type will be inferred from file extension. Ifpath
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
<int> The quality of the image, between 0-100. Not applicable topng
images.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.type
<"png"|"jpeg"> Specify screenshot type, defaults topng
.- returns: <[Buffer]>
Returns the buffer with the captured screenshot.
note
Screenshots take at least 1/6 second on Chromium OS X and Chromium Windows. See https://crbug.com/741689 for discussion.
#
page.select_option(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.element
<ElementHandle|List[ElementHandle]> Option elements to select. Optional.index
<int|List[int]> Options to select by index. Optional.value
<str|List[str]> Options to select by value. If the<select>
has themultiple
attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.label
<str|List[str]> Options to select by label. If the<select>
has themultiple
attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.- returns: <List[str]>
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. If there's no <select>
element matching selector
, the method throws an error.
Will wait until all specified options are present in the <select>
element.
- Sync
- Async
Shortcut for main frame's frame.select_option(selector, **kwargs)
#
page.set_content(html, **kwargs)html
<str> HTML markup to assign to the page.timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
#
page.set_default_navigation_timeout(timeout)timeout
<float> Maximum navigation time in milliseconds
This setting will change the default maximum navigation time for the following methods and related shortcuts:
- page.go_back(**kwargs)
- page.go_forward(**kwargs)
- page.goto(url, **kwargs)
- page.reload(**kwargs)
- page.set_content(html, **kwargs)
- page.expect_navigation(**kwargs)
note
#
page.set_default_timeout(timeout)timeout
<float> Maximum time in milliseconds
This setting will change the default maximum time for all the methods accepting timeout
option.
note
page.set_default_navigation_timeout(timeout) takes priority over page.set_default_timeout(timeout).
#
page.set_extra_http_headers(headers)headers
<Dict[str, str]> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
The extra HTTP headers will be sent with every request the page initiates.
note
page.set_extra_http_headers(headers) does not guarantee the order of headers in the outgoing requests.
#
page.set_input_files(selector, files, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.files
<Union[str, pathlib.Path]|List[Union[str, pathlib.Path]]|Dict|List[Dict]>no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method expects selector
to point to an input element.
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 the current working directory. For empty array, clears the selected files.
#
page.set_viewport_size(viewport_size)In the case of multiple pages in a single browser, each page can have its own viewport size. However, browser.new_context(**kwargs) allows to set viewport size (and more) for all pages in the context at once.
page.setViewportSize
will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page.
- Sync
- Async
#
page.tap(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> 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.no_wait_after
<bool> 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 tofalse
.position
<Dict> 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
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method taps an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.touchscreen to tap the center of the element, or the specified
position
. - Wait for initiated navigations to either succeed or fail, unless
no_wait_after
option is set.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
note
page.tap(selector, **kwargs) requires that the has_touch
option of the browser context be set to true.
Shortcut for main frame's frame.tap(selector, **kwargs).
#
page.text_content(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|str>
Returns element.textContent
.
#
page.title()- returns: <str>
Returns the page's title. Shortcut for main frame's frame.title().
#
page.type(selector, text, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.text
<str> A text to type into a focused element.delay
<float> Time to wait between key presses in milliseconds. Defaults to 0.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
Sends a keydown
, keypress
/input
, and keyup
event for each character in the text. page.type
can be used to send fine-grained keyboard events. To fill values in form fields, use page.fill(selector, value, **kwargs).
To press a special key, like Control
or ArrowDown
, use keyboard.press(key, **kwargs).
- Sync
- Async
Shortcut for main frame's frame.type(selector, text, **kwargs).
#
page.uncheck(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.no_wait_after
<bool> 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 tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
This method unchecks an element matching selector
by performing the following steps:
- Find an element match matching
selector
. If there is none, wait until a matching element is attached to the DOM. - Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.
- Wait for actionability checks on the matched element, unless
force
option is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element.
- Wait for initiated navigations to either succeed or fail, unless
no_wait_after
option is set. - Ensure that the element is now unchecked. If not, this method rejects.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.uncheck(selector, **kwargs).
#
page.unroute(url, **kwargs)url
<str|Pattern|Callable[URL]:bool> A glob pattern, regex pattern or predicate receiving URL to match while routing.handler
<Callable[Route, Request]> Optional handler function to route the request.
Removes a route created with page.route(url, handler). When handler
is not specified, removes all routes for the url
.
#
page.url- returns: <str>
Shortcut for main frame's frame.url.
#
page.videoVideo object associated with this page.
#
page.viewport_size#
page.wait_for_event(event, **kwargs)event
<str> Event name, same one typically passed into*.on(event)
.predicate
<Callable> Receives the event data and resolves to truthy value when the waiting should resolve.timeout
<float> Maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <Any>
note
In most cases, you should use page.expect_event(event, **kwargs).
Waits for given event
to fire. If predicate is provided, it passes event's value into the predicate
function and waits for predicate(event)
to return a truthy value. Will throw an error if the socket is closed before the event
is fired.
#
page.wait_for_function(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.polling
<float|"raf"> Ifpolling
is'raf'
, thenexpression
is constantly executed inrequestAnimationFrame
callback. Ifpolling
is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults toraf
.timeout
<float> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <JSHandle>
Returns when the expression
returns a truthy value. It resolves to a JSHandle of the truthy value.
The page.wait_for_function(expression, **kwargs) can be used to observe viewport size change:
- Sync
- Async
To pass an argument to the predicate of page.wait_for_function(expression, **kwargs) function:
- Sync
- Async
Shortcut for main frame's frame.wait_for_function(expression, **kwargs).
#
page.wait_for_load_state(**kwargs)state
<"load"|"domcontentloaded"|"networkidle"> Optional load state to wait for, defaults toload
. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:'load'
- wait for theload
event to be fired.'domcontentloaded'
- wait for theDOMContentLoaded
event to be fired.'networkidle'
- wait until there are no network connections for at least500
ms.
timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.
Returns when the required load state has been reached.
This resolves when the page reaches a required load state, load
by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.
- Sync
- Async
- Sync
- Async
Shortcut for main frame's frame.wait_for_load_state(**kwargs).
#
page.wait_for_selector(selector, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.state
<"attached"|"detached"|"visible"|"hidden"> 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 novisibility:hidden
. Note that element without any content or withdisplay: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 orvisibility:hidden
. This is opposite to the'visible'
option.
timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|ElementHandle>
Returns when element specified by selector satisfies state
option. Returns null
if waiting for hidden
or detached
.
Wait for the selector
to satisfy state
option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector
already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout
milliseconds, the function will throw.
This method works across navigations:
- Sync
- Async
#
page.wait_for_timeout(timeout)timeout
<float> A timeout to wait for
Waits for the given timeout
in milliseconds.
Note that page.waitForTimeout()
should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.
- Sync
- Async
Shortcut for main frame's frame.wait_for_timeout(timeout).
#
page.workersThis method returns all of the dedicated WebWorkers associated with the page.
note
This does not contain ServiceWorkers
#
page.accessibility- type: <Accessibility>
#
page.keyboard- type: <Keyboard>
#
page.mouse- type: <Mouse>
#
page.touchscreen- type: <Touchscreen>