你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

StorageStreamDownloader 类

要从 Azure 存储下载的流式处理对象。

继承
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

正在下载的 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]

返回

类型 说明

下载流中区块的迭代器。

content_as_bytes

已弃用:下载此文件的内容。

此操作在下载所有数据之前处于阻塞状态。

此方法已弃用,请改用 func:readall

content_as_bytes(max_concurrency=1)

参数

名称 说明
max_concurrency
int

要下载的并行连接数。

默认值: 1

返回

类型 说明

以字节形式表示的文件内容。

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

要从流下载的字节数。 保留未指定或设置为 -1 以下载所有字节。

默认值: -1

返回

类型 说明
<xref:T>

请求的数据作为字节;如果指定了编码,则为字符串。 如果返回值为空,则不再有要读取的数据。

readall

读取此 Blob 的全部内容。 此操作在下载所有数据之前处于阻塞状态。

readall() -> T

返回

类型 说明
<xref:T>

请求的数据作为字节;如果指定了编码,则为字符串。

readinto

将此文件的内容下载到流中。

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

参数

名称 说明
stream
必需

要下载到的流。 这可以是打开的文件句柄或任何可写流。 如果下载使用多个并行连接,则流必须是可查找的。

返回

类型 说明
int

读取的字节数。