Skip to content

class-request.mdx

Latest commit

 

History

History
535 lines (362 loc) · 19.5 KB

class-request.mdx

File metadata and controls

535 lines (362 loc) · 19.5 KB
id class-request
title Request

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import HTMLCard from '@site/src/components/HTMLCard';

Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:

If request fails at some point, then instead of 'requestfinished' event (and possibly instead of 'response' event), the page.on("requestfailed") event is emitted.

:::note HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished' event. :::

If request gets a 'redirect' response, the request is successfully finished with the requestfinished event, and a new request is issued to a redirected url.

Methods

all_headers {#request-all-headers}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.all_headers

An object with all the request HTTP headers associated with this request. The header names are lower-cased.

Usage

request.all_headers()

Returns

failure {#request-failure}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.failure

The method returns null unless this request has failed, as reported by requestfailed event.

Usage

Example of logging of all the failed requests:

page.on("requestfailed", lambda request: print(request.url + " " + request.failure))

Returns

frame {#request-frame}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.frame

Returns the Frame that initiated this request.

Usage

request.frame

Returns

header_value {#request-header-value}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.header_value

Returns the value of the header matching the name. The name is case insensitive.

Usage

request.header_value(name)

Arguments

  • name str#

    Name of the header.

Returns

headers {#request-headers}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.headers

An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return security-related headers, including cookie-related ones. You can use request.all_headers() for complete list of headers that include cookie information.

Usage

request.headers

Returns

headers_array {#request-headers-array}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.headers_array

An array with all the request HTTP headers associated with this request. Unlike request.all_headers(), header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Usage

request.headers_array()

Returns

is_navigation_request {#request-is-navigation-request}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.is_navigation_request

Whether this request is driving frame's navigation.

Usage

request.is_navigation_request()

Returns

method {#request-method}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.method

Request's method (GET, POST, etc.)

Usage

request.method

Returns

post_data {#request-post-data}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.post_data

Request's post body, if any.

Usage

request.post_data

Returns

post_data_buffer {#request-post-data-buffer}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.post_data_buffer

Request's post body in a binary form, if any.

Usage

request.post_data_buffer

Returns

post_data_json {#request-post-data-json}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.post_data_json

Returns parsed request's body for form-urlencoded and JSON as a fallback if any.

When the response is application/x-www-form-urlencoded then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.

Usage

request.post_data_json

Returns

redirected_from {#request-redirected-from}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.redirected_from

Request that was redirected by the server to this one, if any.

When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by redirectedFrom() and redirectedTo() methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirectedFrom().

Usage

For example, if the website http://example.com redirects to https://example.com:

<Tabs groupId="python-flavor" defaultValue="sync" values={[ {label: 'Sync', value: 'sync'}, {label: 'Async', value: 'async'} ] }> 

response = page.goto("http://example.com")
print(response.request.redirected_from.url) # "http://example.com"
response = await page.goto("http://example.com")
print(response.request.redirected_from.url) # "http://example.com"

If the website https://google.com has no redirects:

<Tabs groupId="python-flavor" defaultValue="sync" values={[ {label: 'Sync', value: 'sync'}, {label: 'Async', value: 'async'} ] }> 

response = page.goto("https://google.com")
print(response.request.redirected_from) # None
response = await page.goto("https://google.com")
print(response.request.redirected_from) # None

Returns

redirected_to {#request-redirected-to}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.redirected_to

New request issued by the browser if the server responded with redirect.

Usage

This method is the opposite of request.redirected_from:

assert request.redirected_from.redirected_to == request

Returns

resource_type {#request-resource-type}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.resource_type

Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the following: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, other.

Usage

request.resource_type

Returns

response {#request-response}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.response

Returns the matching Response object, or null if the response was not received due to error.

Usage

request.response()

Returns

sizes {#request-sizes}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.sizes

Returns resource size information for given request.

Usage

request.sizes()

Returns

  • Dict#

    • requestBodySize int

      Size of the request body (POST data payload) in bytes. Set to 0 if there was no body.

    • requestHeadersSize int

      Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body.

    • responseBodySize int

      Size of the received response body (encoded) in bytes.

    • responseHeadersSize int

      Total number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body.

timing {#request-timing}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.timing

Returns resource timing information for given request. Most of the timing values become available upon the response, responseEnd becomes available when request finishes. Find more information at Resource Timing API.

Usage

<Tabs groupId="python-flavor" defaultValue="sync" values={[ {label: 'Sync', value: 'sync'}, {label: 'Async', value: 'async'} ] }> 

with page.expect_event("requestfinished") as request_info:
    page.goto("http://example.com")
request = request_info.value
print(request.timing)
async with page.expect_event("requestfinished") as request_info:
    await page.goto("http://example.com")
request = await request_info.value
print(request.timing)

Returns

  • Dict#

    • startTime float

      Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC

    • domainLookupStart float

      Time immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • domainLookupEnd float

      Time immediately after the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • connectStart float

      Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • secureConnectionStart float

      Time immediately before the browser starts the handshake process to secure the current connection. The value is given in milliseconds relative to startTime, -1 if not available.

    • connectEnd float

      Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • requestStart float

      Time immediately before the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • responseStart float

      Time immediately after the browser receives the first byte of the response from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.

    • responseEnd float

      Time immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to startTime, -1 if not available.

url {#request-url}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.8request.url

URL of the request.

Usage

request.url

Returns