AsyncHttpResponse クラス

  • リファレンス

AsyncHttpResponse ABC。

応答からのデータの非同期ストリーミングを許可します。

継承
azure.core.pipeline.transport._base._HttpResponseBase
AsyncHttpResponse
AbstractAsyncContextManager
AsyncHttpResponse
Generic
AsyncHttpResponse

コンストラクター

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

パラメーター

request
internal_response
block_size
既定値: None

メソッド

body

本文全体をメモリ内のバイトとして返します。

同期実装者は、可能であれば本文をメモリに読み込む必要があります。 非同期実装者は、最初に呼び出された非同期load_bodyに依存する必要があります。
parts

コンテンツ タイプが multipart/mixed であると仮定すると、部分は非同期反復子として返されます。
raise_for_status

応答にエラー状態コードがある場合は、HttpResponseError を発生させます。 応答が適切な場合は、何も行いません。
stream_download

応答本文データをストリーミングするためのジェネレーター。

ストリーミングダウンロードがサポートされている場合は、サブオブジェクトによって実装する必要があります。 非同期ジェネレーターを返します。
text

本文全体を文字列として返します。

body

本文全体をメモリ内のバイトとして返します。

同期実装者は、可能であれば本文をメモリに読み込む必要があります。 非同期実装者は、最初に呼び出された非同期load_bodyに依存する必要があります。

body() -> bytes

戻り値

メモリ内のバイトとしての本文。

の戻り値の型 :

bytes

parts

コンテンツ タイプが multipart/mixed であると仮定すると、部分は非同期反復子として返されます。

parts() -> AsyncIterator[AsyncHttpResponse]

戻り値

部分の非同期反復子

の戻り値の型 :

AsyncIterator

例外

ValueError

コンテンツがマルチパート/混合でない場合

raise_for_status

応答にエラー状態コードがある場合は、HttpResponseError を発生させます。 応答が適切な場合は、何も行いません。

raise_for_status() -> None

stream_download

応答本文データをストリーミングするためのジェネレーター。

ストリーミングダウンロードがサポートされている場合は、サブオブジェクトによって実装する必要があります。 非同期ジェネレーターを返します。

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

パラメーター

pipeline
Pipeline
必須

パイプライン オブジェクト

decompress
bool

既定値の True の場合、 content-encoding ヘッダーに基づいて本文のデコードが試みられます。

戻り値

バイトの非同期反復子

の戻り値の型 :

AsyncIterator[bytes]

text

本文全体を文字列として返します。

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

パラメーター

encoding
str
既定値: None

適用するエンコード。 None の場合は、BOM 解析で "utf-8" を使用します (utf-8-sig)。 必要に応じて (ヘッダーまたは文字セットを使用して) 実装をスマートにすることができます。

戻り値

本文全体を文字列として指定します。

の戻り値の型 :

str
こちらもご覧ください

~body()