StorageStreamDownloader クラス

Azure Storage からダウンロードするストリーミング オブジェクト。

継承

Generic

StorageStreamDownloader

コンストラクター

StorageStreamDownloader(clients=None, config=None, start_range=None, end_range=None, validate_content=None, encryption_options=None, max_concurrency=1, name=None, container=None, encoding=None, download_cls=None, **kwargs)

パラメーター

名前	説明
clients	既定値: None
config	既定値: None
start_range	既定値: None
end_range	既定値: None
validate_content	既定値: None
encryption_options	既定値: None
max_concurrency	既定値: 1
name	既定値: None
container	既定値: None
encoding	既定値: None
download_cls	既定値: None

変数

名前	説明
name	str ダウンロードする BLOB の名前。
container	str BLOB があるコンテナーの名前。
properties	BlobProperties ダウンロードする BLOB のプロパティ。 データの範囲のみがダウンロードされている場合、これはプロパティに反映されます。
size	int ストリーム内の合計データのサイズ。 指定した場合、これはバイト範囲になり、それ以外の場合は BLOB の合計サイズになります。

メソッド

chunks	ダウンロード ストリーム内のチャンクを反復処理します。
content_as_bytes	非推奨: このファイルの内容をダウンロードします。 この操作は、すべてのデータがダウンロードされるまでブロックしています。 このメソッドは非推奨です。代わりに func:readall を使用してください。
content_as_text	非推奨: この BLOB の内容をダウンロードし、テキストとしてデコードします。 この操作は、すべてのデータがダウンロードされるまでブロックしています。 このメソッドは非推奨です。代わりに func:readall を使用してください。
download_to_stream	非推奨: この BLOB の内容をストリームにダウンロードします。 このメソッドは非推奨です。代わりに func:readinto を使用してください。
read	ストリームから最大サイズバイトを読み取り、それらを返します。 size が指定されていない場合、または -1 の場合は、すべてのバイトが読み取られます。
readall	この BLOB の内容全体を読み取ります。 この操作は、すべてのデータがダウンロードされるまでブロックしています。
readinto	このファイルの内容をストリームにダウンロードします。

chunks

ダウンロード ストリーム内のチャンクを反復処理します。

chunks() -> Iterator[bytes]

戻り値

型	説明
Iterator[bytes]	ダウンロード ストリーム内のチャンクの反復子。

content_as_bytes

非推奨: このファイルの内容をダウンロードします。

この操作は、すべてのデータがダウンロードされるまでブロックしています。

このメソッドは非推奨です。代わりに func:readall を使用してください。

content_as_bytes(max_concurrency=1)

パラメーター

名前	説明
max_concurrency	int ダウンロードする並列接続の数。 既定値: 1

戻り値

型	説明
bytes	ファイルの内容をバイトとして指定します。

content_as_text

非推奨: この BLOB の内容をダウンロードし、テキストとしてデコードします。

この操作は、すべてのデータがダウンロードされるまでブロックしています。

このメソッドは非推奨です。代わりに func:readall を使用してください。

content_as_text(max_concurrency=1, encoding='UTF-8')

パラメーター

名前	説明
max_concurrency	int ダウンロードする並列接続の数。 既定値: 1
encoding	str ダウンロードしたバイトをデコードするためのエンコードをテストします。 既定値は UTF-8 です。 既定値: UTF-8

戻り値

型	説明
str	ファイルの内容を str として指定します。

download_to_stream

非推奨: この BLOB の内容をストリームにダウンロードします。

このメソッドは非推奨です。代わりに func:readinto を使用してください。

download_to_stream(stream, max_concurrency=1)

パラメーター

名前	説明
stream 必須	IO[<xref:T>] ダウンロードするストリーム。 これには、開いているファイル ハンドルまたは書き込み可能なストリームを指定できます。 ダウンロードで複数の並列接続が使用されている場合、ストリームはシーク可能である必要があります。
max_concurrency	int ダウンロードする並列接続の数。 既定値: 1

戻り値

型	説明
Any	ダウンロードした BLOB のプロパティ。

read

ストリームから最大サイズバイトを読み取り、それらを返します。 size が指定されていない場合、または -1 の場合は、すべてのバイトが読み取られます。

read(size: int | None = -1) -> T

パラメーター

名前	説明
size	Optional[int] ストリームからダウンロードするバイト数。 すべてのバイトをダウンロードするには、未指定のままにするか、-1 に設定します。 既定値: -1

戻り値

型	説明
<xref:T>	エンコードが指定されている場合は、要求されたデータをバイトまたは文字列として指定します。 戻り値が空の場合、読み取るデータはこれ以上ありません。

readall

この BLOB の内容全体を読み取ります。 この操作は、すべてのデータがダウンロードされるまでブロックしています。

readall() -> T

戻り値

型	説明
<xref:T>	エンコードが指定されている場合は、要求されたデータをバイトまたは文字列として指定します。

readinto

このファイルの内容をストリームにダウンロードします。

readinto(stream: IO[bytes]) -> int

パラメーター

名前	説明
stream 必須	IO[bytes] ダウンロードするストリーム。 これには、開いているファイル ハンドルまたは書き込み可能なストリームを指定できます。 ダウンロードで複数の並列接続が使用されている場合、ストリームはシーク可能である必要があります。

戻り値

型	説明
int	読み取るバイト数。