playwright.dev/python/docs/api/class-browsercontext.mdx at 18de09c4a00a9d710bd2c5915b1ccfaebb9dcd14 · microsoft/playwright.dev

id	title
class-browsercontext	BrowserContext

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import HTMLCard from '@site/src/components/HTMLCard';

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 = 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()

# 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()

Methods

add_cookies {#browser-context-add-cookies}

Added before v1.9browserContext.add_cookies

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

browser_context.add_cookies([cookie_object1, cookie_object2])

await browser_context.add_cookies([cookie_object1, cookie_object2])

Arguments

cookies List[Dict]#
- name str
- value str
- url str (optional)
  
  Either url or domain / path are required. Optional.
- domain str (optional)
  
  For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com". Either url or domain / path are required. Optional.
- path str (optional)
  
  Either url or domain / path are required Optional.
- expires float (optional)
  
  Unix time in seconds. Optional.
- httpOnly bool (optional)
  
  Optional.
- secure bool (optional)
  
  Optional.
- sameSite "Strict" | "Lax" | "None" (optional)
  
  Optional.

Returns

NoneType #

add_init_script {#browser-context-add-init-script}

Added before v1.9browserContext.add_init_script

Adds a script which would be evaluated in one of the following scenarios:

Whenever a page is created in the browser context or is navigated.
Whenever a child frame is attached or navigated in any page in the browser context. 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.

Usage

An example of overriding Math.random before the page loads:

// preload.js
Math.random = () => 42;

# in your playwright script, assuming the preload.js file is in same directory.
browser_context.add_init_script(path="preload.js")

# in your playwright script, assuming the preload.js file is in same directory.
await browser_context.add_init_script(path="preload.js")

:::note

The order of evaluation of multiple scripts installed via browser_context.add_init_script() and page.add_init_script() is not defined. :::

Arguments

path Union[str, pathlib.Path] (optional)#

Path to the JavaScript file. If path is a relative path, then it is resolved relative to the current working directory. Optional.
script str (optional)#

Script to be evaluated in all pages in the browser context. Optional.

Returns

NoneType #

clear_cookies {#browser-context-clear-cookies}

Added before v1.9browserContext.clear_cookies

Removes cookies from context. Accepts optional filter.

Usage

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")

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")

Arguments

domain str | Pattern (optional) Added in: v1.43 #

Only removes cookies with the given domain.
name str | Pattern (optional) Added in: v1.43 #

Only removes cookies with the given name.
path str | Pattern (optional) Added in: v1.43 #

Only removes cookies with the given path.

Returns

NoneType #

clear_permissions {#browser-context-clear-permissions}

Added before v1.9browserContext.clear_permissions

Clears all permission overrides for the browser context.

Usage

context = browser.new_context()
context.grant_permissions(["clipboard-read"])
# do stuff ..
context.clear_permissions()

context = await browser.new_context()
await context.grant_permissions(["clipboard-read"])
# do stuff ..
context.clear_permissions()

Returns

NoneType #

close {#browser-context-close}

Added before v1.9browserContext.close

Closes the browser context. All the pages that belong to the browser context will be closed.

:::note

The default browser context cannot be closed. :::

Usage

browser_context.close()
browser_context.close(**kwargs)

Arguments

reason str (optional) Added in: v1.40 #

The reason to be reported to the operations interrupted by the context closure.

Returns

NoneType #

cookies {#browser-context-cookies}

Added before v1.9browserContext.cookies

If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.

Usage

browser_context.cookies()
browser_context.cookies(**kwargs)

Arguments

urls str | List[str] (optional)#

Optional list of URLs.

Returns

List[Dict]#
- name str
- value str
- domain str
- path str
- expires float
  
  Unix time in seconds.
- httpOnly bool
- secure bool
- sameSite "Strict" | "Lax" | "None"

expect_console_message {#browser-context-wait-for-console-message}

Added in: v1.34browserContext.expect_console_message

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 browser_context.on("console") event is fired.

Usage

browser_context.expect_console_message()
browser_context.expect_console_message(**kwargs)

Arguments

predicate Callable[ConsoleMessage]:bool (optional)#

Receives the ConsoleMessage object and resolves to truthy value when the waiting should resolve.
timeout float (optional)#

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]#

expect_event {#browser-context-wait-for-event}

Added before v1.9browserContext.expect_event

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

with context.expect_event("page") as event_info:
    page.get_by_role("button").click()
page = event_info.value

async with context.expect_event("page") as event_info:
    await page.get_by_role("button").click()
page = await event_info.value

Arguments

event str #

Event name, same one would pass into browserContext.on(event).
predicate Callable (optional)#

Receives the event data and resolves to truthy value when the waiting should resolve.
timeout float (optional)#

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 #

expect_page {#browser-context-wait-for-page}

Added in: v1.9browserContext.expect_page

Performs 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.

Usage

browser_context.expect_page()
browser_context.expect_page(**kwargs)

Arguments

predicate Callable[Page]:bool (optional)#

Receives the Page object and resolves to truthy value when the waiting should resolve.
timeout float (optional)#

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]#

expose_binding {#browser-context-expose-binding}

Added before v1.9browserContext.expose_binding

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:

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)

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())

Arguments

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 (optional)#

:::warning[Deprecated] This option will be removed in the future. :::

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.

Returns

NoneType #

expose_function {#browser-context-expose-function}

Added before v1.9browserContext.expose_function

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 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)

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())

Arguments

name str #

Name of the function on the window object.
callback Callable #

Callback function that will be called in the Playwright's context.

Returns

NoneType #

grant_permissions {#browser-context-grant-permissions}

Added before v1.9browserContext.grant_permissions

Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.

Usage

browser_context.grant_permissions(permissions)
browser_context.grant_permissions(permissions, **kwargs)

Arguments

permissions List[str]#

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'
- 'magnetometer'
- 'microphone'
- 'midi-sysex' (system-exclusive midi)
- 'midi'
- 'notifications'
- 'payment-handler'
- 'storage-access'
origin str (optional)#

The origin to grant permissions to, e.g. "https://example.com".

Returns

NoneType #

new_cdp_session {#browser-context-new-cdp-session}

Added in: v1.11browserContext.new_cdp_session

:::note

CDP sessions are only supported on Chromium-based browsers. :::

Returns the newly created session.

Usage

browser_context.new_cdp_session(page)

Arguments

page Page | Frame #

Target to create new session for. For backwards-compatibility, this parameter is named page, but it can be a Page or Frame type.

Returns

CDPSession #

new_page {#browser-context-new-page}

Added before v1.9browserContext.new_page

Creates a new page in the browser context.

Usage

browser_context.new_page()

Returns

Page #

route {#browser-context-route}

Added before v1.9browserContext.route

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.

:::note

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 = browser.new_context()
page = context.new_page()
context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.goto("https://example.com")
browser.close()

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()

or the same snippet using a regex pattern instead:

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()

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()

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:

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)

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)

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().

:::note

Enabling routing disables http cache. :::

Arguments

url str | Pattern | Callable[URL]:bool #

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 Callable[Route, Request]:Promise[Any] | Any #

handler function to route the request.
times int (optional) Added in: v1.15 #

How often a route should be used. By default it will be used every time.

Returns

NoneType #

route_from_har {#browser-context-route-from-har}

Added in: v1.23browserContext.route_from_har

If 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'.

Usage

browser_context.route_from_har(har)
browser_context.route_from_har(har, **kwargs)

Arguments

har Union[str, pathlib.Path]#

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)#
- If set to 'abort' any request not found in the HAR file will be aborted.
- If set to 'fallback' falls through to the next route handler in the handler chain.
Defaults to abort.
update bool (optional)#

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 str | Pattern (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.

Returns

NoneType #

route_web_socket {#browser-context-route-web-socket}

Added in: v1.48browserContext.route_web_socket

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(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "to-be-blocked":
    return
  ws.send(message)

def handler(ws: WebSocketRoute):
  ws.route_send(lambda message: message_handler(ws, message))
  ws.connect()

context.route_web_socket("/ws", handler)

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "to-be-blocked":
    return
  ws.send(message)

async def handler(ws: WebSocketRoute):
  ws.route_send(lambda message: message_handler(ws, message))
  await ws.connect()

await context.route_web_socket("/ws", handler)

Arguments

url str | Pattern | Callable[URL]:bool #

Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the base_url context option.
handler Callable[WebSocketRoute]:Promise[Any] | Any #

Handler function to route the WebSocket.

Returns

NoneType #

set_default_navigation_timeout {#browser-context-set-default-navigation-timeout}

Added before v1.9browserContext.set_default_navigation_timeout

This setting will change the default maximum navigation time for the following methods and related shortcuts:

:::note

page.set_default_navigation_timeout() and page.set_default_timeout() take priority over browser_context.set_default_navigation_timeout(). :::

Usage

browser_context.set_default_navigation_timeout(timeout)

Arguments

timeout float #

Maximum navigation time in milliseconds

set_default_timeout {#browser-context-set-default-timeout}

Added before v1.9browserContext.set_default_timeout

This setting will change the default maximum time for all the methods accepting timeout option.

:::note

page.set_default_navigation_timeout(), page.set_default_timeout() and browser_context.set_default_navigation_timeout() take priority over browser_context.set_default_timeout(). :::

Usage

browser_context.set_default_timeout(timeout)

Arguments

timeout float #

Maximum time in milliseconds. Pass 0 to disable timeout.

set_extra_http_headers {#browser-context-set-extra-http-headers}

Added before v1.9browserContext.set_extra_http_headers

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.

:::note

browser_context.set_extra_http_headers() does not guarantee the order of headers in the outgoing requests. :::

Usage

browser_context.set_extra_http_headers(headers)

Arguments

headers Dict[str, str]#

An object containing additional HTTP headers to be sent with every request. All header values must be strings.

Returns

NoneType #

set_geolocation {#browser-context-set-geolocation}

Added before v1.9browserContext.set_geolocation

Sets the context's geolocation. Passing null or undefined emulates position unavailable.

Usage

browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})

await browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})

:::note

Consider using browser_context.grant_permissions() to grant permissions for the browser context pages to read its geolocation. :::

Arguments

geolocation NoneType | Dict#
- latitude float
  
  Latitude between -90 and 90.
- longitude float
  
  Longitude between -180 and 180.
- accuracy float (optional)
  
  Non-negative accuracy value. Defaults to 0.

Returns

NoneType #

set_offline {#browser-context-set-offline}

Added before v1.9browserContext.set_offline

Usage

browser_context.set_offline(offline)

Arguments

offline bool #

Whether to emulate network being offline for the browser context.

Returns

NoneType #

storage_state {#browser-context-storage-state}

Added before v1.9browserContext.storage_state

Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.

Usage

browser_context.storage_state()
browser_context.storage_state(**kwargs)

Arguments

indexed_db bool (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.

:::note

IndexedDBs with typed arrays are currently not supported. :::
path Union[str, pathlib.Path] (optional)#

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

Dict#
- cookies List[Dict]
  - name str
  - value str
  - domain str
  - path str
  - expires float
    
    Unix time in seconds.
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
- origins List[Dict]
  - origin str
  - localStorage List[Dict]
    - name str
    - value str

unroute {#browser-context-unroute}

Added before v1.9browserContext.unroute

Removes a route created with browser_context.route(). When handler is not specified, removes all routes for the url.

Usage

browser_context.unroute(url)
browser_context.unroute(url, **kwargs)

Arguments

url str | Pattern | Callable[URL]:bool #

A glob pattern, regex pattern or predicate receiving URL used to register a routing with browser_context.route().
handler Callable[Route, Request]:Promise[Any] | Any (optional)#

Optional handler function used to register a routing with browser_context.route().

Returns

NoneType #

unroute_all {#browser-context-unroute-all}

Added in: v1.41browserContext.unroute_all

Removes all routes created with browser_context.route() and browser_context.route_from_har().

Usage

browser_context.unroute_all()
browser_context.unroute_all(**kwargs)

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 caught

Returns

NoneType #

wait_for_event {#browser-context-wait-for-event-2}

Added before v1.9browserContext.wait_for_event

:::note

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.

Usage

browser_context.wait_for_event(event)
browser_context.wait_for_event(event, **kwargs)

Arguments

event str #

Event name, same one typically passed into *.on(event).
predicate Callable (optional)#

Receives the event data and resolves to truthy value when the waiting should resolve.
timeout float (optional)#

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

Any #

Properties

background_pages {#browser-context-background-pages}

Added in: v1.11browserContext.background_pages

:::note

Background pages are only supported on Chromium-based browsers. :::

All existing background pages in the context.

Usage

browser_context.background_pages

Returns

List[Page]#

browser {#browser-context-browser}

Added before v1.9browserContext.browser

Returns the browser instance of the context. If it was launched as a persistent context null gets returned.

Usage

browser_context.browser

Returns

NoneType | Browser #

clock {#browser-context-clock}

Added in: v1.45browserContext.clock

Playwright has ability to mock clock and passage of time.

Usage

browser_context.clock

Type

Clock

pages {#browser-context-pages}

Added before v1.9browserContext.pages

Returns all open pages in the context.

Usage

browser_context.pages

Returns

List[Page]#

request {#browser-context-request}

Added in: v1.16browserContext.request

API testing helper associated with this context. Requests made with this API will use context cookies.

Usage

browser_context.request

Type

APIRequestContext

service_workers {#browser-context-service-workers}

Added in: v1.11browserContext.service_workers

:::note

Service workers are only supported on Chromium-based browsers. :::

All existing service workers in the context.

Usage

browser_context.service_workers

Returns

List[Worker]#

tracing {#browser-context-tracing}

Added in: v1.12browserContext.tracing

Usage

browser_context.tracing

Type

Tracing

Events

on("backgroundpage") {#browser-context-event-background-page}

Added in: v1.11browserContext.on("backgroundpage")

:::note

Only works with Chromium browser's persistent context. :::

Emitted when new background page is created in the context.

background_page = context.wait_for_event("backgroundpage")

background_page = await context.wait_for_event("backgroundpage")

Usage

browser_context.on("backgroundpage", handler)

Event data

Page

on("close") {#browser-context-event-close}

Added before v1.9browserContext.on("close")

Emitted when Browser context gets closed. This might happen because of one of the following:

Browser context is closed.
Browser application is closed or crashed.
The browser.close() method was called.

Usage

browser_context.on("close", handler)

Event data

BrowserContext

on("console") {#browser-context-event-console}

Added in: v1.34browserContext.on("console")

Emitted 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

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' })")

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' })")

Event data

ConsoleMessage

on("dialog") {#browser-context-event-dialog}

Added in: v1.34browserContext.on("dialog")

Emitted 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())

:::note When no page.on("dialog") or browser_context.on("dialog") listeners are present, all dialogs are automatically dismissed. :::

Event data

Dialog

on("page") {#browser-context-event-page}

Added before v1.9browserContext.on("page")

The 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 browser_context.on("request") respectively instead of similar methods on the Page.

with context.expect_page() as page_info:
    page.get_by_text("open new page").click(),
page = page_info.value
print(page.evaluate("location.href"))

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"))

:::note

Use page.wait_for_load_state() to wait until the page gets to a particular state (you should not need it in most cases). :::

Usage

browser_context.on("page", handler)

Event data

Page

on("request") {#browser-context-event-request}

Added in: v1.12browserContext.on("request")

Emitted 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().

Usage

browser_context.on("request", handler)

Event data

Request

on("requestfailed") {#browser-context-event-request-failed}

Added in: v1.12browserContext.on("requestfailed")

Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on("requestfailed").

:::note

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browser_context.on("requestfinished") event and not with browser_context.on("requestfailed"). :::

Usage

browser_context.on("requestfailed", handler)

Event data

Request

on("requestfinished") {#browser-context-event-request-finished}

Added in: v1.12browserContext.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. To listen for successful requests from a particular page, use page.on("requestfinished").

Usage

browser_context.on("requestfinished", handler)

Event data

Request

on("response") {#browser-context-event-response}

Added in: v1.12browserContext.on("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. To listen for response events from a particular page, use page.on("response").

Usage

browser_context.on("response", handler)

Event data

Response

on("serviceworker") {#browser-context-event-service-worker}

Added in: v1.11browserContext.on("serviceworker")

:::note

Service workers are only supported on Chromium-based browsers. :::

Emitted when new service worker is created in the context.

Usage

browser_context.on("serviceworker", handler)

Event data

Worker

on("weberror") {#browser-context-event-web-error}

Added in: v1.38browserContext.on("weberror")

Emitted 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.

Usage

browser_context.on("weberror", handler)

Event data

WebError

FilesExpand file tree

class-browsercontext.mdx

Latest commit

History

class-browsercontext.mdx

File metadata and controls

Methods

add_cookies {#browser-context-add-cookies}

add_init_script {#browser-context-add-init-script}

clear_cookies {#browser-context-clear-cookies}

clear_permissions {#browser-context-clear-permissions}

close {#browser-context-close}

cookies {#browser-context-cookies}

expect_console_message {#browser-context-wait-for-console-message}

expect_event {#browser-context-wait-for-event}

expect_page {#browser-context-wait-for-page}

expose_binding {#browser-context-expose-binding}

expose_function {#browser-context-expose-function}

grant_permissions {#browser-context-grant-permissions}

new_cdp_session {#browser-context-new-cdp-session}

new_page {#browser-context-new-page}

route {#browser-context-route}

route_from_har {#browser-context-route-from-har}

route_web_socket {#browser-context-route-web-socket}

set_default_navigation_timeout {#browser-context-set-default-navigation-timeout}

set_default_timeout {#browser-context-set-default-timeout}

set_extra_http_headers {#browser-context-set-extra-http-headers}

set_geolocation {#browser-context-set-geolocation}

set_offline {#browser-context-set-offline}

storage_state {#browser-context-storage-state}

unroute {#browser-context-unroute}

unroute_all {#browser-context-unroute-all}

wait_for_event {#browser-context-wait-for-event-2}

Properties

background_pages {#browser-context-background-pages}

browser {#browser-context-browser}

clock {#browser-context-clock}

pages {#browser-context-pages}

request {#browser-context-request}

service_workers {#browser-context-service-workers}

tracing {#browser-context-tracing}

Events

on("backgroundpage") {#browser-context-event-background-page}

on("close") {#browser-context-event-close}

on("console") {#browser-context-event-console}

on("dialog") {#browser-context-event-dialog}

on("page") {#browser-context-event-page}

on("request") {#browser-context-event-request}

on("requestfailed") {#browser-context-event-request-failed}

on("requestfinished") {#browser-context-event-request-finished}

on("response") {#browser-context-event-response}

on("serviceworker") {#browser-context-event-service-worker}

on("weberror") {#browser-context-event-web-error}