BrowserType
BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:
- Sync
- Async
- browser_type.executable_path
- browser_type.launch(**kwargs)
- browser_type.launch_persistent_context(user_data_dir, **kwargs)
- browser_type.name
#
browser_type.executable_path- returns: <str>
A path where Playwright expects to find a bundled browser executable.
#
browser_type.launch(**kwargs)args
<List[str]> Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.chromium_sandbox
<bool> Enable Chromium sandboxing. Defaults tofalse
.devtools
<bool> Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option istrue
, theheadless
option will be setfalse
.downloads_path
<Union[str, pathlib.Path]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed.env
<Dict[str, str|float|bool]> Specify environment variables that will be visible to the browser. Defaults toprocess.env
.executable_path
<Union[str, pathlib.Path]> Path to a browser executable to run instead of the bundled one. Ifexecutable_path
is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.firefox_user_prefs
<Dict[str, str|float|bool]> Firefox user preferences. Learn more about the Firefox user preferences atabout:config
.handle_sighup
<bool> Close the browser process on SIGHUP. Defaults totrue
.handle_sigint
<bool> Close the browser process on Ctrl-C. Defaults totrue
.handle_sigterm
<bool> Close the browser process on SIGTERM. Defaults totrue
.headless
<bool> Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults totrue
unless thedevtools
option istrue
.ignore_default_args
<bool|List[str]> Iftrue
, Playwright does not pass its own configurations args and only uses the ones fromargs
. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults tofalse
.proxy
<Dict> Network proxy settings.server
<str> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for examplehttp://myproxy.com:3128
orsocks5://myproxy.com:3128
. Short formmyproxy.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.
slow_mo
<float> Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.timeout
<float> Maximum time in milliseconds to wait for the browser instance to start. Defaults to30000
(30 seconds). Pass0
to disable timeout.- returns: <Browser>
Returns the browser instance.
You can use ignore_default_args
to filter out --mute-audio
from default arguments:
- Sync
- Async
Chromium-only Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use
executable_path
option with extreme caution.If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.
Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.
#
browser_type.launch_persistent_context(user_data_dir, **kwargs)user_data_dir
<Union[str, pathlib.Path]> Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the parent directory of the "Profile Path" seen atchrome://version
.accept_downloads
<bool> Whether to automatically download all the attachments. Defaults tofalse
where all the downloads are canceled.args
<List[str]> Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.bypass_csp
<bool> Toggles bypassing page's Content-Security-Policy.chromium_sandbox
<bool> Enable Chromium sandboxing. Defaults totrue
.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 to1
.devtools
<bool> Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option istrue
, theheadless
option will be setfalse
.downloads_path
<Union[str, pathlib.Path]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed.env
<Dict[str, str|float|bool]> Specify environment variables that will be visible to the browser. Defaults toprocess.env
.executable_path
<Union[str, pathlib.Path]> Path to a browser executable to run instead of the bundled one. Ifexecutable_path
is a relative path, then it is resolved relative to the current working directory. BEWARE: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.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>handle_sighup
<bool> Close the browser process on SIGHUP. Defaults totrue
.handle_sigint
<bool> Close the browser process on Ctrl-C. Defaults totrue
.handle_sigterm
<bool> Close the browser process on SIGTERM. Defaults totrue
.has_touch
<bool> Specifies if viewport supports touch events. Defaults to false.headless
<bool> Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults totrue
unless thedevtools
option istrue
.http_credentials
<Dict> Credentials for HTTP authentication.ignore_default_args
<bool|List[str]> Iftrue
, Playwright does not pass its own configurations args and only uses the ones fromargs
. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults tofalse
.ignore_https_errors
<bool> Whether to ignore HTTPS errors during navigation. Defaults tofalse
.is_mobile
<bool> Whether themeta viewport
tag is taken into account and touch events are enabled. Defaults tofalse
. Not supported in Firefox.java_script_enabled
<bool> Whether or not to enable JavaScript in the context. Defaults totrue
.locale
<str> Specify user locale, for exampleen-GB
,de-DE
, etc. Locale will affectnavigator.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 tofalse
.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.server
<str> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for examplehttp://myproxy.com:3128
orsocks5://myproxy.com:3128
. Short formmyproxy.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 tofalse
.record_har_path
<Union[str, pathlib.Path]> Path on the filesystem to write the HAR file to.record_video_dir
<Union[str, pathlib.Path]> Path to the directory to put videos into.record_video_size
<Dict> Dimensions of the recorded videos. If not specified the size will be equal toviewport
scaled down to fit into 800x800. Ifviewport
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.slow_mo
<float> Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.timeout
<float> Maximum time in milliseconds to wait for the browser instance to start. Defaults to30000
(30 seconds). Pass0
to disable timeout.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.- returns: <BrowserContext>
Returns the persistent browser context instance.
Launches browser that uses persistent storage located at user_data_dir
and returns the only context. Closing this context will automatically close the browser.
#
browser_type.name- returns: <str>
Returns browser name. For example: 'chromium'
, 'webkit'
or 'firefox'
.