![]() |
Qucs-S S-parameter Viewer & RF Synthesis Tools
|


Public Member Functions | |
| None | on (self, Literal["disconnected"] event, typing.Callable[["Browser"], "None"] f) |
| None | once (self, Literal["disconnected"] event, typing.Callable[["Browser"], "None"] f) |
| typing.List["BrowserContext"] | contexts (self) |
| "BrowserType" | browser_type (self) |
| str | version (self) |
| bool | is_connected (self) |
| "BrowserContext" | new_context (self, *typing.Optional[ViewportSize] viewport=None, typing.Optional[ViewportSize] screen=None, typing.Optional[bool] no_viewport=None, typing.Optional[bool] ignore_https_errors=None, typing.Optional[bool] java_script_enabled=None, typing.Optional[bool] bypass_csp=None, typing.Optional[str] user_agent=None, typing.Optional[str] locale=None, typing.Optional[str] timezone_id=None, typing.Optional[Geolocation] geolocation=None, typing.Optional[typing.Sequence[str]] permissions=None, typing.Optional[typing.Dict[str, str]] extra_http_headers=None, typing.Optional[bool] offline=None, typing.Optional[HttpCredentials] http_credentials=None, typing.Optional[float] device_scale_factor=None, typing.Optional[bool] is_mobile=None, typing.Optional[bool] has_touch=None, typing.Optional[Literal["dark", "light", "no-preference", "null"]] color_scheme=None, typing.Optional[Literal["no-preference", "null", "reduce"]] reduced_motion=None, typing.Optional[Literal["active", "none", "null"]] forced_colors=None, typing.Optional[Literal["more", "no-preference", "null"]] contrast=None, typing.Optional[bool] accept_downloads=None, typing.Optional[str] default_browser_type=None, typing.Optional[ProxySettings] proxy=None, typing.Optional[typing.Union[pathlib.Path, str]] record_har_path=None, typing.Optional[bool] record_har_omit_content=None, typing.Optional[typing.Union[pathlib.Path, str]] record_video_dir=None, typing.Optional[ViewportSize] record_video_size=None, typing.Optional[typing.Union[StorageState, str, pathlib.Path]] storage_state=None, typing.Optional[str] base_url=None, typing.Optional[bool] strict_selectors=None, typing.Optional[Literal["allow", "block"]] service_workers=None, typing.Optional[typing.Union[typing.Pattern[str], str]] record_har_url_filter=None, typing.Optional[Literal["full", "minimal"]] record_har_mode=None, typing.Optional[Literal["attach", "embed", "omit"]] record_har_content=None, typing.Optional[typing.List[ClientCertificate]] client_certificates=None) |
| "Page" | new_page (self, *typing.Optional[ViewportSize] viewport=None, typing.Optional[ViewportSize] screen=None, typing.Optional[bool] no_viewport=None, typing.Optional[bool] ignore_https_errors=None, typing.Optional[bool] java_script_enabled=None, typing.Optional[bool] bypass_csp=None, typing.Optional[str] user_agent=None, typing.Optional[str] locale=None, typing.Optional[str] timezone_id=None, typing.Optional[Geolocation] geolocation=None, typing.Optional[typing.Sequence[str]] permissions=None, typing.Optional[typing.Dict[str, str]] extra_http_headers=None, typing.Optional[bool] offline=None, typing.Optional[HttpCredentials] http_credentials=None, typing.Optional[float] device_scale_factor=None, typing.Optional[bool] is_mobile=None, typing.Optional[bool] has_touch=None, typing.Optional[Literal["dark", "light", "no-preference", "null"]] color_scheme=None, typing.Optional[Literal["active", "none", "null"]] forced_colors=None, typing.Optional[Literal["more", "no-preference", "null"]] contrast=None, typing.Optional[Literal["no-preference", "null", "reduce"]] reduced_motion=None, typing.Optional[bool] accept_downloads=None, typing.Optional[str] default_browser_type=None, typing.Optional[ProxySettings] proxy=None, typing.Optional[typing.Union[pathlib.Path, str]] record_har_path=None, typing.Optional[bool] record_har_omit_content=None, typing.Optional[typing.Union[pathlib.Path, str]] record_video_dir=None, typing.Optional[ViewportSize] record_video_size=None, typing.Optional[typing.Union[StorageState, str, pathlib.Path]] storage_state=None, typing.Optional[str] base_url=None, typing.Optional[bool] strict_selectors=None, typing.Optional[Literal["allow", "block"]] service_workers=None, typing.Optional[typing.Union[typing.Pattern[str], str]] record_har_url_filter=None, typing.Optional[Literal["full", "minimal"]] record_har_mode=None, typing.Optional[Literal["attach", "embed", "omit"]] record_har_content=None, typing.Optional[typing.List[ClientCertificate]] client_certificates=None) |
| None | close (self, *typing.Optional[str] reason=None) |
| "CDPSession" | new_browser_cdp_session (self) |
| None | start_tracing (self, *typing.Optional["Page"] page=None, typing.Optional[typing.Union[pathlib.Path, str]] path=None, typing.Optional[bool] screenshots=None, typing.Optional[typing.Sequence[str]] categories=None) |
| bytes | stop_tracing (self) |
Public Member Functions inherited from playwright._impl._sync_base.SyncContextManager | |
| Self | __enter__ (Self self) |
| None | __exit__ (self, Optional[Type[BaseException]] exc_type, Optional[BaseException] exc_val, Optional[TracebackType] _traceback) |
Public Member Functions inherited from playwright._impl._sync_base.SyncBase | |
| None | __init__ (self, Any impl_obj) |
| str | __str__ (self) |
| None | remove_listener (self, Any event, Any f) |
Public Member Functions inherited from playwright._impl._impl_to_api_mapping.ImplWrapper | |
| str | __repr__ (self) |
Additional Inherited Members | |
Protected Member Functions inherited from playwright._impl._sync_base.SyncBase | |
| Any | _sync (self, Union[Coroutine[Any, Any, Any], Generator[Any, Any, Any]] coro) |
| Callable[..., None] | _wrap_handler (self, Union[Callable[..., Any], Any] handler) |
Protected Attributes inherited from playwright._impl._sync_base.SyncBase | |
| _dispatcher_fiber | |
| _loop | |
Protected Attributes inherited from playwright._impl._impl_to_api_mapping.ImplWrapper | |
| _impl_obj | |
| "BrowserType" playwright.sync_api._generated.Browser.browser_type | ( | self | ) |
Browser.browser_type Get the browser type (chromium, firefox or webkit) that the browser belongs to. Returns ------- BrowserType
| None playwright.sync_api._generated.Browser.close | ( | self, | |
| *typing.Optional[str] | reason = None |
||
| ) |
Browser.close
In case this browser is obtained using `browser_type.launch()`, 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.
**NOTE** This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close
events, call `browser_context.close()` on any `BrowserContext` instances you explicitly created earlier
using `browser.new_context()` **before** calling `browser.close()`.
The `Browser` object itself is considered to be disposed and cannot be used anymore.
Parameters
----------
reason : Union[str, None]
The reason to be reported to the operations interrupted by the browser closure.
Reimplemented from playwright._impl._sync_base.SyncContextManager.
| typing.List["BrowserContext"] playwright.sync_api._generated.Browser.contexts | ( | self | ) |
Browser.contexts Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts. **Usage** ```py browser = pw.webkit.launch() print(len(browser.contexts)) # prints `0` context = browser.new_context() print(len(browser.contexts)) # prints `1` ``` Returns ------- List[BrowserContext]
| bool playwright.sync_api._generated.Browser.is_connected | ( | self | ) |
Browser.is_connected Indicates that the browser is connected. Returns ------- bool
| "CDPSession" playwright.sync_api._generated.Browser.new_browser_cdp_session | ( | self | ) |
Browser.new_browser_cdp_session **NOTE** CDP Sessions are only supported on Chromium-based browsers. Returns the newly created browser session. Returns ------- CDPSession
| "BrowserContext" playwright.sync_api._generated.Browser.new_context | ( | self, | |
| *typing.Optional[ViewportSize] | viewport = None, |
||
| typing.Optional[ViewportSize] | screen = None, |
||
| typing.Optional[bool] | no_viewport = None, |
||
| typing.Optional[bool] | ignore_https_errors = None, |
||
| typing.Optional[bool] | java_script_enabled = None, |
||
| typing.Optional[bool] | bypass_csp = None, |
||
| typing.Optional[str] | user_agent = None, |
||
| typing.Optional[str] | locale = None, |
||
| typing.Optional[str] | timezone_id = None, |
||
| typing.Optional[Geolocation] | geolocation = None, |
||
| typing.Optional[typing.Sequence[str]] | permissions = None, |
||
| typing.Optional[typing.Dict[str, str]] | extra_http_headers = None, |
||
| typing.Optional[bool] | offline = None, |
||
| typing.Optional[HttpCredentials] | http_credentials = None, |
||
| typing.Optional[float] | device_scale_factor = None, |
||
| typing.Optional[bool] | is_mobile = None, |
||
| typing.Optional[bool] | has_touch = None, |
||
| typing.Optional[ Literal["dark", "light", "no-preference", "null"] ] | color_scheme = None, |
||
| typing.Optional[ Literal["no-preference", "null", "reduce"] ] | reduced_motion = None, |
||
| typing.Optional[Literal["active", "none", "null"]] | forced_colors = None, |
||
| typing.Optional[Literal["more", "no-preference", "null"]] | contrast = None, |
||
| typing.Optional[bool] | accept_downloads = None, |
||
| typing.Optional[str] | default_browser_type = None, |
||
| typing.Optional[ProxySettings] | proxy = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | record_har_path = None, |
||
| typing.Optional[bool] | record_har_omit_content = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | record_video_dir = None, |
||
| typing.Optional[ViewportSize] | record_video_size = None, |
||
| typing.Optional[ typing.Union[StorageState, str, pathlib.Path] ] | storage_state = None, |
||
| typing.Optional[str] | base_url = None, |
||
| typing.Optional[bool] | strict_selectors = None, |
||
| typing.Optional[Literal["allow", "block"]] | service_workers = None, |
||
| typing.Optional[ typing.Union[typing.Pattern[str], str] ] | record_har_url_filter = None, |
||
| typing.Optional[Literal["full", "minimal"]] | record_har_mode = None, |
||
| typing.Optional[Literal["attach", "embed", "omit"]] | record_har_content = None, |
||
| typing.Optional[typing.List[ClientCertificate]] | client_certificates = None |
||
| ) |
Browser.new_context
Creates a new browser context. It won't share cookies/cache with other browser contexts.
**NOTE** If directly using this method to create `BrowserContext`s, it is best practice to explicitly close the
returned context via `browser_context.close()` when your code is done with the `BrowserContext`, and before
calling `browser.close()`. This will ensure the `context` is closed gracefully and any artifacts—like HARs
and videos—are fully flushed and saved.
**Usage**
```py
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\")
# gracefully close up everything
context.close()
browser.close()
```
Parameters
----------
viewport : Union[{width: int, height: int}, None]
Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed
viewport. Learn more about [viewport emulation](../emulation.md#viewport).
screen : Union[{width: int, height: int}, None]
Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the
`viewport` is set.
no_viewport : Union[bool, None]
Does not enforce fixed viewport, allows resizing window in the headed mode.
ignore_https_errors : Union[bool, None]
Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
java_script_enabled : Union[bool, None]
Whether or not to enable JavaScript in the context. Defaults to `true`. Learn more about
[disabling JavaScript](../emulation.md#javascript-enabled).
bypass_csp : Union[bool, None]
Toggles bypassing page's Content-Security-Policy. Defaults to `false`.
user_agent : Union[str, None]
Specific user agent to use in this context.
locale : Union[str, None]
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. Defaults to the system default
locale. Learn more about emulation in our [emulation guide](../emulation.md#locale--timezone).
timezone_id : Union[str, None]
Changes the timezone of the context. See
[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
for a list of supported timezone IDs. Defaults to the system timezone.
geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
permissions : Union[Sequence[str], None]
A list of permissions to grant to all pages in this context. See `browser_context.grant_permissions()` for
more details. Defaults to none.
extra_http_headers : Union[Dict[str, str], None]
An object containing additional HTTP headers to be sent with every request. Defaults to none.
offline : Union[bool, None]
Whether to emulate network being offline. Defaults to `false`. Learn more about
[network emulation](../emulation.md#offline).
http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
origin is specified, the username and password are sent to any servers upon unauthorized responses.
device_scale_factor : Union[float, None]
Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
[emulating devices with device scale factor](../emulation.md#devices).
is_mobile : Union[bool, None]
Whether the `meta viewport` tag is taken into account and touch events are enabled. isMobile is a part of device,
so you don't actually need to set it manually. Defaults to `false` and is not supported in Firefox. Learn more
about [mobile emulation](../emulation.md#ismobile).
has_touch : Union[bool, None]
Specifies if viewport supports touch events. Defaults to false. Learn more about
[mobile emulation](../emulation.md#devices).
color_scheme : Union["dark", "light", "no-preference", "null", None]
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details.
Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
reduced_motion : Union["no-preference", "null", "reduce", None]
Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'no-preference'`.
forced_colors : Union["active", "none", "null", None]
Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'none'`.
contrast : Union["more", "no-preference", "null", None]
Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'no-preference'`.
accept_downloads : Union[bool, None]
Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.
proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
Network proxy settings to use with this context. Defaults to none.
record_har_path : Union[pathlib.Path, str, None]
Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) 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_har_omit_content : Union[bool, None]
Optional setting to control whether to omit request content from the HAR. Defaults to `false`.
record_video_dir : Union[pathlib.Path, str, None]
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 : Union[{width: int, height: int}, None]
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.
storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}, None]
Learn more about [storage state and auth](../auth.md).
Populates context with given storage state. This option can be used to initialize context with logged-in
information obtained via `browser_context.storage_state()`.
base_url : Union[str, None]
When using `page.goto()`, `page.route()`, `page.wait_for_url()`,
`page.expect_request()`, or `page.expect_response()` it takes the base URL in consideration by
using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the
corresponding URL. Unset by default. Examples:
- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`
- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in
`http://localhost:3000/foo/bar.html`
- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
`http://localhost:3000/bar.html`
strict_selectors : Union[bool, None]
If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on
selectors that imply single target DOM element will throw when more than one element matches the selector. This
option does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See `Locator` to learn
more about the strict mode.
service_workers : Union["allow", "block", None]
Whether to allow sites to register Service workers. Defaults to `'allow'`.
- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be
registered.
- `'block'`: Playwright will block all registration of Service Workers.
record_har_url_filter : Union[Pattern[str], str, None]
record_har_mode : Union["full", "minimal", None]
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 `full`.
record_har_content : Union["attach", "embed", "omit", None]
Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
`attach` is specified, resources are persisted as separate files and all of these files are archived along with the
HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.
client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
TLS Client Authentication allows the server to request a client certificate and verify it.
**Details**
An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
`passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
with an exact match to the request origin that the certificate is valid for.
Client certificate authentication is only active when at least one client certificate is provided. If you want to
reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
does not match any of the domains you plan to visit.
**NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
work by replacing `localhost` with `local.playwright`.
Returns
-------
BrowserContext
| "Page" playwright.sync_api._generated.Browser.new_page | ( | self, | |
| *typing.Optional[ViewportSize] | viewport = None, |
||
| typing.Optional[ViewportSize] | screen = None, |
||
| typing.Optional[bool] | no_viewport = None, |
||
| typing.Optional[bool] | ignore_https_errors = None, |
||
| typing.Optional[bool] | java_script_enabled = None, |
||
| typing.Optional[bool] | bypass_csp = None, |
||
| typing.Optional[str] | user_agent = None, |
||
| typing.Optional[str] | locale = None, |
||
| typing.Optional[str] | timezone_id = None, |
||
| typing.Optional[Geolocation] | geolocation = None, |
||
| typing.Optional[typing.Sequence[str]] | permissions = None, |
||
| typing.Optional[typing.Dict[str, str]] | extra_http_headers = None, |
||
| typing.Optional[bool] | offline = None, |
||
| typing.Optional[HttpCredentials] | http_credentials = None, |
||
| typing.Optional[float] | device_scale_factor = None, |
||
| typing.Optional[bool] | is_mobile = None, |
||
| typing.Optional[bool] | has_touch = None, |
||
| typing.Optional[ Literal["dark", "light", "no-preference", "null"] ] | color_scheme = None, |
||
| typing.Optional[Literal["active", "none", "null"]] | forced_colors = None, |
||
| typing.Optional[Literal["more", "no-preference", "null"]] | contrast = None, |
||
| typing.Optional[ Literal["no-preference", "null", "reduce"] ] | reduced_motion = None, |
||
| typing.Optional[bool] | accept_downloads = None, |
||
| typing.Optional[str] | default_browser_type = None, |
||
| typing.Optional[ProxySettings] | proxy = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | record_har_path = None, |
||
| typing.Optional[bool] | record_har_omit_content = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | record_video_dir = None, |
||
| typing.Optional[ViewportSize] | record_video_size = None, |
||
| typing.Optional[ typing.Union[StorageState, str, pathlib.Path] ] | storage_state = None, |
||
| typing.Optional[str] | base_url = None, |
||
| typing.Optional[bool] | strict_selectors = None, |
||
| typing.Optional[Literal["allow", "block"]] | service_workers = None, |
||
| typing.Optional[ typing.Union[typing.Pattern[str], str] ] | record_har_url_filter = None, |
||
| typing.Optional[Literal["full", "minimal"]] | record_har_mode = None, |
||
| typing.Optional[Literal["attach", "embed", "omit"]] | record_har_content = None, |
||
| typing.Optional[typing.List[ClientCertificate]] | client_certificates = None |
||
| ) |
Browser.new_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()` followed by the
`browser_context.new_page()` to control their exact life times.
Parameters
----------
viewport : Union[{width: int, height: int}, None]
Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed
viewport. Learn more about [viewport emulation](../emulation.md#viewport).
screen : Union[{width: int, height: int}, None]
Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the
`viewport` is set.
no_viewport : Union[bool, None]
Does not enforce fixed viewport, allows resizing window in the headed mode.
ignore_https_errors : Union[bool, None]
Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
java_script_enabled : Union[bool, None]
Whether or not to enable JavaScript in the context. Defaults to `true`. Learn more about
[disabling JavaScript](../emulation.md#javascript-enabled).
bypass_csp : Union[bool, None]
Toggles bypassing page's Content-Security-Policy. Defaults to `false`.
user_agent : Union[str, None]
Specific user agent to use in this context.
locale : Union[str, None]
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. Defaults to the system default
locale. Learn more about emulation in our [emulation guide](../emulation.md#locale--timezone).
timezone_id : Union[str, None]
Changes the timezone of the context. See
[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
for a list of supported timezone IDs. Defaults to the system timezone.
geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
permissions : Union[Sequence[str], None]
A list of permissions to grant to all pages in this context. See `browser_context.grant_permissions()` for
more details. Defaults to none.
extra_http_headers : Union[Dict[str, str], None]
An object containing additional HTTP headers to be sent with every request. Defaults to none.
offline : Union[bool, None]
Whether to emulate network being offline. Defaults to `false`. Learn more about
[network emulation](../emulation.md#offline).
http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
origin is specified, the username and password are sent to any servers upon unauthorized responses.
device_scale_factor : Union[float, None]
Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
[emulating devices with device scale factor](../emulation.md#devices).
is_mobile : Union[bool, None]
Whether the `meta viewport` tag is taken into account and touch events are enabled. isMobile is a part of device,
so you don't actually need to set it manually. Defaults to `false` and is not supported in Firefox. Learn more
about [mobile emulation](../emulation.md#ismobile).
has_touch : Union[bool, None]
Specifies if viewport supports touch events. Defaults to false. Learn more about
[mobile emulation](../emulation.md#devices).
color_scheme : Union["dark", "light", "no-preference", "null", None]
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details.
Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
forced_colors : Union["active", "none", "null", None]
Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'none'`.
contrast : Union["more", "no-preference", "null", None]
Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'no-preference'`.
reduced_motion : Union["no-preference", "null", "reduce", None]
Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See
`page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
`'no-preference'`.
accept_downloads : Union[bool, None]
Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.
proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
Network proxy settings to use with this context. Defaults to none.
record_har_path : Union[pathlib.Path, str, None]
Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) 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_har_omit_content : Union[bool, None]
Optional setting to control whether to omit request content from the HAR. Defaults to `false`.
record_video_dir : Union[pathlib.Path, str, None]
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 : Union[{width: int, height: int}, None]
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.
storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}, None]
Learn more about [storage state and auth](../auth.md).
Populates context with given storage state. This option can be used to initialize context with logged-in
information obtained via `browser_context.storage_state()`.
base_url : Union[str, None]
When using `page.goto()`, `page.route()`, `page.wait_for_url()`,
`page.expect_request()`, or `page.expect_response()` it takes the base URL in consideration by
using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the
corresponding URL. Unset by default. Examples:
- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`
- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in
`http://localhost:3000/foo/bar.html`
- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
`http://localhost:3000/bar.html`
strict_selectors : Union[bool, None]
If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on
selectors that imply single target DOM element will throw when more than one element matches the selector. This
option does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See `Locator` to learn
more about the strict mode.
service_workers : Union["allow", "block", None]
Whether to allow sites to register Service workers. Defaults to `'allow'`.
- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be
registered.
- `'block'`: Playwright will block all registration of Service Workers.
record_har_url_filter : Union[Pattern[str], str, None]
record_har_mode : Union["full", "minimal", None]
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 `full`.
record_har_content : Union["attach", "embed", "omit", None]
Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
`attach` is specified, resources are persisted as separate files and all of these files are archived along with the
HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.
client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
TLS Client Authentication allows the server to request a client certificate and verify it.
**Details**
An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
`passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
with an exact match to the request origin that the certificate is valid for.
Client certificate authentication is only active when at least one client certificate is provided. If you want to
reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
does not match any of the domains you plan to visit.
**NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
work by replacing `localhost` with `local.playwright`.
Returns
-------
Page
| None playwright.sync_api._generated.Browser.on | ( | self, | |
| Literal["disconnected"] | event, | ||
| typing.Callable[["Browser"], "None"] | f | ||
| ) |
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.
Reimplemented from playwright._impl._sync_base.SyncBase.
| None playwright.sync_api._generated.Browser.once | ( | self, | |
| Literal["disconnected"] | event, | ||
| typing.Callable[["Browser"], "None"] | f | ||
| ) |
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.
Reimplemented from playwright._impl._sync_base.SyncBase.
| None playwright.sync_api._generated.Browser.start_tracing | ( | self, | |
| *typing.Optional["Page"] | page = None, |
||
| typing.Optional[typing.Union[pathlib.Path, str]] | path = None, |
||
| typing.Optional[bool] | screenshots = None, |
||
| typing.Optional[typing.Sequence[str]] | categories = None |
||
| ) |
Browser.start_tracing
**NOTE** This API controls
[Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level
chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found
[here](https://playwright.dev/python/docs/api/class-tracing).
You can use `browser.start_tracing()` and `browser.stop_tracing()` to create a trace file that can be
opened in Chrome DevTools performance panel.
**Usage**
```py
browser.start_tracing(page, path=\"trace.json\")
page.goto(\"https://www.google.com\")
browser.stop_tracing()
```
Parameters
----------
page : Union[Page, None]
Optional, if specified, tracing includes screenshots of the given page.
path : Union[pathlib.Path, str, None]
A path to write the trace file to.
screenshots : Union[bool, None]
captures screenshots in the trace.
categories : Union[Sequence[str], None]
specify custom categories to use instead of default.
| bytes playwright.sync_api._generated.Browser.stop_tracing | ( | self | ) |
Browser.stop_tracing **NOTE** This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found [here](https://playwright.dev/python/docs/api/class-tracing). Returns the buffer with trace data. Returns ------- bytes
| str playwright.sync_api._generated.Browser.version | ( | self | ) |
Browser.version Returns the browser version. Returns ------- str