Share via

HttpResponse Class

  • Reference

An HTTP response object.

Constructor

HttpResponse(body: str | bytes | None = None, *, status_code: HTTPStatus | int | None = None, headers: Mapping[str, str] | None = None, mimetype: str | None = None, charset: str | None = None)

Parameters

Name Description
body
<xref:<xref:str/bytes>>

Optional response body.

Default value: None
status_code
Required
int

Response status code. If not specified, defaults to 200. You can use an int status code or an http.HTTPStatus value
headers
Required
dict

An optional mapping containing response HTTP headers.
mimetype
Required
str

An optional response MIME type. If not specified, defaults to 'text/plain'.
charset
Required
str

Response content text encoding. If not specified, defaults to 'utf-8'.

Keyword-Only Parameters

Name Description
status_code
Default value: None
headers
Default value: None
mimetype
Default value: None
charset
Default value: None

Methods

get_body

Response body as a bytes object.

get_body

Response body as a bytes object.

get_body() -> bytes

Attributes

charset

Response text encoding.

headers

A dictionary of response HTTP headers.

mimetype

Response MIME type.

status_code

Response status code.