StorageStreamDownloader 類別

參考

要從 Azure 儲存體下載的串流物件。

繼承: 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)

參數

名稱	Description
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

變數

名稱	Description
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	從資料流程讀取最多大小位元組，並傳回它們。如果未指定大小或為 -1，則會讀取所有位元組。
readall	讀取此 Blob 的整個內容。這項作業會封鎖，直到下載所有資料為止。
readinto	將此檔案的內容下載至資料流程。

chunks

逐一查看下載資料流程中的區塊。

chunks() -> Iterator[bytes]

傳回

類型	Description
Iterator[bytes]	下載資料流程中區塊的反覆運算器。

content_as_bytes

已淘汰：下載此檔案的內容。

這項作業會封鎖，直到下載所有資料為止。

此方法已被取代，請改用 func：readall 。

content_as_bytes(max_concurrency=1)

參數

名稱	Description
max_concurrency	int 要下載的平行連線數目。預設值: 1

傳回

類型	Description
bytes	以位元組表示的檔案內容。

content_as_text

已淘汰：下載此 Blob 的內容，並將解碼為文字。

這項作業會封鎖，直到下載所有資料為止。

此方法已被取代，請改用 func：readall 。

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

參數

名稱	Description
max_concurrency	int 要下載的平行連線數目。預設值: 1
encoding	str 測試編碼以解碼下載的位元組。預設值為 UTF-8。預設值: UTF-8

傳回

類型	Description
str	檔案的內容做為 str。

download_to_stream

已淘汰：將此 Blob 的內容下載至資料流程。

此方法已被取代，請改用 func：readinto 。

download_to_stream(stream, max_concurrency=1)

參數

名稱	Description
stream 必要	IO[<xref:T>] 要下載的資料流程。這可以是開啟的檔案控制碼或任何可寫入的資料流程。如果下載使用多個平行連線，則必須搜尋資料流程。
max_concurrency	int 要下載的平行連線數目。預設值: 1

傳回

類型	Description
Any	已下載 Blob 的屬性。

read

從資料流程讀取最多大小位元組，並傳回它們。如果未指定大小或為 -1，則會讀取所有位元組。

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

參數

名稱	Description
size	Optional[int] 要從資料流程下載的位元組數目。保留未指定或設定為 -1 以下載所有位元組。預設值: -1

傳回

類型	Description
<xref:T>	指定的編碼方式為位元組或字串的要求資料。如果傳回值是空的，則不會再讀取任何資料。

readall

讀取此 Blob 的整個內容。這項作業會封鎖，直到下載所有資料為止。

readall() -> T

傳回

類型	Description
<xref:T>	指定的編碼方式為位元組或字串的要求資料。

readinto

將此檔案的內容下載至資料流程。

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

參數

名稱	Description
stream 必要	IO[bytes] 要下載的資料流程。這可以是開啟的檔案控制碼或任何可寫入的資料流程。如果下載使用多個平行連線，則必須搜尋資料流程。

傳回

類型	Description
int	讀取的位元組數。

共用方式為