Share via

HttpRequest Classe

  • Referência

Representa uma solicitação HTTP.

A URL pode ser fornecida sem parâmetros de consulta, a ser adicionada posteriormente usando "format_parameters".

Herança
builtins.object
HttpRequest

Construtor

HttpRequest(method: str, url: str, headers: Mapping[str, str] | None = None, files: Any | None = None, data: bytes | str | Dict[str, str | int] | None = None)

Parâmetros

method
str
Obrigatório

Método HTTP (GET, HEAD etc.)

url
str
Obrigatório

Pelo menos o esquema/host/caminho completo

headers
dict[str,str]
valor padrão: None

Cabeçalhos HTTP

files
dict[str, tuple[str, IO, str, dict]] ou dict[str, IO]
valor padrão: None

Dicionário de 'name': file-like-objects (ou {'name': file-tuple}) para upload de codificação de várias partes. file-tuple pode ser uma tupla de 2 tuplas ('filename', fileobj), 3 tuplas ('filename', fileobj, 'content_type') ou 4 tuplas ('filename', fileobj, 'content_type', custom_headers), em 'content_type' que é uma cadeia de caracteres que define o tipo de conteúdo do arquivo fornecido e custom_headers um objeto semelhante a um ditado que contém cabeçalhos adicionais a serem adicionados para o arquivo.

data
bytes ou dict (<xref:for form>)
valor padrão: None

Corpo a ser enviado.

Métodos

format_parameters

Formatar parâmetros em uma cadeia de caracteres de consulta válida. Supõe-se que todos os parâmetros já foram citados como cadeias de caracteres de URL válidas.
prepare_multipart_body

Preparará o corpo dessa solicitação de acordo com as informações de várias partes.

Essa chamada pressupõe que as políticas de on_request já tenham sido aplicadas em seu contexto correto (sincronização/assíncrono)

Não faz nada se "set_multipart_mixed" nunca foi chamado.
serialize

Serialize essa solicitação usando especificação de aplicativo/http.
set_bytes_body

Defina bytes genéricos como o corpo da solicitação.

Definirá o comprimento do conteúdo.
set_formdata_body

Defina dados codificados em formulário como o corpo da solicitação.
set_json_body

Defina um objeto JSON amigável como o corpo da solicitação.
set_multipart_mixed

Defina a parte de uma multipart/mixed.

Somente os args com suporte por enquanto são objetos HttpRequest.

O limite é opcional e um será gerado se você não fornecer um. Observe que nenhuma verificação é feita no limite, isso é considerado avançado o suficiente para que você saiba como respeitar RFC1341 7.2.1 e fornecer um limite correto.

Quaisquer kwargs adicionais serão passados para o contexto de pipeline para configuração de política por solicitação.
set_streamed_data_body

Defina um corpo de dados que pode ser transmitido.
set_text_body

Defina um texto como corpo da solicitação.
set_xml_body

Defina uma árvore de elementos XML como o corpo da solicitação.

format_parameters

Formatar parâmetros em uma cadeia de caracteres de consulta válida. Supõe-se que todos os parâmetros já foram citados como cadeias de caracteres de URL válidas.

format_parameters(params: Dict[str, str]) -> None

Parâmetros

params
dict
Obrigatório

Um dicionário de parâmetros.

prepare_multipart_body

Preparará o corpo dessa solicitação de acordo com as informações de várias partes.

Essa chamada pressupõe que as políticas de on_request já tenham sido aplicadas em seu contexto correto (sincronização/assíncrono)

Não faz nada se "set_multipart_mixed" nunca foi chamado.

prepare_multipart_body(content_index: int = 0) -> int

Parâmetros

content_index
int
valor padrão: 0

O índice atual de partes dentro da mensagem em lote.

Retornos

O índice atualizado depois que todas as partes nesta solicitação tiverem sido adicionadas.

Tipo de retorno

int

serialize

Serialize essa solicitação usando especificação de aplicativo/http.

serialize() -> bytes

Retornos

As solicitações serializadas como mensagem http de baixo nível em bytes.

Tipo de retorno

bytes

set_bytes_body

Defina bytes genéricos como o corpo da solicitação.

Definirá o comprimento do conteúdo.

set_bytes_body(data: bytes) -> None

Parâmetros

data
bytes
Obrigatório

Os dados do campo de solicitação.

set_formdata_body

Defina dados codificados em formulário como o corpo da solicitação.

set_formdata_body(data: Dict[str, str] | None = None) -> None

Parâmetros

data
dict
valor padrão: None

Os dados do campo de solicitação.

set_json_body

Defina um objeto JSON amigável como o corpo da solicitação.

set_json_body(data: Any) -> None

Parâmetros

data
dict
Obrigatório

Um objeto serializável JSON

set_multipart_mixed

Defina a parte de uma multipart/mixed.

Somente os args com suporte por enquanto são objetos HttpRequest.

O limite é opcional e um será gerado se você não fornecer um. Observe que nenhuma verificação é feita no limite, isso é considerado avançado o suficiente para que você saiba como respeitar RFC1341 7.2.1 e fornecer um limite correto.

Quaisquer kwargs adicionais serão passados para o contexto de pipeline para configuração de política por solicitação.

set_multipart_mixed(*requests: HttpRequest, policies: List[SansIOHTTPPolicy[HTTPRequestType, HTTPResponseType]] | None = None, boundary: str | None = None, **kwargs: Any) -> None

Parâmetros

requests
HttpRequest
Obrigatório

As solicitações a serem adicionadas à multipart/mixed

policies
list[SansIOHTTPPolicy]

SansIOPolicy para aplicar em tempo de preparação

boundary
str

Limite opcional

set_streamed_data_body

Defina um corpo de dados que pode ser transmitido.

set_streamed_data_body(data: Any) -> None

Parâmetros

data
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
Obrigatório

Os dados do campo de solicitação.

set_text_body

Defina um texto como corpo da solicitação.

set_text_body(data: str) -> None

Parâmetros

data
str
Obrigatório

Um texto a ser enviado como corpo.

set_xml_body

Defina uma árvore de elementos XML como o corpo da solicitação.

set_xml_body(data: Any) -> None

Parâmetros

data
<xref:<xref:XML node>>
Obrigatório

Os dados do campo de solicitação.

Atributos

body

Alias aos dados.

Retornos

O corpo da solicitação.

Tipo de retorno

bytes,
str,
dict,
None

query

Os parâmetros de consulta da solicitação como um dict.

Retornos

Os parâmetros de consulta da solicitação como um dict.

Tipo de retorno

dict[str, str]