Dela via

HttpRequest Klass

  • Referens

Representerar en HTTP-begäran.

URL kan anges utan frågeparametrar, som ska läggas till senare med hjälp av "format_parameters".

Arv
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)

Parametrar

method
str
Obligatorisk

HTTP-metod (GET, HEAD osv.)

url
str
Obligatorisk

Minst fullständigt schema/värd/sökväg

headers
dict[str,str]
standardvärde: None

HTTP-huvuden

files
dict[str, tuple[str, IO, str, dict]] eller dict[str, IO]
standardvärde: None

'name': file-like-objects Ordlista för (eller {'name': file-tuple}) för kodning av flera delar. file-tuple kan vara en 2-tuppeln ('filename', fileobj), 3-tuppeln ('filename', fileobj, 'content_type') eller en 4-tuppeln ('filename', fileobj, 'content_type', custom_headers), där är en sträng som 'content_type' definierar innehållstypen för den angivna filen och custom_headers ett dict-liknande objekt som innehåller ytterligare rubriker att lägga till för filen.

data
bytes eller dict (<xref:for form>)
standardvärde: None

Brödtext som ska skickas.

Metoder

format_parameters

Formatera parametrar till en giltig frågesträng. Det förutsätts att alla parametrar redan har citerats som giltiga URL-strängar.
prepare_multipart_body

Förbereder brödtexten i den här begäran enligt information om flera delar.

Det här anropet förutsätter att on_request principer redan har tillämpats i rätt kontext (synkronisering/asynkronisering)

Gör ingenting om "set_multipart_mixed" aldrig kallades.
serialize

Serialisera den här begäran med hjälp av program-/http-specifikationen.
set_bytes_body

Ange allmänna byte som brödtext i begäran.

Anger innehållslängd.
set_formdata_body

Ange formulärkodade data som brödtext i begäran.
set_json_body

Ange ett JSON-vänligt objekt som brödtext i begäran.
set_multipart_mixed

Ange delen av en multipart/blandad.

Endast args som stöds för tillfället är HttpRequest-objekt.

gränsen är valfri och en genereras om du inte anger någon. Observera att ingen verifiering görs på gränsen, detta anses vara tillräckligt avancerat så att du vet hur du ska respektera RFC1341 7.2.1 och tillhandahålla en korrekt gräns.

Eventuella ytterligare kwargs skickas till pipelinekontexten för principkonfiguration per begäran.
set_streamed_data_body

Ange en strömmande datatext.
set_text_body

Ange en text som brödtext i begäran.
set_xml_body

Ange ett XML-elementträd som brödtext i begäran.

format_parameters

Formatera parametrar till en giltig frågesträng. Det förutsätts att alla parametrar redan har citerats som giltiga URL-strängar.

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

Parametrar

params
dict
Obligatorisk

En ordlista med parametrar.

prepare_multipart_body

Förbereder brödtexten i den här begäran enligt information om flera delar.

Det här anropet förutsätter att on_request principer redan har tillämpats i rätt kontext (synkronisering/asynkronisering)

Gör ingenting om "set_multipart_mixed" aldrig kallades.

prepare_multipart_body(content_index: int = 0) -> int

Parametrar

content_index
int
standardvärde: 0

Det aktuella indexet för delar i batchmeddelandet.

Returer

Det uppdaterade indexet efter att alla delar i den här begäran har lagts till.

Returtyp

int

serialize

Serialisera den här begäran med hjälp av program-/http-specifikationen.

serialize() -> bytes

Returer

Begäranden serialiserades som HTTP-meddelande på låg nivå i byte.

Returtyp

bytes

set_bytes_body

Ange allmänna byte som brödtext i begäran.

Anger innehållslängd.

set_bytes_body(data: bytes) -> None

Parametrar

data
bytes
Obligatorisk

Data i begärandefältet.

set_formdata_body

Ange formulärkodade data som brödtext i begäran.

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

Parametrar

data
dict
standardvärde: None

Data i begärandefältet.

set_json_body

Ange ett JSON-vänligt objekt som brödtext i begäran.

set_json_body(data: Any) -> None

Parametrar

data
dict
Obligatorisk

Ett JSON-serialiserbart objekt

set_multipart_mixed

Ange delen av en multipart/blandad.

Endast args som stöds för tillfället är HttpRequest-objekt.

gränsen är valfri och en genereras om du inte anger någon. Observera att ingen verifiering görs på gränsen, detta anses vara tillräckligt avancerat så att du vet hur du ska respektera RFC1341 7.2.1 och tillhandahålla en korrekt gräns.

Eventuella ytterligare kwargs skickas till pipelinekontexten för principkonfiguration per begäran.

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

Parametrar

requests
HttpRequest
Obligatorisk

Begäranden att lägga till i multipart/mixed

policies
list[SansIOHTTPPolicy]

SansIOPolicy som ska tillämpas vid förberedelsetiden

boundary
str

Valfri gräns

set_streamed_data_body

Ange en strömmande datatext.

set_streamed_data_body(data: Any) -> None

Parametrar

data
<xref:stream> eller <xref:generator> eller <xref:asyncgenerator>
Obligatorisk

Data i begärandefältet.

set_text_body

Ange en text som brödtext i begäran.

set_text_body(data: str) -> None

Parametrar

data
str
Obligatorisk

En text som ska skickas som brödtext.

set_xml_body

Ange ett XML-elementträd som brödtext i begäran.

set_xml_body(data: Any) -> None

Parametrar

data
<xref:<xref:XML node>>
Obligatorisk

Data i begärandefältet.

Attribut

body

Alias för data.

Returer

Brödtexten i begäran.

Returtyp

bytes,
str,
dict,
None

query

Frågeparametrarna för begäran som en diktamen.

Returer

Frågeparametrarna för begäran som en diktamen.

Returtyp

dict[str, str]