`!http` --- HTTP modules
http
Source code: Lib/http/__init__.py
pair: HTTP; protocol single: HTTP; http (standard module)
!http is a package that collects several modules for working with the HyperText Transfer Protocol:
http.clientis a low-level HTTP protocol client; for high-level URL opening useurllib.requesthttp.servercontains basic HTTP server classes based onsocketserverhttp.cookieshas utilities for implementing state management with cookieshttp.cookiejarprovides persistence of cookies
The !http module also defines the following enums that help you work with http related code:
3.5
A subclass of enum.IntEnum that defines a set of HTTP status codes, reason phrases and long descriptions written in English.
Usage:
>>> from http import HTTPStatus
>>> HTTPStatus.OK
HTTPStatus.OK
>>> HTTPStatus.OK == 200
True
>>> HTTPStatus.OK.value
200
>>> 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 codes available in http.HTTPStatus are:
| Code | Enum Name | Details |
|---|---|---|
100 |
CONTINUE |
HTTP Semantics 9110, Section 15.2.1 |
101 |
SWITCHING_PROTOCOLS |
HTTP Semantics 9110, Section 15.2.2 |
102 |
PROCESSING |
WebDAV 2518, Section 10.1 |
103 |
EARLY_HINTS |
An HTTP Status Code for Indicating Hints 8297 |
200 |
OK |
HTTP Semantics 9110, Section 15.3.1 |
201 |
CREATED |
HTTP Semantics 9110, Section 15.3.2 |
202 |
ACCEPTED |
HTTP Semantics 9110, Section 15.3.3 |
203 |
NON_AUTHORITATIVE_INFORMATION |
HTTP Semantics 9110, Section 15.3.4 |
204 |
NO_CONTENT |
HTTP Semantics 9110, Section 15.3.5 |
205 |
RESET_CONTENT |
HTTP Semantics 9110, Section 15.3.6 |
206 |
PARTIAL_CONTENT |
HTTP Semantics 9110, Section 15.3.7 |
207 |
MULTI_STATUS |
WebDAV 4918, Section 11.1 |
208 |
ALREADY_REPORTED |
WebDAV Binding Extensions 5842, Section 7.1 (Experimental) |
226 |
IM_USED |
Delta Encoding in HTTP 3229, Section 10.4.1 |
300 |
MULTIPLE_CHOICES |
HTTP Semantics 9110, Section 15.4.1 |
301 |
MOVED_PERMANENTLY |
HTTP Semantics 9110, Section 15.4.2 |
302 |
FOUND |
HTTP Semantics 9110, Section 15.4.3 |
303 |
SEE_OTHER |
HTTP Semantics 9110, Section 15.4.4 |
304 |
NOT_MODIFIED |
HTTP Semantics 9110, Section 15.4.5 |
305 |
USE_PROXY |
HTTP Semantics 9110, Section 15.4.6 |
307 |
TEMPORARY_REDIRECT |
HTTP Semantics 9110, Section 15.4.8 |
308 |
PERMANENT_REDIRECT |
HTTP Semantics 9110, Section 15.4.9 |
400 |
BAD_REQUEST |
HTTP Semantics 9110, Section 15.5.1 |
401 |
UNAUTHORIZED |
HTTP Semantics 9110, Section 15.5.2 |
402 |
PAYMENT_REQUIRED |
HTTP Semantics 9110, Section 15.5.3 |
403 |
FORBIDDEN |
HTTP Semantics 9110, Section 15.5.4 |
404 |
NOT_FOUND |
HTTP Semantics 9110, Section 15.5.5 |
405 |
METHOD_NOT_ALLOWED |
HTTP Semantics 9110, Section 15.5.6 |
406 |
NOT_ACCEPTABLE |
HTTP Semantics 9110, Section 15.5.7 |
407 |
PROXY_AUTHENTICATION_REQUIRED |
HTTP Semantics 9110, Section 15.5.8 |
408 |
REQUEST_TIMEOUT |
HTTP Semantics 9110, Section 15.5.9 |
409 |
CONFLICT |
HTTP Semantics 9110, Section 15.5.10 |
410 |
GONE |
HTTP Semantics 9110, Section 15.5.11 |
411 |
LENGTH_REQUIRED |
HTTP Semantics 9110, Section 15.5.12 |
412 |
PRECONDITION_FAILED |
HTTP Semantics 9110, Section 15.5.13 |
413 |
CONTENT_TOO_LARGE |
HTTP Semantics 9110, Section 15.5.14 |
414 |
URI_TOO_LONG |
HTTP Semantics 9110, Section 15.5.15 |
415 |
UNSUPPORTED_MEDIA_TYPE |
HTTP Semantics 9110, Section 15.5.16 |
416 |
RANGE_NOT_SATISFIABLE |
HTTP Semantics 9110, Section 15.5.17 |
417 |
EXPECTATION_FAILED |
HTTP Semantics 9110, Section 15.5.18 |
418 |
IM_A_TEAPOT |
HTCPCP/1.0 2324, Section 2.3.2 |
421 |
MISDIRECTED_REQUEST |
HTTP Semantics 9110, Section 15.5.20 |
422 |
UNPROCESSABLE_CONTENT |
HTTP Semantics 9110, Section 15.5.21 |
423 |
LOCKED |
WebDAV 4918, Section 11.3 |
424 |
FAILED_DEPENDENCY |
WebDAV 4918, Section 11.4 |
425 |
TOO_EARLY |
Using Early Data in HTTP 8470 |
426 |
UPGRADE_REQUIRED |
HTTP Semantics 9110, Section 15.5.22 |
428 |
PRECONDITION_REQUIRED |
Additional HTTP Status Codes 6585 |
429 |
TOO_MANY_REQUESTS |
Additional HTTP Status Codes 6585 |
431 |
REQUEST_HEADER_FIELDS_TOO_LARGE |
Additional HTTP Status Codes 6585 |
451 |
UNAVAILABLE_FOR_LEGAL_REASONS |
An HTTP Status Code to Report Legal Obstacles 7725 |
500 |
INTERNAL_SERVER_ERROR |
HTTP Semantics 9110, Section 15.6.1 |
501 |
NOT_IMPLEMENTED |
HTTP Semantics 9110, Section 15.6.2 |
502 |
BAD_GATEWAY |
HTTP Semantics 9110, Section 15.6.3 |
503 |
SERVICE_UNAVAILABLE |
HTTP Semantics 9110, Section 15.6.4 |
504 |
GATEWAY_TIMEOUT |
HTTP Semantics 9110, Section 15.6.5 |
505 |
HTTP_VERSION_NOT_SUPPORTED |
HTTP Semantics 9110, Section 15.6.6 |
506 |
VARIANT_ALSO_NEGOTIATES |
Transparent Content Negotiation in HTTP 2295, Section 8.1 (Experimental) |
507 |
INSUFFICIENT_STORAGE |
WebDAV 4918, Section 11.5 |
508 |
LOOP_DETECTED |
WebDAV Binding Extensions 5842, Section 7.2 (Experimental) |
510 |
NOT_EXTENDED |
An HTTP Extension Framework 2774, Section 7 (Experimental) |
511 |
NETWORK_AUTHENTICATION_REQUIRED |
Additional HTTP Status Codes 6585, Section 6 |
In order to preserve backwards compatibility, enum values are also present in the http.client module in the form of constants. The enum name is equal to the constant name (i.e. http.HTTPStatus.OK is also available as http.client.OK).
3.7 Added 421 MISDIRECTED_REQUEST status code.
3.9 Added 103 EARLY_HINTS, 418 IM_A_TEAPOT and 425 TOO_EARLY status codes.
3.13 Implemented RFC9110 naming for status constants. Old constant names are preserved for backwards compatibility: 413 REQUEST_ENTITY_TOO_LARGE, 414 REQUEST_URI_TOO_LONG, 416 REQUESTED_RANGE_NOT_SATISFIABLE and 422 UNPROCESSABLE_ENTITY.
HTTP status category
3.12
The enum values have several properties to indicate the HTTP status category:
| Property | Indicates that | Details |
|---|---|---|
is_informational |
100 <= status <= 199 |
HTTP Semantics 9110, Section 15 |
is_success |
200 <= status <= 299 |
HTTP Semantics 9110, Section 15 |
is_redirection |
300 <= status <= 399 |
HTTP Semantics 9110, Section 15 |
is_client_error |
400 <= status <= 499 |
HTTP Semantics 9110, Section 15 |
is_server_error |
500 <= status <= 599 |
HTTP Semantics 9110, Section 15 |
Usage:
>>> from http import HTTPStatus >>> HTTPStatus.OK.is_success True >>> HTTPStatus.OK.is_client_error False
3.11
A subclass of enum.StrEnum that defines a set of HTTP methods and descriptions written in English.
Usage:
>>> from http import HTTPMethod
>>>
>>> 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 methods available in http.HTTPMethod are:
| Method | Enum Name | Details |
|---|---|---|
GET |
GET |
HTTP Semantics 9110, Section 9.3.1 |
HEAD |
HEAD |
HTTP Semantics 9110, Section 9.3.2 |
POST |
POST |
HTTP Semantics 9110, Section 9.3.3 |
PUT |
PUT |
HTTP Semantics 9110, Section 9.3.4 |
DELETE |
DELETE |
HTTP Semantics 9110, Section 9.3.5 |
CONNECT |
CONNECT |
HTTP Semantics 9110, Section 9.3.6 |
OPTIONS |
OPTIONS |
HTTP Semantics 9110, Section 9.3.7 |
TRACE |
TRACE |
HTTP Semantics 9110, Section 9.3.8 |
PATCH |
PATCH |
HTTP/1.1 5789 |