Compartir a través de

HttpRequest Clase

  • Referencia

Representa una solicitud HTTP.

La dirección URL se puede proporcionar sin parámetros de consulta, que se agregarán más adelante mediante "format_parameters".

Herencia
builtins.object
HttpRequest

Constructor

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
Requerido

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

url
str
Requerido

Al menos el esquema completo, el host o la ruta de acceso

headers
dict[str,str]
valor predeterminado: None

Encabezados HTTP

files
dict[str, tuple[str, IO, str, dict]] o dict[str, IO]
valor predeterminado: None

Diccionario de 'name': file-like-objects (o {'name': file-tuple}) para la carga de codificación de varias partes. file-tuplepuede ser una tupla de 2, una tupla ('filename', fileobj)de 3 o una tupla ('filename', fileobj, 'content_type', custom_headers)('filename', fileobj, 'content_type') de 4, donde 'content_type' es una cadena que define el tipo de contenido del archivo especificado y custom_headers un objeto de tipo dict que contiene encabezados adicionales que se van a agregar para el archivo.

data
bytes o dict (<xref:for form>)
valor predeterminado: None

Cuerpo que se va a enviar.

Métodos

format_parameters

Dar formato a los parámetros en una cadena de consulta válida. Se supone que todos los parámetros ya se han citado como cadenas de dirección URL válidas.
prepare_multipart_body

Preparará el cuerpo de esta solicitud según la información de varias partes.

Esta llamada supone que las directivas de on_request ya se han aplicado en su contexto correcto (sincronización o asincronización).

No hace nada si nunca se llamó a "set_multipart_mixed".
serialize

Serialice esta solicitud mediante la especificación application/http.
set_bytes_body

Establezca bytes genéricos como el cuerpo de la solicitud.

Establecerá la longitud del contenido.
set_formdata_body

Establezca los datos codificados en formulario como el cuerpo de la solicitud.
set_json_body

Establezca un objeto descriptivo de JSON como el cuerpo de la solicitud.
set_multipart_mixed

Establezca la parte de una multipart/mixed.

Solo los argumentos admitidos por ahora son objetos HttpRequest.

el límite es opcional y se generará uno si no proporciona uno. Tenga en cuenta que no se realiza ninguna comprobación en el límite, esto se considera lo suficientemente avanzado como para que sepa cómo respetar RFC1341 7.2.1 y proporcionar un límite correcto.

Cualquier kwarg adicional se pasará al contexto de canalización para la configuración de directivas por solicitud.
set_streamed_data_body

Establezca un cuerpo de datos que se pueda transmitir.
set_text_body

Establezca un texto como cuerpo de la solicitud.
set_xml_body

Establezca un árbol de elementos XML como el cuerpo de la solicitud.

format_parameters

Dar formato a los parámetros en una cadena de consulta válida. Se supone que todos los parámetros ya se han citado como cadenas de dirección URL válidas.

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

Parámetros

params
dict
Requerido

Diccionario de parámetros.

prepare_multipart_body

Preparará el cuerpo de esta solicitud según la información de varias partes.

Esta llamada supone que las directivas de on_request ya se han aplicado en su contexto correcto (sincronización o asincronización).

No hace nada si nunca se llamó a "set_multipart_mixed".

prepare_multipart_body(content_index: int = 0) -> int

Parámetros

content_index
int
valor predeterminado: 0

Índice actual de partes dentro del mensaje por lotes.

Devoluciones

Índice actualizado después de que se hayan agregado todas las partes de esta solicitud.

Tipo de valor devuelto

int

serialize

Serialice esta solicitud mediante la especificación application/http.

serialize() -> bytes

Devoluciones

Las solicitudes serializadas como mensaje HTTP de bajo nivel en bytes.

Tipo de valor devuelto

bytes

set_bytes_body

Establezca bytes genéricos como el cuerpo de la solicitud.

Establecerá la longitud del contenido.

set_bytes_body(data: bytes) -> None

Parámetros

data
bytes
Requerido

Datos del campo de solicitud.

set_formdata_body

Establezca los datos codificados en formulario como el cuerpo de la solicitud.

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

Parámetros

data
dict
valor predeterminado: None

Datos del campo de solicitud.

set_json_body

Establezca un objeto descriptivo de JSON como el cuerpo de la solicitud.

set_json_body(data: Any) -> None

Parámetros

data
dict
Requerido

Un objeto serializable JSON

set_multipart_mixed

Establezca la parte de una multipart/mixed.

Solo los argumentos admitidos por ahora son objetos HttpRequest.

el límite es opcional y se generará uno si no proporciona uno. Tenga en cuenta que no se realiza ninguna comprobación en el límite, esto se considera lo suficientemente avanzado como para que sepa cómo respetar RFC1341 7.2.1 y proporcionar un límite correcto.

Cualquier kwarg adicional se pasará al contexto de canalización para la configuración de directivas por solicitud.

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

Parámetros

requests
HttpRequest
Requerido

Solicitudes que se van a agregar a la multipart/mixed

policies
list[SansIOHTTPPolicy]

SansIOPolicy que se va a aplicar en tiempo de preparación

boundary
str

Límite opcional

set_streamed_data_body

Establezca un cuerpo de datos que se pueda transmitir.

set_streamed_data_body(data: Any) -> None

Parámetros

data
<xref:stream> o <xref:generator> o <xref:asyncgenerator>
Requerido

Datos del campo de solicitud.

set_text_body

Establezca un texto como cuerpo de la solicitud.

set_text_body(data: str) -> None

Parámetros

data
str
Requerido

Texto que se va a enviar como cuerpo.

set_xml_body

Establezca un árbol de elementos XML como el cuerpo de la solicitud.

set_xml_body(data: Any) -> None

Parámetros

data
<xref:<xref:XML node>>
Requerido

Datos del campo de solicitud.

Atributos

body

Alias de los datos.

Devoluciones

Cuerpo de la solicitud.

Tipo de valor devuelto

bytes,
str,
dict,
None

query

Parámetros de consulta de la solicitud como dict.

Devoluciones

Parámetros de consulta de la solicitud como dict.

Tipo de valor devuelto

dict[str, str]