AsyncHttpResponse Classe

  • Référence

An AsyncHttpResponse ABC.

Permet la diffusion en continu asynchrone des données à partir de la réponse.

Héritage
azure.core.pipeline.transport._base._HttpResponseBase
AsyncHttpResponse
AbstractAsyncContextManager
AsyncHttpResponse
Generic
AsyncHttpResponse

Constructeur

AsyncHttpResponse(request: HttpRequest, internal_response: Any, block_size: int | None = None)

Paramètres

request
internal_response
block_size
valeur par défaut: None

Méthodes

body

Retourne le corps entier sous forme d’octets en mémoire.

L’implémenteur de synchronisation doit charger le corps en mémoire s’il le peut. L’implémenteur asynchrone doit s’appuyer sur des load_body asynchrones à avoir été appelées en premier.
parts

En supposant que le type de contenu est multiparte/mixte, retourne les parties en tant qu’itérateur asynchrone.
raise_for_status

Déclenche une erreur HttpResponseError si la réponse comporte une erreur status code. Si la réponse est bonne, ne fait rien.
stream_download

Générateur pour la diffusion en continu des données du corps de la réponse.

Doit être implémenté par les sous-classes si le téléchargement en streaming est pris en charge. Retourne un générateur asynchrone.
text

Retourne le corps entier sous forme de chaîne.

body

Retourne le corps entier sous forme d’octets en mémoire.

L’implémenteur de synchronisation doit charger le corps en mémoire s’il le peut. L’implémenteur asynchrone doit s’appuyer sur des load_body asynchrones à avoir été appelées en premier.

body() -> bytes

Retours

Corps entier sous forme d’octets dans la mémoire.

Type de retour

bytes

parts

En supposant que le type de contenu est multiparte/mixte, retourne les parties en tant qu’itérateur asynchrone.

parts() -> AsyncIterator[AsyncHttpResponse]

Retours

Itérateur asynchrone des parties

Type de retour

AsyncIterator

Exceptions

ValueError

Si le contenu n’est pas en plusieurs parties/mixte

raise_for_status

Déclenche une erreur HttpResponseError si la réponse comporte une erreur status code. Si la réponse est bonne, ne fait rien.

raise_for_status() -> None

stream_download

Générateur pour la diffusion en continu des données du corps de la réponse.

Doit être implémenté par les sous-classes si le téléchargement en streaming est pris en charge. Retourne un générateur asynchrone.

stream_download(pipeline: AsyncPipeline[HttpRequest, 'AsyncHttpResponse'], *, decompress: bool = True, **kwargs: Any) -> AsyncIteratorType[bytes]

Paramètres

pipeline
Pipeline
Obligatoire

Objet pipeline

decompress
bool

Si la valeur est True, qui est la valeur par défaut, tente de décoder le corps en fonction de l’en-tête d’encodage de contenu .

Retours

Itérateur asynchrone d’octets

Type de retour

AsyncIterator[bytes]

text

Retourne le corps entier sous forme de chaîne.

text(encoding: str | None = None) -> str

Paramètres

encoding
str
valeur par défaut: None

Encodage à appliquer. Si aucun, utilisez « utf-8 » avec l’analyse de nomenclature (utf-8-sig). L’implémentation peut être plus intelligente si elle le souhaite (à l’aide d’en-têtes ou de chardets).

Retours

Corps entier sous forme de chaîne.

Type de retour

str
Voir aussi

~body()