human_requests.human_browser

Classes

HumanBrowser

Module Contents

class HumanBrowser(impl_obj: Any)[source]
static replace(
playwright_browser: playwright.async_api.Browser,
) → HumanBrowser[source]
async new_page(
**kwargs: Any,
) → HumanPage[source]

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[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[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[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[Path, str, None], cert: Union[bytes, None], keyPath: Union[Path, str, None], key: Union[bytes, None], pfxPath: Union[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.

Return type:

Page

async new_context(
**kwargs: Any,
) → HumanContext[source]

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 = await playwright.firefox.launch() # or “chromium” or “webkit”. # create a new incognito browser context. context = await browser.new_context() # create a new page in a pristine context. page = await context.new_page() await page.goto(”https://example.com”)

# gracefully close up everything await context.close() await 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[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[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[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[Path, str, None], cert: Union[bytes, None], keyPath: Union[Path, str, None], key: Union[bytes, None], pfxPath: Union[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.

Return type:

BrowserContext

property contexts: List[HumanContext][source]

Browser.contexts

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

Usage

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

Return type:

List[BrowserContext]