Partager via

HttpRequest Classe

  • Référence

Représente une requête HTTP.

L’URL peut être donnée sans paramètres de requête, à ajouter ultérieurement à l’aide de « format_parameters ».

Héritage
builtins.object
HttpRequest

Constructeur

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

Paramètres

method
str
Obligatoire

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

url
str
Obligatoire

Au moins terminer le schéma/l’hôte/le chemin d’accès

headers
dict[str,str]
valeur par défaut: None

En-têtes HTTP

files
dict[str, tuple[str, IO, str, dict]] ou dict[str, IO]
valeur par défaut: None

Dictionnaire de 'name': file-like-objects (ou {'name': file-tuple}) pour le chargement d’encodage en plusieurs parties. file-tuple peut être un 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') ou 4-tuple ('filename', fileobj, 'content_type', custom_headers), où 'content_type' est une chaîne définissant le type de contenu du fichier donné et custom_headers un objet de type dict contenant des en-têtes supplémentaires à ajouter pour le fichier.

data
bytes ou dict (<xref:for form>)
valeur par défaut: None

Corps à envoyer.

Méthodes

format_parameters

Mettez en forme les paramètres dans une chaîne de requête valide. Il est supposé que tous les paramètres ont déjà été cités en tant que chaînes d’URL valides.
prepare_multipart_body

Prépare le corps de cette demande en fonction des informations en plusieurs parties.

Cet appel suppose que les stratégies de on_request ont déjà été appliquées dans leur contexte correct (synchronisation/asynchrone)

Ne fait rien si « set_multipart_mixed » n’a jamais été appelé.
serialize

Sérialisez cette requête à l’aide de la spécification application/http.
set_bytes_body

Définissez des octets génériques comme corps de la requête.

Définit la longueur du contenu.
set_formdata_body

Définissez les données encodées sous forme comme corps de la requête.
set_json_body

Définissez un objet compatible JSON comme corps de la requête.
set_multipart_mixed

Définissez la partie d’un multipart/mixed.

Seuls les arguments pris en charge pour l’instant sont des objets HttpRequest.

la limite est facultative, et une limite est générée si vous ne fournissez pas. Notez qu’aucune vérification n’est effectuée sur la limite. Cela est considéré comme suffisamment avancé pour que vous sachiez comment respecter RFC1341 7.2.1 et fournir une limite correcte.

Tous les kwargs supplémentaires seront passés dans le contexte de pipeline pour la configuration de stratégie par demande.
set_streamed_data_body

Définissez un corps de données pouvant être diffusé en continu.
set_text_body

Définissez un texte comme corps de la demande.
set_xml_body

Définissez une arborescence d’éléments XML comme corps de la demande.

format_parameters

Mettez en forme les paramètres dans une chaîne de requête valide. Il est supposé que tous les paramètres ont déjà été cités en tant que chaînes d’URL valides.

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

Paramètres

params
dict
Obligatoire

Dictionnaire de paramètres.

prepare_multipart_body

Prépare le corps de cette demande en fonction des informations en plusieurs parties.

Cet appel suppose que les stratégies de on_request ont déjà été appliquées dans leur contexte correct (synchronisation/asynchrone)

Ne fait rien si « set_multipart_mixed » n’a jamais été appelé.

prepare_multipart_body(content_index: int = 0) -> int

Paramètres

content_index
int
valeur par défaut: 0

Index actuel des parties dans le message de lot.

Retours

Index mis à jour une fois que toutes les parties de cette requête ont été ajoutées.

Type de retour

int

serialize

Sérialisez cette requête à l’aide de la spécification application/http.

serialize() -> bytes

Retours

Les requêtes sérialisées en tant que message de bas niveau HTTP en octets.

Type de retour

bytes

set_bytes_body

Définissez des octets génériques comme corps de la requête.

Définit la longueur du contenu.

set_bytes_body(data: bytes) -> None

Paramètres

data
bytes
Obligatoire

Données de champ de requête.

set_formdata_body

Définissez les données encodées sous forme comme corps de la requête.

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

Paramètres

data
dict
valeur par défaut: None

Données de champ de requête.

set_json_body

Définissez un objet compatible JSON comme corps de la requête.

set_json_body(data: Any) -> None

Paramètres

data
dict
Obligatoire

Objet sérialisable JSON

set_multipart_mixed

Définissez la partie d’un multipart/mixed.

Seuls les arguments pris en charge pour l’instant sont des objets HttpRequest.

la limite est facultative, et une limite est générée si vous ne fournissez pas. Notez qu’aucune vérification n’est effectuée sur la limite. Cela est considéré comme suffisamment avancé pour que vous sachiez comment respecter RFC1341 7.2.1 et fournir une limite correcte.

Tous les kwargs supplémentaires seront passés dans le contexte de pipeline pour la configuration de stratégie par demande.

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

Paramètres

requests
HttpRequest
Obligatoire

Demandes à ajouter au multipart/mixte

policies
list[SansIOHTTPPolicy]

SansIOPolicy à appliquer au moment de la préparation

boundary
str

Limite facultative

set_streamed_data_body

Définissez un corps de données pouvant être diffusé en continu.

set_streamed_data_body(data: Any) -> None

Paramètres

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

Données de champ de requête.

set_text_body

Définissez un texte comme corps de la demande.

set_text_body(data: str) -> None

Paramètres

data
str
Obligatoire

Texte à envoyer sous forme de corps.

set_xml_body

Définissez une arborescence d’éléments XML comme corps de la demande.

set_xml_body(data: Any) -> None

Paramètres

data
<xref:<xref:XML node>>
Obligatoire

Données de champ de requête.

Attributs

body

Alias de données.

Retours

Corps de la demande.

Type de retour

bytes,
str,
dict,
None

query

Paramètres de requête de la requête en tant que dict.

Retours

Paramètres de requête de la requête en tant que dict.

Type de retour

dict[str, str]