http — módulos HTTP

Código-fonte: Lib/http/__init__.py


http é um pacote que coleta vários módulos para trabalhar com o Protocolo de Transferência de Hipertexto:

O módulo http também define os seguintes enums que podem ajudar você a trabalhar com os status code http relacionados:

class http.HTTPStatus

Adicionado na versão 3.5.

Subclasse de enum.IntEnum que define um conjunto de códigos de status HTTP, frases de razão e descrições longas escritas em inglês.

Uso:

>>> 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, ...]

códigos de status HTTP

Suportados, códigos de status registrados no IANA disponíveis em http.HTTPStatus são:

Código

Nome da Enumeração

Detalhes

100

CONTINUE

HTTP Semantics RFC 9110, seção 15.2.1

101

SWITCHING_PROTOCOLS

HTTP Semantics RFC 9110, seção 15.2.2

102

PROCESSING

WebDAV RFC 2518, Seção 10.1

103

EARLY_HINTS

Um código de status HTTP para indicar dicas RFC 8297

200

OK

HTTP Semantics RFC 9110, seção 15.3.1

201

CREATED

HTTP Semantics RFC 9110, seção 15.3.2

202

ACCEPTED

HTTP Semantics RFC 9110, seção 15.3.3

203

NON_AUTHORITATIVE_INFORMATION

HTTP Semantics RFC 9110, seção 15.3.4

204

NO_CONTENT

HTTP Semantics RFC 9110, seção 15.3.5

205

RESET_CONTENT

HTTP Semantics RFC 9110, seção 15.3.6

206

PARTIAL_CONTENT

HTTP Semantics RFC 9110, seção 15.3.7

207

MULTI_STATUS

WebDAV RFC 4918, Seção 11.1

208

ALREADY_REPORTED

Extensões Vinculadas WebDAV RFC 5842, Seção 7.1 (Experimental)

226

IM_USED

Codificador Delta em HTTP RFC 3229, Seção 10.4.1

300

MULTIPLE_CHOICES

HTTP Semantics RFC 9110, seção 15.4.1

301

MOVED_PERMANENTLY

HTTP Semantics RFC 9110, seção 15.4.2

302

FOUND

HTTP Semantics RFC 9110, seção 15.4.3

303

SEE_OTHER

HTTP Semantics RFC 9110, seção 15.4.4

304

NOT_MODIFIED

HTTP Semantics RFC 9110, seção 15.4.5

305

USE_PROXY

HTTP Semantics RFC 9110, seção 15.4.6

307

TEMPORARY_REDIRECT

HTTP Semantics RFC 9110, seção 15.4.8

308

PERMANENT_REDIRECT

HTTP Semantics RFC 9110, seção 15.4.9

400

BAD_REQUEST

HTTP Semantics RFC 9110, seção 15.5.1

401

UNAUTHORIZED

HTTP Semantics RFC 9110, seção 15.5.2

402

PAYMENT_REQUIRED

HTTP Semantics RFC 9110, seção 15.5.3

403

FORBIDDEN

HTTP Semantics RFC 9110, seção 15.5.4

404

NOT_FOUND

HTTP Semantics RFC 9110, seção 15.5.5

405

METHOD_NOT_ALLOWED

HTTP Semantics RFC 9110, seção 15.5.6

406

NOT_ACCEPTABLE

HTTP Semantics RFC 9110, seção 15.5.7

407

PROXY_AUTHENTICATION_REQUIRED

HTTP Semantics RFC 9110, seção 15.5.8

408

REQUEST_TIMEOUT

HTTP Semantics RFC 9110, seção 15.5.9

409

CONFLICT

HTTP Semantics RFC 9110, seção 15.5.10

410

GONE

HTTP Semantics RFC 9110, seção 15.5.11

411

LENGTH_REQUIRED

HTTP Semantics RFC 9110, seção 15.5.12

412

PRECONDITION_FAILED

HTTP Semantics RFC 9110, seção 15.5.13

413

CONTENT_TOO_LARGE

HTTP Semantics RFC 9110, seção 15.5.14

414

URI_TOO_LONG

HTTP Semantics RFC 9110, seção 15.5.15

415

UNSUPPORTED_MEDIA_TYPE

HTTP Semantics RFC 9110, seção 15.5.16

416

RANGE_NOT_SATISFIABLE

HTTP Semantics RFC 9110, seção 15.5.17

417

EXPECTATION_FAILED

HTTP Semantics RFC 9110, seção 15.5.18

418

IM_A_TEAPOT

HTCPCP/1.0 RFC 2324, Seção 2.3.2

421

MISDIRECTED_REQUEST

HTTP Semantics RFC 9110, seção 15.5.20

422

UNPROCESSABLE_CONTENT

HTTP Semantics RFC 9110, seção 15.5.21

423

LOCKED

WebDAV RFC 4918, Seção 11.3

424

FAILED_DEPENDENCY

WebDAV RFC 4918, Seção 11.4

425

TOO_EARLY

Usando dados antecipados em HTTP RFC 8470

426

UPGRADE_REQUIRED

HTTP Semantics RFC 9110, seção 15.5.22

428

PRECONDITION_REQUIRED

Códigos de Status HTTP Adicionais RFC 6585

429

TOO_MANY_REQUESTS

Códigos de Status HTTP Adicionais RFC 6585

431

REQUEST_HEADER_FIELDS_TOO_LARGE

Códigos de Status HTTP Adicionais RFC 6585

451

UNAVAILABLE_FOR_LEGAL_REASONS

Um Código de Status HTTP para Relatar Obstáculos Legais RFC 7725

500

INTERNAL_SERVER_ERROR

HTTP Semantics RFC 9110, seção 15.6.1

501

NOT_IMPLEMENTED

HTTP Semantics RFC 9110, seção 15.6.2

502

BAD_GATEWAY

HTTP Semantics RFC 9110, seção 15.6.3

503

SERVICE_UNAVAILABLE

HTTP Semantics RFC 9110, seção 15.6.4

504

GATEWAY_TIMEOUT

HTTP Semantics RFC 9110, seção 15.6.5

505

HTTP_VERSION_NOT_SUPPORTED

HTTP Semantics RFC 9110, seção 15.6.6

506

VARIANT_ALSO_NEGOTIATES

Negociação Transparente de Conteúdo em HTTP RFC 2295, Seção 8.1 (Experimental)

507

INSUFFICIENT_STORAGE

WebDAV RFC 4918, Seção 11.5

508

LOOP_DETECTED

Extensões de Ligação WebDAV RFC 5842, Seção 7.2 (Experimental)

510

NOT_EXTENDED

Um Framework de Extensão HTTP RFC 2774, Seção 7 (Experimental)

511

NETWORK_AUTHENTICATION_REQUIRED

Códigos de Status HTTP Adicionais RFC 6585, Seção 6

Para preservar compatibilidade anterior, valores de enumerações também estão presentes no módulo http.client na forma de constantes. O nome da enumeração é igual ao nome da constante (i.e. http.HTTPStatus.OK também está disponível como http.client.OK).

Alterado na versão 3.7: Código de status 421 MISDIRECTED_REQUEST adicionado.

Adicionado na versão 3.8: Código de status 451 UNAVAILABLE_FOR_LEGAL_REASONS adicionado.

Adicionado na versão 3.9: Adicionados os códigos de status 103 EARLY_HINTS, 418 IM_A_TEAPOT e 425 TOO_EARLY.

Alterado na versão 3.13: Implementada a nomenclatura do RFC9110 para constantes de status. Os nomes antigos das constantes foram preservados para compatibilidade com versões anteriores: 413 REQUEST_ENTITY_TOO_LARGE, 414 REQUEST_URI_TOO_LONG, 416 REQUESTED_RANGE_NOT_SATISFIABLE e 422 UNPROCESSABLE_ENTITY.

Categorias de HTTP status

Adicionado na versão 3.12.

Os valores enum possuem várias propriedades que indicam a categoria do status HTTP.

Propriedade

Indica que

Detalhes

is_informational

100 <= status <= 199

HTTP Semantics RFC 9110, seção 15

is_success

200 <= status <= 299

HTTP Semantics RFC 9110, seção 15

is_redirection

300 <= status <= 399

HTTP Semantics RFC 9110, seção 15

is_client_error

400 <= status <= 499

HTTP Semantics RFC 9110, seção 15

is_server_error

500 <= status <= 599

HTTP Semantics RFC 9110, seção 15

Uso:

>>> from http import HTTPStatus
>>> HTTPStatus.OK.is_success
True
>>> HTTPStatus.OK.is_client_error
False
class http.HTTPMethod

Adicionado na versão 3.11.

Subclasse de enum.StrEnum que define um conjunto de métodos HTTP e descrições escritas em inglês.

Uso:

>>> 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>]

Métodos HTTP

Suportados, métodos registrados no IANA disponíveis em http.HTTPMethod são:

Método

Nome da Enumeração

Detalhes

GET

GET

HTTP Semantics RFC 9110, seção 9.3.1

HEAD

HEAD

HTTP Semantics RFC 9110, seção 9.3.2

POST

POST

HTTP Semantics RFC 9110, seção 9.3.3

PUT

PUT

HTTP Semantics RFC 9110, seção 9.3.4

DELETE

DELETE

HTTP Semantics RFC 9110, seção 9.3.5

CONNECT

CONNECT

HTTP Semantics RFC 9110, seção 9.3.6

OPTIONS

OPTIONS

HTTP Semantics RFC 9110, seção 9.3.7

TRACE

TRACE

HTTP Semantics RFC 9110, seção 9.3.8

PATCH

PATCH

HTTP/1.1 RFC 5789