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:
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:
Emitted when the page closes.
page.on("console")#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:
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:
page.on("dialog")#Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Playwright can respond to the dialog via dialog.accept(**kwargs) or dialog.dismiss() methods.
Emitted when the JavaScript DOMContentLoaded event is dispatched.
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed Download instance.
noteBrowser 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.
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.
Emitted when a frame is attached.
page.on("framedetached")#Emitted when a frame is detached.
page.on("framenavigated")#Emitted when a frame is navigated to a new url.
page.on("load")#Emitted when the JavaScript load event is dispatched.
Emitted when an uncaught exception happens within the page.
page.on("popup")#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.
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")#Emitted when a request fails, for example by timing out.
page.on("requestfinished")#Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.
Emitted when response status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.
Emitted when <WebSocket> request is sent.
page.on("worker")#Emitted when a dedicated WebWorker is spawned by the page.
page.add_init_script(**kwargs)#path <Union[str, pathlib.Path]> Path to the JavaScript file. If path is a relative path, then it is resolved relative to the current working directory. Optional.script <str> Script to be evaluated in all pages in the browser context. Optional.Adds a script which would be evaluated in one of the following scenarios:
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:
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. If path 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.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. If path is a relative path, then it is resolved relative to the current working directory.url <str> URL of the <link> tag.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 to false.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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.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.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 to left.click_count <int> defaults to 1. See UIEvent.detail.delay <float> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.force <bool> Whether to bypass the actionability checks. Defaults to false.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 to false.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, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.position.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 to false. 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.
if run_before_unload is passed as true, a beforeunload dialog might be summoned and should be handled manually via page.on("dialog") event.
Gets the full HTML contents of the page, including the doctype.
page.context#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 to left.delay <float> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.force <bool> Whether to bypass the actionability checks. Defaults to false.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 to false.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, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.position.no_wait_after option is set. Note that if the first click of the dblclick() 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.
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, pass 0 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().
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:
media <NoneType|"screen"|"print"> Changes the CSS media type of the page. The only allowed values are 'screen', 'print' and null. Passing null disables CSS media emulation. Omitting media or passing undefined does not change the emulated value. Optional.color_scheme <NoneType|"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. Passing null disables color scheme emulation. Omitting colorScheme or passing undefined does not change the emulated value. Optional.selector <str> A selector to query for. See working with selectors for more details.arg <[EvaluationArgument]> Optional argument to pass to page_functionexpression <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.force_expr <bool> Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function. Optional.The method finds an element matching the specified selector within the page and passes it as a first argument to page_function. If no elements match the selector, the method throws an error. Returns the value of page_function.
If page_function returns a Promise, then page.eval_on_selector(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
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.arg <[EvaluationArgument]> Optional argument to pass to page_functionexpression <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.force_expr <bool> Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function. Optional.The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to page_function. Returns the result of page_function invocation.
If page_function returns a Promise, then page.eval_on_selector_all(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
page.evaluate(expression, **kwargs)#arg <[EvaluationArgument]> Optional argument to pass to page_functionexpression <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.force_expr <bool> Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function. Optional.Returns the value of the page_function 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. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals.
Passing argument to page_function:
A string can also be passed in instead of a function:
ElementHandle instances can be passed as an argument to the page.evaluate(expression, **kwargs):
Shortcut for main frame's frame.evaluate(expression, **kwargs).
page.evaluate_handle(expression, **kwargs)#arg <[EvaluationArgument]> Optional argument to pass to page_functionexpression <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.force_expr <bool> Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function. Optional.Returns the value of the page_function invocation as in-page object (JSHandle).
The only difference between page.evaluate(expression, **kwargs) and page.evaluate_handle(expression, **kwargs) is that page.evaluate_handle(expression, **kwargs) returns in-page object (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.
A string can also be passed in instead of a function:
JSHandle instances can be passed as an argument to the page.evaluate_handle(expression, **kwargs):
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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).Performs action and waits for console event to fire. If predicate is provided, it passes ConsoleMessage value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the page is closed before the worker event is fired.
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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).Performs action and waits for download event to fire. If predicate is provided, it passes Download value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the page is closed before the download event is fired.
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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).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.
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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).Performs action and waits for filechooser event to fire. If predicate is provided, it passes FileChooser value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the page is closed before the worker event is fired.
timeout <float> Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.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:
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 [Popup] object and resolves to truthy value when the waiting should resolve.timeout <float> Maximum time to wait for 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(timeout).Performs action and waits for popup event to fire. If predicate is provided, it passes [Popup] value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the page is closed before the popup event is fired.
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, pass 0 to disable the timeout. The default value can be changed by using the page.set_default_timeout(timeout) method.Waits for the matching request and returns it.
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, pass 0 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 the matched response.
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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).Performs action and waits for worker event to fire. If predicate is provided, it passes Worker value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the page is closed before the worker event is fired.
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.
An example of exposing page URL to all frames in a page:
An example of passing an element handle:
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.
An example of adding an sha1 function to the page:
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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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 matching selector 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, pass 0 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 the iframe's name attribute. Optional.url <str|Pattern|Callable[URL]:bool> A glob pattern, regex pattern or predicate receiving frame's url as a URL object. Optional.Returns frame matching the specified criteria. Either name or url must be specified.
An 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, pass 0 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 element attribute value.
page.go_back(**kwargs)#timeout <float> Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.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, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.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, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.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:
timeout is exceeded during navigation.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.
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.
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 to false.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, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.position.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, pass 0 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 element.innerHTML.
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, pass 0 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 element.innerText.
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, pass 0 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 whether the element is checked. Throws if the element is not a checkbox or radio input.
page.is_closed()#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, pass 0 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 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, pass 0 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 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, pass 0 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 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, pass 0 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 whether the element is hidden, the opposite of visible.
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, pass 0 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 whether the element is visible.
page.main_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.
display_header_footer <bool> Display header and footer. Defaults to false.footer_template <str> HTML template for the print footer. Should use the same format as the header_template.format <str> Paper format. If set, takes priority over width or height 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 documentheight <str|float> Paper height, accepts values labeled with units.landscape <bool> Paper orientation. Defaults to false.margin <Dict> Paper margins, defaults to none.
top <str|float> Top margin, accepts values labeled with units. Defaults to 0.right <str|float> Right margin, accepts values labeled with units. Defaults to 0.bottom <str|float> Bottom margin, accepts values labeled with units. Defaults to 0.left <str|float> Left margin, accepts values labeled with units. Defaults to 0.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. If path 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 in width and height or format options. Defaults to false, which will scale the content to fit the paper size.print_background <bool> Print background graphics. Defaults to false.scale <float> Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.width <str|float> Paper width, accepts values labeled with units.Returns the PDF buffer.
noteGenerating 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():
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.
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 - millimeterThe 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.83inheader_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.
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 as ArrowLeft or a.delay <float> Time to wait between keydown and keyup 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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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.
selector <str> A selector to query for. See working with selectors for more details.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.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, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.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.
noteThe 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:
or the same snippet using a regex pattern instead:
Page routes take precedence over browser context routes (set up with browser_context.route(url, handler)) when request matches both handlers.
noteEnabling 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 to false.omit_background <bool> Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.path <Union[str, pathlib.Path]> 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 <int> The quality of the image, between 0-100. Not applicable to png images.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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 to png.Returns the buffer with the captured screenshot.
noteScreenshots 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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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 the multiple 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 the multiple attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.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.
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, pass 0 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 to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.timeout <float> Maximum navigation time in millisecondsThis setting will change the default maximum navigation time for the following methods and related shortcuts:
timeout <float> Maximum time in millisecondsThis setting will change the default maximum time for all the methods accepting timeout option.
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.
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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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.
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.
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 to false.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 to false.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, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.position.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.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, pass 0 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 element.textContent.
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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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).
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 to false.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 to false.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If the element is detached during the checks, the whole action is retried.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.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.
Shortcut for main frame's frame.url.
page.video#Video 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 to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).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.
arg <[EvaluationArgument]> Optional argument to pass to page_functionpolling <float|"raf"> If polling is 'raf', then page_function is constantly executed in requestAnimationFrame callback. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to raf.timeout <float> maximum time to wait for 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(timeout).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.force_expr <bool> Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function. Optional.Returns when the page_function 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:
To pass an argument to the predicate of page.wait_for_function(expression, **kwargs) function:
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 to load. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:
'load' - wait for the load event to be fired.'domcontentloaded' - wait for the DOMContentLoaded event to be fired.'networkidle' - wait until there are no network connections for at least 500 ms.timeout <float> Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 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.
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 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.timeout <float> Maximum time in milliseconds, defaults to 30 seconds, pass 0 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 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:
page.wait_for_timeout(timeout)#timeout <float> A timeout to wait forWaits 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.
Shortcut for main frame's frame.wait_for_timeout(timeout).
page.workers#This method returns all of the dedicated WebWorkers associated with the page.
noteThis does not contain ServiceWorkers
page.accessibility#RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4