`http` — HTTP modules¶

http is a package that collects several modules for working with theHyperText Transfer Protocol:

http.client is a low-level HTTP protocol client; for high-level URLopening useurllib.request
http.server contains basic HTTP server classes based onsocketserver
http.cookies has utilities for implementing state management with cookies
http.cookiejar provides persistence of cookies

Thehttp module also defines the following enums that help you work with http related code:

classhttp.HTTPStatus¶

Added in version 3.5.

A subclass ofenum.IntEnum that defines a set of HTTP status codes,reason phrases and long descriptions written in English.

Usage:

>>>fromhttpimportHTTPStatus>>>HTTPStatus.OKHTTPStatus.OK>>>HTTPStatus.OK==200True>>>HTTPStatus.OK.value200>>>HTTPStatus.OK.phrase'OK'>>>HTTPStatus.OK.description'Request fulfilled, document follows'>>>list(HTTPStatus)[HTTPStatus.CONTINUE, HTTPStatus.SWITCHING_PROTOCOLS, ...]

HTTP status codes¶

Supported,IANA-registered status codesavailable inhttp.HTTPStatus are:

Code	Enum Name	Details
`100`	`CONTINUE`	HTTP SemanticsRFC 9110, Section 15.2.1
`101`	`SWITCHING_PROTOCOLS`	HTTP SemanticsRFC 9110, Section 15.2.2
`102`	`PROCESSING`	WebDAVRFC 2518, Section 10.1
`103`	`EARLY_HINTS`	An HTTP Status Code for Indicating HintsRFC 8297
`200`	`OK`	HTTP SemanticsRFC 9110, Section 15.3.1
`201`	`CREATED`	HTTP SemanticsRFC 9110, Section 15.3.2
`202`	`ACCEPTED`	HTTP SemanticsRFC 9110, Section 15.3.3
`203`	`NON_AUTHORITATIVE_INFORMATION`	HTTP SemanticsRFC 9110, Section 15.3.4
`204`	`NO_CONTENT`	HTTP SemanticsRFC 9110, Section 15.3.5
`205`	`RESET_CONTENT`	HTTP SemanticsRFC 9110, Section 15.3.6
`206`	`PARTIAL_CONTENT`	HTTP SemanticsRFC 9110, Section 15.3.7
`207`	`MULTI_STATUS`	WebDAVRFC 4918, Section 11.1
`208`	`ALREADY_REPORTED`	WebDAV Binding ExtensionsRFC 5842, Section 7.1 (Experimental)
`226`	`IM_USED`	Delta Encoding in HTTPRFC 3229, Section 10.4.1
`300`	`MULTIPLE_CHOICES`	HTTP SemanticsRFC 9110, Section 15.4.1
`301`	`MOVED_PERMANENTLY`	HTTP SemanticsRFC 9110, Section 15.4.2
`302`	`FOUND`	HTTP SemanticsRFC 9110, Section 15.4.3
`303`	`SEE_OTHER`	HTTP SemanticsRFC 9110, Section 15.4.4
`304`	`NOT_MODIFIED`	HTTP SemanticsRFC 9110, Section 15.4.5
`305`	`USE_PROXY`	HTTP SemanticsRFC 9110, Section 15.4.6
`307`	`TEMPORARY_REDIRECT`	HTTP SemanticsRFC 9110, Section 15.4.8
`308`	`PERMANENT_REDIRECT`	HTTP SemanticsRFC 9110, Section 15.4.9
`400`	`BAD_REQUEST`	HTTP SemanticsRFC 9110, Section 15.5.1
`401`	`UNAUTHORIZED`	HTTP SemanticsRFC 9110, Section 15.5.2
`402`	`PAYMENT_REQUIRED`	HTTP SemanticsRFC 9110, Section 15.5.3
`403`	`FORBIDDEN`	HTTP SemanticsRFC 9110, Section 15.5.4
`404`	`NOT_FOUND`	HTTP SemanticsRFC 9110, Section 15.5.5
`405`	`METHOD_NOT_ALLOWED`	HTTP SemanticsRFC 9110, Section 15.5.6
`406`	`NOT_ACCEPTABLE`	HTTP SemanticsRFC 9110, Section 15.5.7
`407`	`PROXY_AUTHENTICATION_REQUIRED`	HTTP SemanticsRFC 9110, Section 15.5.8
`408`	`REQUEST_TIMEOUT`	HTTP SemanticsRFC 9110, Section 15.5.9
`409`	`CONFLICT`	HTTP SemanticsRFC 9110, Section 15.5.10
`410`	`GONE`	HTTP SemanticsRFC 9110, Section 15.5.11
`411`	`LENGTH_REQUIRED`	HTTP SemanticsRFC 9110, Section 15.5.12
`412`	`PRECONDITION_FAILED`	HTTP SemanticsRFC 9110, Section 15.5.13
`413`	`CONTENT_TOO_LARGE`	HTTP SemanticsRFC 9110, Section 15.5.14
`414`	`URI_TOO_LONG`	HTTP SemanticsRFC 9110, Section 15.5.15
`415`	`UNSUPPORTED_MEDIA_TYPE`	HTTP SemanticsRFC 9110, Section 15.5.16
`416`	`RANGE_NOT_SATISFIABLE`	HTTP SemanticsRFC 9110, Section 15.5.17
`417`	`EXPECTATION_FAILED`	HTTP SemanticsRFC 9110, Section 15.5.18
`418`	`IM_A_TEAPOT`	HTCPCP/1.0RFC 2324, Section 2.3.2
`421`	`MISDIRECTED_REQUEST`	HTTP SemanticsRFC 9110, Section 15.5.20
`422`	`UNPROCESSABLE_CONTENT`	HTTP SemanticsRFC 9110, Section 15.5.21
`423`	`LOCKED`	WebDAVRFC 4918, Section 11.3
`424`	`FAILED_DEPENDENCY`	WebDAVRFC 4918, Section 11.4
`425`	`TOO_EARLY`	Using Early Data in HTTPRFC 8470
`426`	`UPGRADE_REQUIRED`	HTTP SemanticsRFC 9110, Section 15.5.22
`428`	`PRECONDITION_REQUIRED`	Additional HTTP Status CodesRFC 6585
`429`	`TOO_MANY_REQUESTS`	Additional HTTP Status CodesRFC 6585
`431`	`REQUEST_HEADER_FIELDS_TOO_LARGE`	Additional HTTP Status CodesRFC 6585
`451`	`UNAVAILABLE_FOR_LEGAL_REASONS`	An HTTP Status Code to Report Legal ObstaclesRFC 7725
`500`	`INTERNAL_SERVER_ERROR`	HTTP SemanticsRFC 9110, Section 15.6.1
`501`	`NOT_IMPLEMENTED`	HTTP SemanticsRFC 9110, Section 15.6.2
`502`	`BAD_GATEWAY`	HTTP SemanticsRFC 9110, Section 15.6.3
`503`	`SERVICE_UNAVAILABLE`	HTTP SemanticsRFC 9110, Section 15.6.4
`504`	`GATEWAY_TIMEOUT`	HTTP SemanticsRFC 9110, Section 15.6.5
`505`	`HTTP_VERSION_NOT_SUPPORTED`	HTTP SemanticsRFC 9110, Section 15.6.6
`506`	`VARIANT_ALSO_NEGOTIATES`	Transparent Content Negotiation in HTTPRFC 2295, Section 8.1 (Experimental)
`507`	`INSUFFICIENT_STORAGE`	WebDAVRFC 4918, Section 11.5
`508`	`LOOP_DETECTED`	WebDAV Binding ExtensionsRFC 5842, Section 7.2 (Experimental)
`510`	`NOT_EXTENDED`	An HTTP Extension FrameworkRFC 2774, Section 7 (Experimental)
`511`	`NETWORK_AUTHENTICATION_REQUIRED`	Additional HTTP Status CodesRFC 6585, Section 6

In order to preserve backwards compatibility, enum values are also presentin thehttp.client module in the form of constants. The enum name isequal to the constant name (i.e.http.HTTPStatus.OK is also available ashttp.client.OK).

Changed in version 3.7:Added421MISDIRECTED_REQUEST status code.

Added in version 3.8:Added451UNAVAILABLE_FOR_LEGAL_REASONS status code.

Added in version 3.9:Added103EARLY_HINTS,418IM_A_TEAPOT and425TOO_EARLY status codes.

Changed in version 3.13:Implemented RFC9110 naming for status constants. Old constant names are preserved forbackwards compatibility:413REQUEST_ENTITY_TOO_LARGE,414REQUEST_URI_TOO_LONG,416REQUESTED_RANGE_NOT_SATISFIABLE and422UNPROCESSABLE_ENTITY.

HTTP status category¶

Added in version 3.12.

The enum values have several properties to indicate the HTTP status category:

Property	Indicates that	Details
`is_informational`	`100<=status<=199`	HTTP SemanticsRFC 9110, Section 15
`is_success`	`200<=status<=299`	HTTP SemanticsRFC 9110, Section 15
`is_redirection`	`300<=status<=399`	HTTP SemanticsRFC 9110, Section 15
`is_client_error`	`400<=status<=499`	HTTP SemanticsRFC 9110, Section 15
`is_server_error`	`500<=status<=599`	HTTP SemanticsRFC 9110, Section 15

Usage:

>>>fromhttpimportHTTPStatus>>>HTTPStatus.OK.is_successTrue>>>HTTPStatus.OK.is_client_errorFalse

classhttp.HTTPMethod¶

Added in version 3.11.

A subclass ofenum.StrEnum that defines a set of HTTP methods and descriptions written in English.

Usage:

>>>fromhttpimportHTTPMethod>>>>>>HTTPMethod.GET<HTTPMethod.GET>>>>HTTPMethod.GET=='GET'True>>>HTTPMethod.GET.value'GET'>>>HTTPMethod.GET.description'Retrieve the target.'>>>list(HTTPMethod)[<HTTPMethod.CONNECT>, <HTTPMethod.DELETE>, <HTTPMethod.GET>, <HTTPMethod.HEAD>, <HTTPMethod.OPTIONS>, <HTTPMethod.PATCH>, <HTTPMethod.POST>, <HTTPMethod.PUT>, <HTTPMethod.TRACE>]

HTTP methods¶

Supported,IANA-registered methodsavailable inhttp.HTTPMethod are:

Method	Enum Name	Details
`GET`	`GET`	HTTP SemanticsRFC 9110, Section 9.3.1
`HEAD`	`HEAD`	HTTP SemanticsRFC 9110, Section 9.3.2
`POST`	`POST`	HTTP SemanticsRFC 9110, Section 9.3.3
`PUT`	`PUT`	HTTP SemanticsRFC 9110, Section 9.3.4
`DELETE`	`DELETE`	HTTP SemanticsRFC 9110, Section 9.3.5
`CONNECT`	`CONNECT`	HTTP SemanticsRFC 9110, Section 9.3.6
`OPTIONS`	`OPTIONS`	HTTP SemanticsRFC 9110, Section 9.3.7
`TRACE`	`TRACE`	HTTP SemanticsRFC 9110, Section 9.3.8
`PATCH`	`PATCH`	HTTP/1.1RFC 5789

Movatterモバイル変換

Navigation

`http` — HTTP modules¶

HTTP status codes¶

HTTP status category¶

HTTP methods¶

Table of Contents

Previous topic

Next topic

This page

Navigation

Movatterモバイル変換

http — HTTP modules¶

HTTP status codes¶

HTTP status category¶

HTTP methods¶

`http` — HTTP modules¶