PyCharm 2022.2 Help

HTTP Response reference

The response object holds the information about a received HTTP Response (response content, headers, status, and so on) and provides access to the headers and contentType nested objects.

Properties

Property

Description

body (string | LineStreamResponse | object)

Response content, which can be a string, a LineStreamResponse object, or a JSON object.

headers (ResponseHeaders)

The response headers storage object.

status (int)

Response status, for example, 200 or 404.

contentType (ContentType)

The contentType object, which holds the data on the Content-Type response header value.

Headers object

The ResponseHeaders object is used for retrieving the data about response headers' values.

Methods

Method

Parameters

Description

valueOf

headerName (string)

Retrieves the first value of the headerName response header or null if the headerName response header does not exist.

valuesOf

headerName (string)

Retrieves the array containing all values of the headerName response header. Returns an empty array if the headerName response header does not exist.

ContentType object

The ContentType data object contains information from the Content-Type response header.

Properties

Property

Description

mimeType (string)

The MIME type of the response, for example, text/plain, text/xml, application/json.

charset (string)

The string representation of the response charset, for example, utf-8.

LineStreamResponse object

The LineStreamResponse interface is used to process a response as a stream of lines. It implements a onEachLine(line, unsubscribe) method, which loops through each line in the stream, one after the other. The method takes two arguments:

Arguments

Argument

Description

line (a string or a JSON object)

A line (event) received as part of the stream.

unsubscribe

Function to terminate execution of the onEachLine block.

Last modified: 04 April 2022