HttpRequest Kelas

Mewakili permintaan HTTP.

URL dapat diberikan tanpa parameter kueri, untuk ditambahkan nanti menggunakan "format_parameters".

Warisan

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

Diperlukan

Metode HTTP (GET, HEAD, dll.)

url

str

Diperlukan

Setidaknya skema/host/jalur lengkap

headers

dict[str,str]

nilai default: None

Header HTTP

files

dict[str, tuple[str, IO, str, dict]] atau dict[str, IO]

nilai default: None

Kamus 'name': file-like-objects (atau {'name': file-tuple}) untuk unggahan pengodean multipart. file-tuple dapat berupa 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') atau 4-tuple ('filename', fileobj, 'content_type', custom_headers), di mana 'content_type' adalah string yang menentukan jenis konten file yang diberikan dan custom_headers objek seperti dict yang berisi header tambahan untuk ditambahkan untuk file.

data

bytes atau dict (<xref:for form>)

nilai default: None

Tubuh yang akan dikirim.

Metode

format_parameters	Format parameter ke dalam string kueri yang valid. Diasumsikan semua parameter telah dikutip sebagai string URL yang valid.
prepare_multipart_body	Akan menyiapkan isi permintaan ini sesuai dengan informasi multipihak. Panggilan ini mengasumsikan kebijakan on_request telah diterapkan dalam konteks yang benar (sinkronisasi/asinkron) Tidak melakukan apa-apa jika "set_multipart_mixed" tidak pernah dipanggil.
serialize	Serialisasi permintaan ini menggunakan spesifikasi aplikasi/http.
set_bytes_body	Atur byte generik sebagai isi permintaan. Akan mengatur panjang konten.
set_formdata_body	Atur data yang dikodekan formulir sebagai isi permintaan.
set_json_body	Atur objek yang ramah JSON sebagai isi permintaan.
set_multipart_mixed	Atur bagian dari multipihak/campuran. Hanya arg yang didukung untuk saat ini adalah objek HttpRequest. batas bersifat opsional, dan satu akan dihasilkan jika Anda tidak menyediakannya. Perhatikan bahwa tidak ada verifikasi yang dilakukan pada batas, ini dianggap cukup lanjut sehingga Anda tahu cara menghormati RFC1341 7.2.1 dan memberikan batas yang benar. Setiap kwarg tambahan akan diteruskan ke dalam konteks alur untuk konfigurasi kebijakan per permintaan.
set_streamed_data_body	Mengatur isi data yang dapat dialirkan.
set_text_body	Atur teks sebagai isi permintaan.
set_xml_body	Atur pohon elemen XML sebagai isi permintaan.

format_parameters

Format parameter ke dalam string kueri yang valid. Diasumsikan semua parameter telah dikutip sebagai string URL yang valid.

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

Parameter

params

dict

Diperlukan

Kamus parameter.

prepare_multipart_body

Akan menyiapkan isi permintaan ini sesuai dengan informasi multipihak.

Panggilan ini mengasumsikan kebijakan on_request telah diterapkan dalam konteks yang benar (sinkronisasi/asinkron)

Tidak melakukan apa-apa jika "set_multipart_mixed" tidak pernah dipanggil.

prepare_multipart_body(content_index: int = 0) -> int

Parameter

content_index

int

nilai default: 0

Indeks bagian saat ini dalam pesan batch.

Mengembalikan

Indeks yang diperbarui setelah semua bagian dalam permintaan ini telah ditambahkan.

Tipe hasil

int

serialize

Serialisasi permintaan ini menggunakan spesifikasi aplikasi/http.

serialize() -> bytes

Mengembalikan

Permintaan yang diserialisasikan sebagai pesan tingkat rendah HTTP dalam byte.

Tipe hasil

bytes

set_bytes_body

Atur byte generik sebagai isi permintaan.

Akan mengatur panjang konten.

set_bytes_body(data: bytes) -> None

Parameter

data

bytes

Diperlukan

Data bidang permintaan.

set_formdata_body

Atur data yang dikodekan formulir sebagai isi permintaan.

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

Parameter

data

dict

nilai default: None

Data bidang permintaan.

set_json_body

Atur objek yang ramah JSON sebagai isi permintaan.

set_json_body(data: Any) -> None

Parameter

data

dict

Diperlukan

Objek yang dapat diserialisasikan JSON

set_multipart_mixed

Atur bagian dari multipihak/campuran.

Hanya arg yang didukung untuk saat ini adalah objek HttpRequest.

batas bersifat opsional, dan satu akan dihasilkan jika Anda tidak menyediakannya. Perhatikan bahwa tidak ada verifikasi yang dilakukan pada batas, ini dianggap cukup lanjut sehingga Anda tahu cara menghormati RFC1341 7.2.1 dan memberikan batas yang benar.

Setiap kwarg tambahan akan diteruskan ke dalam konteks alur untuk konfigurasi kebijakan per permintaan.

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

Parameter

requests

HttpRequest

Diperlukan

Permintaan untuk ditambahkan ke multipart/mixed

policies

list[SansIOHTTPPolicy]

SansIOPolicy untuk diterapkan pada waktu persiapan

boundary

str

Batas opsional

set_streamed_data_body

Mengatur isi data yang dapat dialirkan.

set_streamed_data_body(data: Any) -> None

Parameter

data

<xref:stream> atau <xref:generator> atau <xref:asyncgenerator>

Diperlukan

Data bidang permintaan.

set_text_body

Atur teks sebagai isi permintaan.

set_text_body(data: str) -> None

Parameter

data

str

Diperlukan

Teks yang akan dikirim sebagai isi.

set_xml_body

Atur pohon elemen XML sebagai isi permintaan.

set_xml_body(data: Any) -> None

Parameter

data

<xref:<xref:XML node>>

Diperlukan

Data bidang permintaan.

Atribut

body

Alias ke data.

Mengembalikan

Isi permintaan.

Tipe hasil

bytes,

str,

dict,

None

query

Parameter kueri permintaan sebagai dict.

Mengembalikan

Parameter kueri permintaan sebagai dict.

Tipe hasil

dict[str, str]