HttpRequest Klasse

  • Referenz

Stellt eine HTTP-Anforderung dar.

Die URL kann ohne Abfrageparameter angegeben werden, die später mithilfe von "format_parameters" hinzugefügt werden sollen.

Vererbung
builtins.object
HttpRequest

Konstruktor

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

Parameter

method
str
Erforderlich

HTTP-Methode (GET, HEAD usw.)

url
str
Erforderlich

Mindestens vollständiges Schema/Host/Pfad

headers
dict[str,str]
Standardwert: None

HTTP-Header

files
dict[str, tuple[str, IO, str, dict]] oder dict[str, IO]
Standardwert: None

Wörterbuch von 'name': file-like-objects (oder {'name': file-tuple}) für den Upload der mehrteiligen Codierung. file-tuple kann ein 2-Tupel ('filename', fileobj), ein 3-Tupel ('filename', fileobj, 'content_type') oder ein 4-Tupel ('filename', fileobj, 'content_type', custom_headers)sein. 'content_type' Dabei ist eine Zeichenfolge, die den Inhaltstyp der angegebenen Datei definiert, und custom_headers ein dict-ähnliches Objekt, das zusätzliche Header enthält, die für die Datei hinzugefügt werden sollen.

data
bytes oder dict (<xref:for form>)
Standardwert: None

Zu sendende Text.

Methoden

format_parameters

Formatieren von Parametern in eine gültige Abfragezeichenfolge. Es wird angenommen, dass alle Parameter bereits als gültige URL-Zeichenfolgen in Anführungszeichen gesetzt wurden.
prepare_multipart_body

Bereitet den Text dieser Anforderung gemäß den mehrteiligen Informationen vor.

Bei diesem Aufruf wird davon ausgegangen, dass die on_request Richtlinien bereits im richtigen Kontext (Synchronisierung/Asynchronität) angewendet wurden.

Tut nichts, wenn "set_multipart_mixed" nie aufgerufen wurde.
serialize

Serialisieren Sie diese Anforderung mithilfe der Anwendungs-/HTTP-Spezifikation.
set_bytes_body

Legen Sie generische Bytes als Text der Anforderung fest.

Legt die Inhaltslänge fest.
set_formdata_body

Legen Sie formularcodierte Daten als Textkörper der Anforderung fest.
set_json_body

Legen Sie ein JSON-freundliches Objekt als Text der Anforderung fest.
set_multipart_mixed

Legen Sie den Teil eines mehrteiligen/gemischten Werts fest.

Derzeit werden nur HttpRequest-Objekte unterstützt.

Die Grenze ist optional, und eine wird generiert, wenn Sie keine angeben. Beachten Sie, dass an der Grenze keine Überprüfung durchgeführt wird. Dies gilt als fortgeschritten genug, damit Sie wissen, wie RFC1341 7.2.1 eingehalten und eine richtige Grenze angegeben wird.

Alle zusätzlichen Kwargs werden für die Richtlinienkonfiguration pro Anforderung an den Pipelinekontext übergeben.
set_streamed_data_body

Legen Sie einen streambaren Datentext fest.
set_text_body

Legen Sie einen Text als Textkörper der Anforderung fest.
set_xml_body

Legen Sie eine XML-Elementstruktur als Textkörper der Anforderung fest.

format_parameters

Formatieren von Parametern in eine gültige Abfragezeichenfolge. Es wird angenommen, dass alle Parameter bereits als gültige URL-Zeichenfolgen in Anführungszeichen gesetzt wurden.

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

Parameter

params
dict
Erforderlich

Ein Wörterbuch mit Parametern.

prepare_multipart_body

Bereitet den Text dieser Anforderung gemäß den mehrteiligen Informationen vor.

Bei diesem Aufruf wird davon ausgegangen, dass die on_request Richtlinien bereits im richtigen Kontext (Synchronisierung/Asynchronität) angewendet wurden.

Tut nichts, wenn "set_multipart_mixed" nie aufgerufen wurde.

prepare_multipart_body(content_index: int = 0) -> int

Parameter

content_index
int
Standardwert: 0

Der aktuelle Index der Teile innerhalb der Batchnachricht.

Gibt zurück

Der aktualisierte Index, nachdem alle Teile in dieser Anforderung hinzugefügt wurden.

Rückgabetyp

int

serialize

Serialisieren Sie diese Anforderung mithilfe der Anwendungs-/HTTP-Spezifikation.

serialize() -> bytes

Gibt zurück

Die Anforderungen, die als HTTP-Nachricht auf niedriger Ebene in Bytes serialisiert werden.

Rückgabetyp

bytes

set_bytes_body

Legen Sie generische Bytes als Text der Anforderung fest.

Legt die Inhaltslänge fest.

set_bytes_body(data: bytes) -> None

Parameter

data
bytes
Erforderlich

Die Daten des Anforderungsfelds.

set_formdata_body

Legen Sie formularcodierte Daten als Textkörper der Anforderung fest.

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

Parameter

data
dict
Standardwert: None

Die Daten des Anforderungsfelds.

set_json_body

Legen Sie ein JSON-freundliches Objekt als Text der Anforderung fest.

set_json_body(data: Any) -> None

Parameter

data
dict
Erforderlich

Ein serialisierbares JSON-Objekt

set_multipart_mixed

Legen Sie den Teil eines mehrteiligen/gemischten Werts fest.

Derzeit werden nur HttpRequest-Objekte unterstützt.

Die Grenze ist optional, und eine wird generiert, wenn Sie keine angeben. Beachten Sie, dass an der Grenze keine Überprüfung durchgeführt wird. Dies gilt als fortgeschritten genug, damit Sie wissen, wie RFC1341 7.2.1 eingehalten und eine richtige Grenze angegeben wird.

Alle zusätzlichen Kwargs werden für die Richtlinienkonfiguration pro Anforderung an den Pipelinekontext übergeben.

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

Parameter

requests
HttpRequest
Erforderlich

Die Anforderungen, die dem mehrteiligen/gemischten Element hinzugefügt werden sollen

policies
list[SansIOHTTPPolicy]

SansIOPolicy, die zur Vorbereitungszeit angewendet werden soll

boundary
str

Optionale Grenze

set_streamed_data_body

Legen Sie einen streambaren Datentext fest.

set_streamed_data_body(data: Any) -> None

Parameter

data
<xref:stream> oder <xref:generator> oder <xref:asyncgenerator>
Erforderlich

Die Daten des Anforderungsfelds.

set_text_body

Legen Sie einen Text als Textkörper der Anforderung fest.

set_text_body(data: str) -> None

Parameter

data
str
Erforderlich

Ein Text, der als Text gesendet werden soll.

set_xml_body

Legen Sie eine XML-Elementstruktur als Textkörper der Anforderung fest.

set_xml_body(data: Any) -> None

Parameter

data
<xref:<xref:XML node>>
Erforderlich

Die Daten des Anforderungsfelds.

Attribute

body

Alias für Daten.

Gibt zurück

Der Text der Anforderung.

Rückgabetyp

bytes,
str,
dict,
None

query

Die Abfrageparameter der Anforderung als Diktat.

Gibt zurück

Die Abfrageparameter der Anforderung als Diktat.

Rückgabetyp

dict[str, str]