Request
Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:
- page.on("request") emitted when the request is issued by the page.
- page.on("response") emitted when/if the response status and headers are received for the request.
- page.on("requestfinished") emitted when the response body is downloaded and the request is complete.
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.
- request.all_headers()
- request.failure
- request.frame
- request.header_value(name)
- request.headers
- request.headers_array()
- request.is_navigation_request()
- request.method
- request.post_data
- request.post_data_buffer
- request.post_data_json
- request.redirected_from
- request.redirected_to
- request.resource_type
- request.response()
- request.sizes()
- request.timing
- request.url
request.all_headers()
An object with all the request HTTP headers associated with this request. The header names are lower-cased.
request.failure
The method returns null
unless this request has failed, as reported by requestfailed
event.
Example of logging of all the failed requests:
page.on("requestfailed", lambda request: print(request.url + " " + request.failure))
request.frame
Returns the Frame that initiated this request.
request.header_value(name)
Returns the value of the header matching the name. The name is case insensitive.
request.headers
DEPRECATED Incomplete list of headers as seen by the rendering engine. Use request.all_headers() instead.
request.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.
request.is_navigation_request()
Whether this request is driving frame's navigation.
request.method
Request's method (GET, POST, etc.)
request.post_data
Request's post body, if any.
request.post_data_buffer
Request's post body in a binary form, if any.
request.post_data_json
- returns:NoneType|Serializable># <
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.
request.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()
.
For example, if the website http://example.com
redirects to https://example.com
:
- Sync
- 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:
- Sync
- 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
request.redirected_to
New request issued by the browser if the server responded with redirect.
This method is the opposite of request.redirected_from:
assert request.redirected_from.redirected_to == request
request.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
.
request.response()
Returns the matching Response object, or null
if the response was not received due to error.
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.
<
Returns resource size information for given request.
request.timing
- returns:Dict>#
startTime
<float> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTCdomainLookupStart
<float> Time immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative tostartTime
, -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 tostartTime
, -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 tostartTime
, -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 tostartTime
, -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 tostartTime
, -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 tostartTime
, -1 if not available.responseStart
<float> Time immediately after the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative tostartTime
, -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 tostartTime
, -1 if not available.
<
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.
- Sync
- 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)
request.url
URL of the request.