English · Python
Appearance
English · Python
Appearance
BrowserContexts provide a way to operate multiple independent browser sessions.
If a page opens another page, e.g. with a window.open call, the popup will belong to the parent page's browser context.
Playwright allows creating isolated non-persistent browser contexts with browser.new_context() method. Non-persistent browser contexts don't write any browsing data to disk.
# create a new incognito browser context
context = await browser.new_context()
# create a new page inside context.
page = await context.new_page()
await page.goto("https://example.com")
# dispose context once it is no longer needed.
await context.close()# create a new incognito browser context
context = browser.new_context()
# create a new page inside context.
page = context.new_page()
page.goto("https://example.com")
# dispose context once it is no longer needed.
context.close()Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via browser_context.cookies().
Usage
await browser_context.add_cookies([cookie_object1, cookie_object2])browser_context.add_cookies([cookie_object1, cookie_object2])Arguments
name string
value string
url string (optional)
Either url or both domain and path are required. Optional.
domain string (optional)
For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com". Either url or both domain and path are required. Optional.
path string (optional)
Either url or both domain and path are required. Optional.
expires float (optional)
Unix time in seconds. Optional.
http_only boolean (optional)
Optional.
secure boolean (optional)
Optional.
same_site "Strict" | "Lax" | "None" (optional)
Optional.
partition_key string (optional)
For partitioned third-party cookies (aka CHIPS), the partition key. 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.
Usage
An example of overriding Math.random before the page loads:
# in your playwright script, assuming the preload.js file is in same directory.
await browser_context.add_init_script(path="preload.js")# in your playwright script, assuming the preload.js file is in same directory.
browser_context.add_init_script(path="preload.js")INFO
The order of evaluation of multiple scripts installed via browser_context.add_init_script() and page.add_init_script() is not defined.
Arguments
Script to be evaluated in all pages in the browser context. Optional.
Returns
DisposableGets the browser instance that owns the context. Returns null if the context is created outside of normal browser, e.g. Android or Electron.
Returns
null | BrowserRemoves cookies from context. Accepts optional filter.
Usage
await context.clear_cookies()
await context.clear_cookies(name="session-id")
await context.clear_cookies(domain="my-origin.com")
await context.clear_cookies(path="/api/v1")
await context.clear_cookies(name="session-id", domain="my-origin.com")context.clear_cookies()
context.clear_cookies(name="session-id")
context.clear_cookies(domain="my-origin.com")
context.clear_cookies(path="/api/v1")
context.clear_cookies(name="session-id", domain="my-origin.com")Arguments
Clears all permission overrides for the browser context.
Usage
context = await browser.new_context()
await context.grant_permissions(["clipboard-read"])
# do stuff ..
context.clear_permissions()context = browser.new_context()
context.grant_permissions(["clipboard-read"])
# do stuff ..
context.clear_permissions()Closes the browser context. All the pages that belong to the browser context will be closed.
INFO
The default browser context cannot be closed.
Arguments
If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.
Arguments
Returns
Array<Object>Performs action and waits for a ConsoleMessage to be logged by in the pages in the context. 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 browserContext.on("console") event is fired.
Arguments
predicate function(ConsoleMessage): boolean (optional)
Receives the ConsoleMessage object and resolves to truthy value when the waiting should resolve.
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().
Returns
EventContextManager<ConsoleMessage>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 context closes before the event is fired. Returns the event data value.
Usage
async with context.expect_event("page") as event_info:
await page.get_by_role("button").click()
page = await event_info.valuewith context.expect_event("page") as event_info:
page.get_by_role("button").click()
page = event_info.valueArguments
Event name, same one would pass into browserContext.on(event).
predicate function() (optional)
Receives the event data and resolves to truthy value when the waiting should resolve.
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().
Returns
EventContextManagerPerforms action and waits for a new Page to be created in the context. If predicate is provided, it passes Page value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the context closes before new Page is created.
Arguments
predicate function(Page): boolean (optional)
Receives the Page object and resolves to truthy value when the waiting should resolve.
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().
Returns
EventContextManager<Page>The method adds a function called name on the window object of every frame in every page in the context. 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 page.expose_binding() for page-only version.
Usage
An example of exposing page URL to all frames in all pages in the context:
import asyncio
from playwright.async_api import async_playwright, Playwright
async def run(playwright: Playwright):
webkit = playwright.webkit
browser = await webkit.launch(headless=False)
context = await browser.new_context()
await context.expose_binding("pageURL", lambda source: source["page"].url)
page = await context.new_page()
await page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
await page.get_by_role("button").click()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
context.expose_binding("pageURL", lambda source: source["page"].url)
page = context.new_page()
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.get_by_role("button").click()
with sync_playwright() as playwright:
run(playwright)Arguments
Name of the function on the window object.
Callback function that will be called in the Playwright's context.
Returns
DisposableThe method adds a function called name on the window object of every frame in every page in the context. 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 page.expose_function() for page-only version.
Usage
An example of adding a sha256 function to all pages in the context:
import asyncio
import hashlib
from playwright.async_api import async_playwright, Playwright
def sha256(text: str) -> str:
m = hashlib.sha256()
m.update(bytes(text, "utf8"))
return m.hexdigest()
async def run(playwright: Playwright):
webkit = playwright.webkit
browser = await webkit.launch(headless=False)
context = await browser.new_context()
await context.expose_function("sha256", sha256)
page = await context.new_page()
await page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
await page.get_by_role("button").click()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())import hashlib
from playwright.sync_api import sync_playwright
def sha256(text: str) -> str:
m = hashlib.sha256()
m.update(bytes(text, "utf8"))
return m.hexdigest()
def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
context.expose_function("sha256", sha256)
page = context.new_page()
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.get_by_role("button").click()
with sync_playwright() as playwright:
run(playwright)Arguments
Name of the function on the window object.
Callback function that will be called in the Playwright's context.
Returns
DisposableGrants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.
Arguments
A list of permissions to grant.
DANGER
Supported permissions differ between browsers, and even between different versions of the same browser. Any permission may stop working after an update.
Here are some permissions that may be supported by some browsers:
'accelerometer''ambient-light-sensor''background-sync''camera''clipboard-read''clipboard-write''geolocation''gyroscope''local-fonts''local-network-access''magnetometer''microphone''midi-sysex' (system-exclusive midi)'midi''notifications''payment-handler''storage-access''screen-wake-lock'The [origin] to grant permissions to, e.g. "https://example.com".
Indicates that the browser context is in the process of closing or has already been closed.
Returns
booleanINFO
CDP sessions are only supported on Chromium-based browsers.
Returns the newly created session.
Arguments
Target to create new session for. For backwards-compatibility, this parameter is named page, but it can be a Page or Frame type.
Returns
CDPSessionCreates a new page in the browser context.
Returns
PageReturns all open pages in the context.
Returns
Array<Page>Routing provides the capability to modify network requests that are made by any page in the browser context. Once route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
INFO
browser_context.route() will not intercept requests intercepted by Service Worker. See this issue. We recommend disabling Service Workers when using request interception by setting service_workers to 'block'.
Usage
An example of a naive handler that aborts all image requests:
context = await browser.new_context()
page = await context.new_page()
await context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
await page.goto("https://example.com")
await browser.close()context = browser.new_context()
page = context.new_page()
context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.goto("https://example.com")
browser.close()or the same snippet using a regex pattern instead:
context = await browser.new_context()
page = await context.new_page()
await context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
page = await context.new_page()
await page.goto("https://example.com")
await browser.close()context = browser.new_context()
page = context.new_page()
context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
page = await context.new_page()
page = context.new_page()
page.goto("https://example.com")
browser.close()It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
async def handle_route(route: Route):
if ("my-string" in route.request.post_data):
await route.fulfill(body="mocked-data")
else:
await route.continue_()
await context.route("/api/**", handle_route)def handle_route(route: Route):
if ("my-string" in route.request.post_data):
route.fulfill(body="mocked-data")
else:
route.continue_()
context.route("/api/**", handle_route)Page routes (set up with page.route()) take precedence over browser context routes when request matches both handlers.
To remove a route with its handler you can use browser_context.unroute().
INFO
Enabling routing disables http cache.
Arguments
url string | RegExp | function(URL): boolean
A glob pattern, regex pattern, or predicate that receives a [URL] to match during routing. If base_url is set in the context options and the provided URL is a string that does not start with *, it is resolved using the new URL() constructor.
handler function(Route) | function(Route, Request)
handler function to route the request.
Returns
DisposableIf specified the network requests that are made in the context will be served from the HAR file. Read more about Replaying from HAR.
Playwright will not serve requests intercepted by Service Worker from the HAR file. See this issue. We recommend disabling Service Workers when using request interception by setting service_workers to 'block'.
Arguments
Path to a HAR file with prerecorded network data. If path is a relative path, then it is resolved relative to the current working directory.
not_found "abort" | "fallback" (optional)
Defaults to abort.
If specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when browser_context.close() is called.
update_content "embed" | "attach" (optional) Added in: v1.32
Optional setting to control resource content management. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file.
update_mode "full" | "minimal" (optional) Added in: v1.32
When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to minimal.
url string | RegExp (optional)
A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.
This method allows to modify websocket connections that are made by any page in the browser context.
Note that only WebSockets created after this method was called will be routed. It is recommended to call this method before creating any pages.
Usage
Below is an example of a simple handler that blocks some websocket messages. See WebSocketRoute for more details and examples.
def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
if message == "to-be-blocked":
return
server.send(message)
def handler(ws: WebSocketRoute):
server = ws.connect_to_server()
ws.on_message(lambda message: message_handler(server, message))
await context.route_web_socket("/ws", handler)def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
if message == "to-be-blocked":
return
server.send(message)
def handler(ws: WebSocketRoute):
server = ws.connect_to_server()
ws.on_message(lambda message: message_handler(server, message))
context.route_web_socket("/ws", handler)Arguments
url string | RegExp | function(URL): boolean
Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the base_url context option.
handler function(WebSocketRoute): Promise<any> | any
Handler function to route the WebSocket.
INFO
Service workers are only supported on Chromium-based browsers.
All existing service workers in the context.
Returns
Array<Worker>This setting will change the default maximum navigation time for the following methods and related shortcuts:
INFO
page.set_default_navigation_timeout() and page.set_default_timeout() take priority over browser_context.set_default_navigation_timeout().
Arguments
This setting will change the default maximum time for all the methods accepting timeout option.
INFO
page.set_default_navigation_timeout(), page.set_default_timeout() and browser_context.set_default_navigation_timeout() take priority over browser_context.set_default_timeout().
Arguments
The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with page.set_extra_http_headers(). If page overrides a particular header, page-specific header value will be used instead of the browser context header value.
INFO
browser_context.set_extra_http_headers() does not guarantee the order of headers in the outgoing requests.
Arguments
headers Object<string, string>
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
Sets the context's geolocation. Passing null or undefined emulates position unavailable.
Usage
await browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})INFO
Consider using browser_context.grant_permissions() to grant permissions for the browser context pages to read its geolocation.
Arguments
latitude float
Latitude between -90 and 90.
longitude float
Longitude between -180 and 180.
accuracy float (optional)
Non-negative accuracy value. Defaults to 0.
Arguments
Whether to emulate network being offline for the browser context.
INFO
Offline emulation affects HTTP requests, such as page navigations, fetch() and XMLHttpRequest.
WebSocket behavior depends on the browser and whether the connection is already established. Chromium and Firefox fail new WebSocket connections while offline, but do not close already-open connections. Chromium can defer incoming messages until the context goes back online, rather than lose them; Firefox can continue delivering messages while offline. WebKit can allow both new WebSocket connections and traffic on established connections while offline. Do not rely on offline emulation to test WebSocket message loss or connection closure.
Offline emulation does not affect WebRTC traffic: established RTCPeerConnections keep sending and receiving media over UDP. To test WebRTC connection loss, interrupt the connection outside the browser, for example by stopping the TURN server or using an OS-level firewall.
Clears the existing cookies, local storage, IndexedDB entries, origin private file system entries and virtual WebAuthn credentials, and sets the new storage state. When the storage state contains credentials, the virtual WebAuthn authenticator is installed (equivalent to credentials.install()), preventing all real authenticators from working in this context.
Usage
# Load storage state from a file and apply it to the context.
await context.set_storage_state("state.json")# Load storage state from a file and apply it to the context.
context.set_storage_state("state.json")Arguments
Learn more about storage state and auth.
Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browser_context.storage_state().
cookies Array<Object>
Cookies to set for context
name string
value string
domain string
Domain and path are required. For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com"
path string
Domain and path are required
expires float
Unix time in seconds.
http_only boolean
secure boolean
same_site "Strict" | "Lax" | "None"
sameSite flag
origins Array<Object>
origin string
local_storage Array<Object>
localStorage to set for context
name stringvalue stringReturns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot, origin private file system snapshot and virtual WebAuthn credentials.
Arguments
credentials boolean (optional) Added in: v1.62
Set to true to include the context's virtual WebAuthn browser_context.credentials (passkeys) in the storage state snapshot. The captured credentials carry their private keys and signature counters, so they can be re-seeded into a later context via the storage_state option or browser_context.set_storage_state(). Note that restoring the storage state that contains credentials will automatically install the virtual WebAuthn authenticator (see credentials.install()), and prevent all real authenticators from working in this context.
indexed_db boolean (optional) Added in: v1.51
Set to true to include IndexedDB in the storage state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication, enable this.
opfs boolean (optional) Added in: v1.63
Set to true to include the origin private file system in the storage state snapshot.
INFO
OPFS is currently not supported in ephemeral WebKit contexts.
The file path to save the storage state to. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
Returns
ObjectRemoves a route created with browser_context.route(). When handler is not specified, removes all routes for the url.
Arguments
url string | RegExp | function(URL): boolean
A glob pattern, regex pattern, or predicate receiving [URL] used to register a routing with browser_context.route().
handler function(Route) | function(Route, Request) (optional)
Optional handler function used to register a routing with browser_context.route().
Removes all routes created with browser_context.route() and browser_context.route_from_har().
Arguments
behavior "wait" | "ignoreErrors" | "default" (optional)
Specifies whether to wait for already running handlers and what to do if they throw errors:
'default' - do not wait for current handler calls (if any) to finish, if unrouted handler throws, it may result in unhandled error'wait' - wait for current handler calls (if any) to finish'ignoreErrors' - do not wait for current handler calls (if any) to finish, all errors thrown by the handlers after unrouting are silently caughtINFO
In most cases, you should use browser_context.expect_event().
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 browser context is closed before the event is fired.
Arguments
Event name, same one typically passed into *.on(event).
predicate function() (optional)
Receives the event data and resolves to truthy value when the waiting should resolve.
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().
Returns
anyPlaywright has ability to mock clock and passage of time.
Type
ClockVirtual WebAuthn authenticator for this context. Lets tests seed credentials and intercept navigator.credentials.create() / navigator.credentials.get() ceremonies.
Type
CredentialsDebugger allows to pause and resume the execution.
Type
DebuggerAPI testing helper associated with this context. Requests made with this API will use context cookies.
Type
APIRequestContextType
TracingEmitted when Browser context gets closed. This might happen because of one of the following:
browser.close() method was called.Event data
BrowserContextEmitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.
The arguments passed into console.log and the page are available on the ConsoleMessage event handler argument.
Usage
async def print_args(msg):
values = []
for arg in msg.args:
values.append(await arg.json_value())
print(values)
context.on("console", print_args)
await page.evaluate("console.log('hello', 5, { foo: 'bar' })")def print_args(msg):
for arg in msg.args:
print(arg.json_value())
context.on("console", print_args)
page.evaluate("console.log('hello', 5, { foo: 'bar' })")Event data
ConsoleMessageEmitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept() or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.
Usage
context.on("dialog", lambda dialog: dialog.accept())INFO
When no page.on("dialog") or browserContext.on("dialog") listeners are present, all dialogs are automatically dismissed.
Event data
DialogEmitted when a JavaScript dialog in any page belonging to this context has been closed, either by dialog.accept(), by dialog.dismiss(), or manually by the user in the headed browser.
Event data
DialogEmitted when attachment download started in any page belonging to this context. User can access basic file operations on downloaded content via the passed Download instance. See also page.on("download") to receive events about a specific page.
Event data
DownloadEmitted when a frame is attached in any page belonging to this context. See also page.on("frameAttached") to receive events about a specific page.
Event data
FrameEmitted when a frame is detached in any page belonging to this context. See also page.on("frameDetached") to receive events about a specific page.
Event data
FrameEmitted when a frame is navigated to a new url in any page belonging to this context. See also page.on("frameNavigated") to receive events about navigations in a specific page.
Event data
FrameThe event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also page.on("popup") to receive events about popups relevant to a specific 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. If you would like to route/listen to this network request, use browser_context.route() and browserContext.on("request") respectively instead of similar methods on the Page.
async with context.expect_page() as page_info:
await page.get_by_text("open new page").click(),
page = await page_info.value
print(await page.evaluate("location.href"))with context.expect_page() as page_info:
page.get_by_text("open new page").click(),
page = page_info.value
print(page.evaluate("location.href"))INFO
Use page.wait_for_load_state() to wait until the page gets to a particular state (you should not need it in most cases).
Event data
PageEmitted when a page in this context is closed. See also page.on("close") to receive events about a specific page.
Event data
PageEmitted when the JavaScript load event is dispatched in any page belonging to this context. See also page.on("load") to receive events about a specific page.
Event data
PageEmitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use page.on("request").
In order to intercept and mutate requests, see browser_context.route() or page.route().
Event data
RequestEmitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on("requestFailed").
INFO
HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on("requestFinished") event and not with browserContext.on("requestFailed").
Event data
RequestEmitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished. To listen for successful requests from a particular page, use page.on("requestFinished").
Event data
RequestEmitted when [response] status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished. To listen for response events from a particular page, use page.on("response").
Event data
ResponseINFO
Service workers are only supported on Chromium-based browsers.
Emitted when new service worker is created in the context.
Event data
WorkerEmitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use page.on("pageError") instead.
Event data
WebErrorDeprecated
Background pages have been removed from Chromium together with Manifest V2 extensions.
This event is not emitted.
Event data
PageDeprecated
Background pages have been removed from Chromium together with Manifest V2 extensions.
Returns an empty list.
Returns
Array<Page>