Version: 1.10.0

Browser

A Browser is created via browser_type.launch(**kwargs). An example of using a Browser to create a Page:

from playwright.sync_api import sync_playwright
def run(playwright):
firefox = playwright.firefox
browser = firefox.launch()
page = browser.new_page()
page.goto("https://example.com")
browser.close()
with sync_playwright() as playwright:
run(playwright)

browser.on("disconnected")#

Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

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

browser.close()#

In case this browser is obtained using browser_type.launch(**kwargs), closes the browser and all of its pages (if any were opened).

In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server.

The Browser object itself is considered to be disposed and cannot be used anymore.

browser.contexts#

Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.

browser = pw.webkit.launch()
print(len(browser.contexts())) # prints `0`
context = browser.new_context()
print(len(browser.contexts())) # prints `1`

browser.is_connected()#

Indicates that the browser is connected.

browser.new_context(**kwargs)#

  • accept_downloads <bool> Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.
  • bypass_csp <bool> Toggles bypassing page's Content-Security-Policy.
  • color_scheme <"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulate_media(**kwargs) for more details. Defaults to 'light'.
  • device_scale_factor <float> Specify device scale factor (can be thought of as dpr). Defaults to 1.
  • extra_http_headers <Dict[str, str]> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
  • geolocation <Dict>
    • latitude <float> Latitude between -90 and 90.
    • longitude <float> Longitude between -180 and 180.
    • accuracy <float> Non-negative accuracy value. Defaults to 0.
  • has_touch <bool> Specifies if viewport supports touch events. Defaults to false.
  • http_credentials <Dict> Credentials for HTTP authentication.
  • ignore_https_errors <bool> Whether to ignore HTTPS errors during navigation. Defaults to false.
  • is_mobile <bool> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
  • java_script_enabled <bool> Whether or not to enable JavaScript in the context. Defaults to true.
  • locale <str> Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules.
  • no_viewport <bool> Does not enforce fixed viewport, allows resizing window in the headed mode.
  • offline <bool> Whether to emulate network being offline. Defaults to false.
  • permissions <List[str]> A list of permissions to grant to all pages in this context. See browser_context.grant_permissions(permissions, **kwargs) for more details.
  • proxy <Dict> Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).
    • server <str> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
    • bypass <str> Optional coma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
    • username <str> Optional username to use if HTTP proxy requires authentication.
    • password <str> Optional password to use if HTTP proxy requires authentication.
  • record_har_omit_content <bool> Optional setting to control whether to omit request content from the HAR. Defaults to false.
  • record_har_path <Union[str, pathlib.Path]> Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call browser_context.close() for the HAR to be saved.
  • record_video_dir <Union[str, pathlib.Path]> Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call browser_context.close() for videos to be saved.
  • record_video_size <Dict> Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
    • width <int> Video frame width.
    • height <int> Video frame height.
  • storage_state <Union[str, pathlib.Path]|Dict> Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browser_context.storage_state(**kwargs). Either a path to the file with saved storage, or an object with the following fields:
    • cookies <List[Dict]> Optional cookies to set for context
      • name <str>
      • value <str>
      • url <str> Optional either url or domain / path are required
      • domain <str> Optional either url or domain / path are required
      • path <str> Optional either url or domain / path are required
      • expires <float> Optional Unix time in seconds.
      • httpOnly <bool> Optional httpOnly flag
      • secure <bool> Optional secure flag
      • sameSite <"Strict"|"Lax"|"None"> Optional sameSite flag
    • origins <List[Dict]> Optional localStorage to set for context
  • timezone_id <str> Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.
  • user_agent <str> Specific user agent to use in this context.
  • viewport <NoneType|Dict> Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. no_viewport disables the fixed viewport.
    • width <int> page width in pixels.
    • height <int> page height in pixels.
  • returns: <BrowserContext>

Creates a new browser context. It won't share cookies/cache with other browser contexts.

browser = playwright.firefox.launch() # or "chromium" or "webkit".
# create a new incognito browser context.
context = browser.new_context()
# create a new page in a pristine context.
page = context.new_page()
page.goto("https://example.com")

browser.new_page(**kwargs)#

  • accept_downloads <bool> Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.
  • bypass_csp <bool> Toggles bypassing page's Content-Security-Policy.
  • color_scheme <"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulate_media(**kwargs) for more details. Defaults to 'light'.
  • device_scale_factor <float> Specify device scale factor (can be thought of as dpr). Defaults to 1.
  • extra_http_headers <Dict[str, str]> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
  • geolocation <Dict>
    • latitude <float> Latitude between -90 and 90.
    • longitude <float> Longitude between -180 and 180.
    • accuracy <float> Non-negative accuracy value. Defaults to 0.
  • has_touch <bool> Specifies if viewport supports touch events. Defaults to false.
  • http_credentials <Dict> Credentials for HTTP authentication.
  • ignore_https_errors <bool> Whether to ignore HTTPS errors during navigation. Defaults to false.
  • is_mobile <bool> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
  • java_script_enabled <bool> Whether or not to enable JavaScript in the context. Defaults to true.
  • locale <str> Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules.
  • no_viewport <bool> Does not enforce fixed viewport, allows resizing window in the headed mode.
  • offline <bool> Whether to emulate network being offline. Defaults to false.
  • permissions <List[str]> A list of permissions to grant to all pages in this context. See browser_context.grant_permissions(permissions, **kwargs) for more details.
  • proxy <Dict> Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).
    • server <str> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
    • bypass <str> Optional coma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
    • username <str> Optional username to use if HTTP proxy requires authentication.
    • password <str> Optional password to use if HTTP proxy requires authentication.
  • record_har_omit_content <bool> Optional setting to control whether to omit request content from the HAR. Defaults to false.
  • record_har_path <Union[str, pathlib.Path]> Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call browser_context.close() for the HAR to be saved.
  • record_video_dir <Union[str, pathlib.Path]> Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call browser_context.close() for videos to be saved.
  • record_video_size <Dict> Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
    • width <int> Video frame width.
    • height <int> Video frame height.
  • storage_state <Union[str, pathlib.Path]|Dict> Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browser_context.storage_state(**kwargs). Either a path to the file with saved storage, or an object with the following fields:
    • cookies <List[Dict]> Optional cookies to set for context
      • name <str>
      • value <str>
      • url <str> Optional either url or domain / path are required
      • domain <str> Optional either url or domain / path are required
      • path <str> Optional either url or domain / path are required
      • expires <float> Optional Unix time in seconds.
      • httpOnly <bool> Optional httpOnly flag
      • secure <bool> Optional secure flag
      • sameSite <"Strict"|"Lax"|"None"> Optional sameSite flag
    • origins <List[Dict]> Optional localStorage to set for context
  • timezone_id <str> Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.
  • user_agent <str> Specific user agent to use in this context.
  • viewport <NoneType|Dict> Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. no_viewport disables the fixed viewport.
    • width <int> page width in pixels.
    • height <int> page height in pixels.
  • returns: <Page>

Creates a new page in a new browser context. Closing this page will close the context as well.

This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create browser.new_context(**kwargs) followed by the browser_context.new_page() to control their exact life times.

browser.version#

Returns the browser version.