HttpRequest Classe

Representa um pedido HTTP.

O URL pode ser fornecido sem parâmetros de consulta, para ser adicionado mais tarde com "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

Necessário

Método HTTP (GET, HEAD, etc.)

url

str

Necessário

Pelo menos, concluir o esquema/anfitrião/caminho

headers

dict[str,str]

valor predefinido: None

Cabeçalhos HTTP

files

dict[str, tuple[str, IO, str, dict]] ou dict[str, IO]

valor predefinido: None

Dicionário de 'name': file-like-objects (ou {'name': file-tuple}) para carregamento de codificação multipart. file-tuple pode ser uma cadeia de identificação de 2 cadeias ('filename', fileobj)de identificação, uma cadeia de ('filename', fileobj, 'content_type') identificação de 3 cadeias de identificação ou uma cadeia de ('filename', fileobj, 'content_type', custom_headers)identificação, em 'content_type' que é uma cadeia que define o tipo de conteúdo do ficheiro especificado e custom_headers um objeto semelhante a um ditado que contém cabeçalhos adicionais para adicionar ao ficheiro.

data

bytes ou dict (<xref:for form>)

valor predefinido: None

Corpo a ser enviado.

Métodos

format_parameters	Formatar parâmetros numa cadeia de consulta válida. Presume-se que todos os parâmetros já foram citados como cadeias de URL válidas.
prepare_multipart_body	Preparará o corpo deste pedido de acordo com as informações de várias partes. Esta chamada pressupõe que as políticas de on_request já foram aplicadas no contexto correto (sincronização/assíncrona) Não faz nada se "set_multipart_mixed" nunca foi chamado.
serialize	Serialize este pedido com a especificação de aplicação/http.
set_bytes_body	Defina bytes genéricos como o corpo do pedido. Definirá o comprimento do conteúdo.
set_formdata_body	Defina dados codificados por formulários como o corpo do pedido.
set_json_body	Defina um objeto compatível com JSON como o corpo do pedido.
set_multipart_mixed	Defina a parte de uma multipart/mixed. Por agora, apenas os args suportados são objetos HttpRequest. O limite é opcional e será gerado um se não fornecer um. Tenha em atenção que não é efetuada nenhuma verificação no limite. Isto é considerado avançado o suficiente para que saiba como respeitar RFC1341 7.2.1 e fornecer um limite correto. Quaisquer kwargs adicionais serão transmitidos para o contexto do pipeline para a configuração da política por pedido.
set_streamed_data_body	Definir um corpo de dados passível de transmissão em fluxo.
set_text_body	Defina um texto como o corpo do pedido.
set_xml_body	Defina uma árvore de elementos XML como o corpo do pedido.

format_parameters

Formatar parâmetros numa cadeia de consulta válida. Presume-se que todos os parâmetros já foram citados como cadeias de URL válidas.

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

Parâmetros

params

dict

Necessário

Um dicionário de parâmetros.

prepare_multipart_body

Preparará o corpo deste pedido de acordo com as informações de várias partes.

Esta chamada pressupõe que as políticas de on_request já foram aplicadas no contexto correto (sincronização/assíncrona)

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 predefinido: 0

O índice atual de partes na mensagem de lote.

Devoluções

O índice atualizado depois de todas as partes deste pedido terem sido adicionadas.

Tipo de retorno

int

serialize

Serialize este pedido com a especificação de aplicação/http.

serialize() -> bytes

Devoluções

Os pedidos são serializados como http mensagem de baixo nível em bytes.

Tipo de retorno

bytes

set_bytes_body

Defina bytes genéricos como o corpo do pedido.

Definirá o comprimento do conteúdo.

set_bytes_body(data: bytes) -> None

Parâmetros

data

bytes

Necessário

Os dados do campo do pedido.

set_formdata_body

Defina dados codificados por formulários como o corpo do pedido.

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

Parâmetros

data

dict

valor predefinido: None

Os dados do campo do pedido.

set_json_body

Defina um objeto compatível com JSON como o corpo do pedido.

set_json_body(data: Any) -> None

Parâmetros

data

dict

Necessário

Um objeto serializável JSON

set_multipart_mixed

Defina a parte de uma multipart/mixed.

Por agora, apenas os args suportados são objetos HttpRequest.

O limite é opcional e será gerado um se não fornecer um. Tenha em atenção que não é efetuada nenhuma verificação no limite. Isto é considerado avançado o suficiente para que saiba como respeitar RFC1341 7.2.1 e fornecer um limite correto.

Quaisquer kwargs adicionais serão transmitidos para o contexto do pipeline para a configuração da política por pedido.

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

Parâmetros

requests

HttpRequest

Necessário

Os pedidos para adicionar à multipart/mixed

policies

list[SansIOHTTPPolicy]

SansIOPolicy a aplicar no momento da preparação

boundary

str

Limite opcional

set_streamed_data_body

Definir um corpo de dados passível de transmissão em fluxo.

set_streamed_data_body(data: Any) -> None

Parâmetros

data

<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>

Necessário

Os dados do campo do pedido.

set_text_body

Defina um texto como o corpo do pedido.

set_text_body(data: str) -> None

Parâmetros

data

str

Necessário

Uma mensagem sms para enviar como corpo.

set_xml_body

Defina uma árvore de elementos XML como o corpo do pedido.

set_xml_body(data: Any) -> None

Parâmetros

data

<xref:<xref:XML node>>

Necessário

Os dados do campo do pedido.

Atributos

body

Alias a dados.

Devoluções

O corpo do pedido.

Tipo de retorno

bytes,

str,

dict,

None

query

Os parâmetros de consulta do pedido como um ditado.

Devoluções

Os parâmetros de consulta do pedido como um ditado.

Tipo de retorno

dict[str, str]