HttpRequest Klasa

Reprezentuje żądanie HTTP.

Adres URL można podać bez parametrów zapytania, który można dodać później przy użyciu polecenia "format_parameters".

Dziedziczenie

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)

Parametry

method

str

Wymagane

Metoda HTTP (GET, HEAD itp.)

url

str

Wymagane

Co najmniej kompletny schemat/host/ścieżka

headers

dict[str,str]

wartość domyślna: None

Nagłówki HTTP

files

dict[str, tuple[str, IO, str, dict]] lub dict[str, IO]

wartość domyślna: None

Słownik ( 'name': file-like-objects lub {'name': file-tuple}) dla przekazywania kodowania wieloczęściowego. file-tuple może to być krotka ('filename', fileobj)2-krotka, 3-krotka lub krotka ('filename', fileobj, 'content_type') 4-krotka ('filename', fileobj, 'content_type', custom_headers), gdzie 'content_type' jest ciągiem definiującym typ zawartości danego pliku i custom_headers obiekt przypominający dykt zawierający dodatkowe nagłówki do dodania dla pliku.

data

bytes lub dict (<xref:for form>)

wartość domyślna: None

Treść do wysłania.

Metody

format_parameters	Formatuj parametry w prawidłowy ciąg zapytania. Zakłada się, że wszystkie parametry zostały już cytowane jako prawidłowe ciągi adresu URL.
prepare_multipart_body	Przygotuje treść tego żądania zgodnie z informacjami wieloczęściowym. To wywołanie zakłada, że zasady on_request zostały już zastosowane w poprawnym kontekście (synchronizacja/asynchronizacja) Nic nie robi, jeśli "set_multipart_mixed" nigdy nie został wywołany.
serialize	Serializuj to żądanie przy użyciu specyfikacji aplikacji/http.
set_bytes_body	Ustaw bajty ogólne jako treść żądania. Ustawi długość zawartości.
set_formdata_body	Ustaw zakodowane w formularzu dane jako treść żądania.
set_json_body	Ustaw obiekt przyjazny dla formatu JSON jako treść żądania.
set_multipart_mixed	Ustaw część wieloczęściowej/mieszanej. Obecnie są obsługiwane tylko args to obiekty HttpRequest. granica jest opcjonalna, a jedna zostanie wygenerowana, jeśli jej nie podasz. Należy pamiętać, że nie dokonano weryfikacji na granicy, jest to uważane za wystarczająco zaawansowane, więc wiesz, jak przestrzegać RFC1341 7.2.1 i zapewnić prawidłową granicę. Wszelkie dodatkowe kwargs zostaną przekazane do kontekstu potoku dla konfiguracji zasad dla poszczególnych żądań.
set_streamed_data_body	Ustaw strumieniową treść danych.
set_text_body	Ustaw tekst jako treść żądania.
set_xml_body	Ustaw drzewo elementów XML jako treść żądania.

format_parameters

Formatuj parametry w prawidłowy ciąg zapytania. Zakłada się, że wszystkie parametry zostały już cytowane jako prawidłowe ciągi adresu URL.

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

Parametry

params

dict

Wymagane

Słownik parametrów.

prepare_multipart_body

Przygotuje treść tego żądania zgodnie z informacjami wieloczęściowym.

To wywołanie zakłada, że zasady on_request zostały już zastosowane w poprawnym kontekście (synchronizacja/asynchronizacja)

Nic nie robi, jeśli "set_multipart_mixed" nigdy nie został wywołany.

prepare_multipart_body(content_index: int = 0) -> int

Parametry

content_index

int

wartość domyślna: 0

Bieżący indeks części w wiadomości wsadowej.

Zwraca

Zaktualizowany indeks po dodaniu wszystkich części tego żądania.

Typ zwracany

int

serialize

Serializuj to żądanie przy użyciu specyfikacji aplikacji/http.

serialize() -> bytes

Zwraca

Żądania serializowane jako komunikat niskiego poziomu HTTP w bajtach.

Typ zwracany

bytes

set_bytes_body

Ustaw bajty ogólne jako treść żądania.

Ustawi długość zawartości.

set_bytes_body(data: bytes) -> None

Parametry

data

bytes

Wymagane

Dane pola żądania.

set_formdata_body

Ustaw zakodowane w formularzu dane jako treść żądania.

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

Parametry

data

dict

wartość domyślna: None

Dane pola żądania.

set_json_body

Ustaw obiekt przyjazny dla formatu JSON jako treść żądania.

set_json_body(data: Any) -> None

Parametry

data

dict

Wymagane

Obiekt możliwy do serializacji w formacie JSON

set_multipart_mixed

Ustaw część wieloczęściowej/mieszanej.

Obecnie są obsługiwane tylko args to obiekty HttpRequest.

granica jest opcjonalna, a jedna zostanie wygenerowana, jeśli jej nie podasz. Należy pamiętać, że nie dokonano weryfikacji na granicy, jest to uważane za wystarczająco zaawansowane, więc wiesz, jak przestrzegać RFC1341 7.2.1 i zapewnić prawidłową granicę.

Wszelkie dodatkowe kwargs zostaną przekazane do kontekstu potoku dla konfiguracji zasad dla poszczególnych żądań.

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

Parametry

requests

HttpRequest

Wymagane

Żądania dodania do wielu części/mieszanych

policies

list[SansIOHTTPPolicy]

SansIOPolicy do zastosowania w czasie przygotowania

boundary

str

Opcjonalna granica

set_streamed_data_body

Ustaw strumieniową treść danych.

set_streamed_data_body(data: Any) -> None

Parametry

data

<xref:stream> lub <xref:generator> lub <xref:asyncgenerator>

Wymagane

Dane pola żądania.

set_text_body

Ustaw tekst jako treść żądania.

set_text_body(data: str) -> None

Parametry

data

str

Wymagane

Tekst do wysłania jako treść.

set_xml_body

Ustaw drzewo elementów XML jako treść żądania.

set_xml_body(data: Any) -> None

Parametry

data

<xref:<xref:XML node>>

Wymagane

Dane pola żądania.

Atrybuty

body

Alias danych.

Zwraca

Treść żądania.

Typ zwracany

bytes,

str,

dict,

None

query

Parametry zapytania żądania jako dykt.

Zwraca

Parametry zapytania żądania jako dykt.

Typ zwracany

dict[str, str]