Skip to content

Latest commit

 

History

History
812 lines (633 loc) · 24.5 KB

class-browsercontext.md

File metadata and controls

812 lines (633 loc) · 24.5 KB
Raw

class: BrowserContext

  • extends: [EventEmitter]

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 creation of "incognito" browser contexts with browser.newContext() method. "Incognito" browser contexts don't write any browsing data to disk.

// Create a new incognito browser context
const context = await browser.newContext();
// Create a new page inside context.
const page = await context.newPage();
await page.goto('https://example.com');
// Dispose context once it's no longer needed.
await 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"s 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"s no longer needed.
context.close()

event: BrowserContext.close

  • type: <[BrowserContext]>

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 [method: Browser.close] method was called.

event: BrowserContext.page

  • type: <[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 [event: Page.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.

const [page] = await Promise.all([
  context.waitForEvent('page'),
  page.click('a[target=_blank]'),
]);
console.log(await page.evaluate('location.href'));
async with context.expect_page() as page_info:
    await page.click("a[target=_blank]"),
page = await page_info.value
print(await page.evaluate("location.href"))
with context.expect_page() as page_info:
    page.click("a[target=_blank]"),
page = page_info.value
print(page.evaluate("location.href"))

:::note Use [method: Page.waitForLoadState] to wait until the page gets to a particular state (you should not need it in most cases). :::

async method: BrowserContext.addCookies

Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via [method: BrowserContext.cookies].

await browserContext.addCookies([cookieObject1, cookieObject2]);
await browser_context.add_cookies([cookie_object1, cookie_object2])
browser_context.add_cookies([cookie_object1, cookie_object2])

param: BrowserContext.addCookies.cookies

  • cookies <[Array]<[Object]>>
    • name <[string]>
    • value <[string]>
    • url <[string]> either url or domain / path are required. Optional.
    • domain <[string]> either url or domain / path are required Optional.
    • path <[string]> either url or domain / path are required Optional.
    • expires <[float]> Unix time in seconds. Optional.
    • httpOnly <[boolean]> Optional.
    • secure <[boolean]> Optional.
    • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">> Optional.

async method: BrowserContext.addInitScript

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.

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.
await browserContext.addInitScript({
  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")
# in your playwright script, assuming the preload.js file is in same directory.
browser_context.add_init_script(path="preload.js")

:::note The order of evaluation of multiple scripts installed via [method: BrowserContext.addInitScript] and [method: Page.addInitScript] is not defined. :::

param: BrowserContext.addInitScript.script

  • script <[function]|[string]|[Object]>
    • path <[path]> Path to the JavaScript file. If path is a relative path, then it is resolved relative to the current working directory. Optional.
    • content <[string]> Raw script content. Optional.

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

param: BrowserContext.addInitScript.arg

  • langs: js
  • arg <[Serializable]>

Optional argument to pass to [param: script] (only supported when passing a function).

method: BrowserContext.browser

  • returns: <[null]|[Browser]>

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

async method: BrowserContext.clearCookies

Clears context cookies.

async method: BrowserContext.clearPermissions

Clears all permission overrides for the browser context.

const context = await browser.newContext();
await context.grantPermissions(['clipboard-read']);
// do stuff ..
context.clearPermissions();
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()

async method: BrowserContext.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. :::

async method: BrowserContext.cookies

  • returns: <[Array]<[Object]>>
    • name <[string]>
    • value <[string]>
    • domain <[string]>
    • path <[string]>
    • expires <[float]> Unix time in seconds.
    • httpOnly <[boolean]>
    • secure <[boolean]>
    • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">>

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

param: BrowserContext.cookies.urls

  • urls <[string]|[Array]<[string]>>

Optional list of URLs.

async method: BrowserContext.exposeBinding

The method adds a function called [param: name] on the window object of every frame in every page in the context. When called, the function executes [param: callback] and returns a [Promise] which resolves to the return value of [param: callback]. If the [param: callback] returns a [Promise], it will be awaited.

The first argument of the [param: callback] function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.

See [method: Page.exposeBinding] for page-only version.

An example of exposing page URL to all frames in all pages in the context:

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  await context.exposeBinding('pageURL', ({ page }) => page.url());
  const page = await context.newPage();
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();
import asyncio
from playwright.async_api import async_playwright

async def run(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.click("button")

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())
from playwright.sync_api import sync_playwright

def run(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.click("button")

with sync_playwright() as playwright:
    run(playwright)

An example of passing an element handle:

await context.exposeBinding('clicked', async (source, element) => {
  console.log(await element.textContent());
}, { handle: true });
await page.setContent(`
  <script>
    document.addEventListener('click', event => window.clicked(event.target));
  </script>
  <div>Click me</div>
  <div>Or click me</div>
`);
async def print(source, element):
    print(await element.text_content())

await context.expose_binding("clicked", print, handle=true)
await page.set_content("""
  <script>
    document.addEventListener('click', event => window.clicked(event.target));
  </script>
  <div>Click me</div>
  <div>Or click me</div>
""")
def print(source, element):
    print(element.text_content())

context.expose_binding("clicked", print, handle=true)
page.set_content("""
  <script>
    document.addEventListener('click', event => window.clicked(event.target));
  </script>
  <div>Click me</div>
  <div>Or click me</div>
""")

param: BrowserContext.exposeBinding.name

  • name <[string]>

Name of the function on the window object.

param: BrowserContext.exposeBinding.callback

  • callback <[function]>

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

option: BrowserContext.exposeBinding.handle

  • handle <[boolean]>

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.

async method: BrowserContext.exposeFunction

The method adds a function called [param: name] on the window object of every frame in every page in the context. When called, the function executes [param: callback] and returns a [Promise] which resolves to the return value of [param: callback].

If the [param: callback] returns a [Promise], it will be awaited.

See [method: Page.exposeFunction] for page-only version.

An example of adding an md5 function to all pages in the context:

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
const crypto = require('crypto');

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  await context.exposeFunction('md5', text => crypto.createHash('md5').update(text).digest('hex'));
  const page = await context.newPage();
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.md5('PLAYWRIGHT');
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();
import asyncio
import hashlib
from playwright.async_api import async_playwright

async def sha1(text):
    m = hashlib.sha1()
    m.update(bytes(text, "utf8"))
    return m.hexdigest()


async def run(playwright):
    webkit = playwright.webkit
    browser = await webkit.launch(headless=False)
    context = await browser.new_context()
    await context.expose_function("sha1", sha1)
    page = await context.new_page()
    await page.set_content("""
        <script>
          async function onClick() {
            document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
          }
        </script>
        <button onclick="onClick()">Click me</button>
        <div></div>
    """)
    await page.click("button")

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 sha1(text):
    m = hashlib.sha1()
    m.update(bytes(text, "utf8"))
    return m.hexdigest()


def run(playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    context = browser.new_context()
    context.expose_function("sha1", sha1)
    page = context.new_page()
    page.expose_function("sha1", sha1)
    page.set_content("""
        <script>
          async function onClick() {
            document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
          }
        </script>
        <button onclick="onClick()">Click me</button>
        <div></div>
    """)
    page.click("button")

with sync_playwright() as playwright:
    run(playwright)

param: BrowserContext.exposeFunction.name

  • name <[string]>

Name of the function on the window object.

param: BrowserContext.exposeFunction.callback

  • callback <[function]>

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

async method: BrowserContext.grantPermissions

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

param: BrowserContext.grantPermissions.permissions

  • permissions <[Array]<[string]>>

A permission or an array of permissions to grant. Permissions can be one of the following values:

  • 'geolocation'
  • 'midi'
  • 'midi-sysex' (system-exclusive midi)
  • 'notifications'
  • 'push'
  • 'camera'
  • 'microphone'
  • 'background-sync'
  • 'ambient-light-sensor'
  • 'accelerometer'
  • 'gyroscope'
  • 'magnetometer'
  • 'accessibility-events'
  • 'clipboard-read'
  • 'clipboard-write'
  • 'payment-handler'

option: BrowserContext.grantPermissions.origin

  • origin <[string]>

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

async method: BrowserContext.newPage

  • returns: <[Page]>

Creates a new page in the browser context.

method: BrowserContext.pages

  • returns: <[Array]<[Page]>>

Returns all open pages in the context. Non visible pages, such as "background_page", will not be listed here. You can find them using [method: ChromiumBrowserContext.backgroundPages].

async method: BrowserContext.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.

An example of a naïve handler that aborts all image requests:

const context = await browser.newContext();
await context.route('**/*.{png,jpg,jpeg}', route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await 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()
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:

const context = await browser.newContext();
await context.route(/(\.png$)|(\.jpg$)/, route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await 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()
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()

Page routes (set up with [method: Page.route]) take precedence over browser context routes when request matches both handlers.

:::note Enabling routing disables http cache. :::

param: BrowserContext.route.url

  • url <[string]|[RegExp]|[function]([URL]):[boolean]>

A glob pattern, regex pattern or predicate receiving [URL] to match while routing.

param: BrowserContext.route.handler

  • langs: js, python
  • handler <[function]([Route], [Request])>

handler function to route the request.

param: BrowserContext.route.handler

  • langs: csharp, java
  • handler <[function]([Route])>

handler function to route the request.

method: BrowserContext.setDefaultNavigationTimeout

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

  • [method: Page.goBack]
  • [method: Page.goForward]
  • [method: Page.goto]
  • [method: Page.reload]
  • [method: Page.setContent]
  • [method: Page.waitForNavigation]

:::note [method: Page.setDefaultNavigationTimeout] and [method: Page.setDefaultTimeout] take priority over [method: BrowserContext.setDefaultNavigationTimeout]. :::

param: BrowserContext.setDefaultNavigationTimeout.timeout

  • timeout <[float]>

Maximum navigation time in milliseconds

method: BrowserContext.setDefaultTimeout

This setting will change the default maximum time for all the methods accepting [param: timeout] option.

:::note [method: Page.setDefaultNavigationTimeout], [method: Page.setDefaultTimeout] and [method: BrowserContext.setDefaultNavigationTimeout] take priority over [method: BrowserContext.setDefaultTimeout]. :::

param: BrowserContext.setDefaultTimeout.timeout

  • timeout <[float]>

Maximum time in milliseconds

async method: BrowserContext.setExtraHTTPHeaders

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 [method: Page.setExtraHTTPHeaders]. If page overrides a particular header, page-specific header value will be used instead of the browser context header value.

:::note [method: BrowserContext.setExtraHTTPHeaders] does not guarantee the order of headers in the outgoing requests. :::

param: BrowserContext.setExtraHTTPHeaders.headers

  • headers <[Object]<[string], [string]>>

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

async method: BrowserContext.setGeolocation

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

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

:::note Consider using [method: BrowserContext.grantPermissions] to grant permissions for the browser context pages to read its geolocation. :::

param: BrowserContext.setGeolocation.geolocation

  • geolocation <[null]|[Object]>
    • latitude <[float]> Latitude between -90 and 90.
    • longitude <[float]> Longitude between -180 and 180.
    • accuracy <[float]> Non-negative accuracy value. Defaults to 0.

async method: BrowserContext.setHTTPCredentials

  • langs: js

DEPRECATED Browsers may cache credentials after successful authentication. Create a new browser context instead.

param: BrowserContext.setHTTPCredentials.httpCredentials

  • httpCredentials <[null]|[Object]>
    • username <[string]>
    • password <[string]>

async method: BrowserContext.setOffline

param: BrowserContext.setOffline.offline

  • offline <[boolean]>

Whether to emulate network being offline for the browser context.

async method: BrowserContext.storageState

  • returns: <[Object]>
    • cookies <[Array]<[Object]>>
      • name <[string]>
      • value <[string]>
      • domain <[string]>
      • path <[string]>
      • expires <[float]> Unix time in seconds.
      • httpOnly <[boolean]>
      • secure <[boolean]>
      • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">>
    • origins <[Array]<[Object]>>
      • origin <[string]>
      • localStorage <[Array]<[Object]>>
        • name <[string]>
        • value <[string]>

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

async method: BrowserContext.storageState

  • langs: charp, java
  • returns: <[string]>

option: BrowserContext.storageState.path

  • path <[path]>

The file path to save the storage state to. If [option: 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.

async method: BrowserContext.unroute

Removes a route created with [method: BrowserContext.route]. When [param: handler] is not specified, removes all routes for the [param: url].

param: BrowserContext.unroute.url

  • url <[string]|[RegExp]|[function]([URL]):[boolean]>

A glob pattern, regex pattern or predicate receiving [URL] used to register a routing with [method: BrowserContext.route].

param: BrowserContext.unroute.handler

  • langs: js, python
  • handler <[function]([Route], [Request])>

Optional handler function used to register a routing with [method: BrowserContext.route].

param: BrowserContext.unroute.handler

  • langs: csharp, java
  • handler <[function]([Route])>

Optional handler function used to register a routing with [method: BrowserContext.route].

async method: BrowserContext.waitForEvent

  • langs: csharp, js, python
    • alias-python: expect_event
  • returns: <[any]>

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.

const [page, _] = await Promise.all([
  context.waitForEvent('page'),
  page.click('button')
]);
async with context.expect_event("page") as event_info:
    await page.click("button")
page = await event_info.value
with context.expect_event("page") as event_info:
    page.click("button")
page = event_info.value

param: BrowserContext.waitForEvent.event

  • event <[string]>

Event name, same one would pass into browserContext.on(event).

param: BrowserContext.waitForEvent.optionsOrPredicate

  • langs: js
  • optionsOrPredicate <[function]|[Object]>
    • predicate <[function]> 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 [method: BrowserContext.setDefaultTimeout].

Either a predicate that receives an event or an options object. Optional.

async method: BrowserContext.waitForPage

  • langs: csharp, java, python
    • alias-python: expect_page
  • returns: <[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.

option: BrowserContext.waitForPage.predicate =

  • langs: csharp, java, python
  • predicate <[function]([Page]):[boolean]>

Receives the [Page] object and resolves to truthy value when the waiting should resolve.

option: BrowserContext.waitForPage.timeout = %%-wait-for-event-timeout-%%