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)

Параметры

Имя Описание
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

Имя скачиваемого большого двоичного объекта.
container
str

Имя контейнера, в котором находится большой двоичный объект.
properties
BlobProperties

Свойства скачиваемого большого двоичного объекта. Если загружается только диапазон данных, это будет отражено в свойствах .
size
int

Размер общего объема данных в потоке. Это будет диапазон байтов, если он указан, в противном случае — общий размер большого двоичного объекта.

Методы

chunks

Выполните итерацию по фрагментам в потоке загрузки.
content_as_bytes

НЕ РЕКОМЕНДУЕТСЯ: скачайте содержимое этого файла.

Эта операция блокируется до тех пор, пока не будут загружены все данные.

Этот метод является нерекомендуемым, используйте вместо него func:readall .
content_as_text

НЕ РЕКОМЕНДУЕТСЯ: скачайте содержимое этого BLOB-объекта и декодируете его как текст.

Эта операция блокируется до тех пор, пока не будут загружены все данные.

Этот метод является нерекомендуемым, используйте вместо него func:readall .
download_to_stream

НЕ РЕКОМЕНДУЕТСЯ: скачайте содержимое этого большого двоичного объекта в поток.

Этот метод является нерекомендуемым, используйте вместо него func:readinto .
read

Считывайте байты до размера из потока и возвращайте их. Если размер не указан или равен -1, будут считаны все байты.
readall

Чтение всего содержимого этого большого двоичного объекта. Эта операция блокируется до тех пор, пока не будут загружены все данные.
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

НЕ РЕКОМЕНДУЕТСЯ: скачайте содержимое этого большого двоичного объекта в поток.

Этот метод является нерекомендуемым, используйте вместо него func:readinto .

download_to_stream(stream, max_concurrency=1)

Параметры

Имя Описание
stream
Обязательно
IO[<xref:T>]

Поток для скачивания. Это может быть открытый дескриптор файла или любой записываемый поток. Поток должен быть искать, если для скачивания используется несколько параллельных подключений.
max_concurrency
int

Количество параллельных подключений, с помощью которых требуется скачать.

значение по умолчанию: 1

Возвращаемое значение

Тип Описание
Any

Свойства скачаемого большого двоичного объекта.

read

Считывайте байты до размера из потока и возвращайте их. Если размер не указан или равен -1, будут считаны все байты.

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

Параметры

Имя Описание
size
Optional[int]

Количество байтов, скачиваемых из потока. Оставьте неуказанным или задайте значение -1, чтобы скачать все байты.

значение по умолчанию: -1

Возвращаемое значение

Тип Описание
<xref:T>

Запрошенные данные в виде байтов или строки, если задана кодировка. Если возвращаемое значение пусто, больше нет данных для чтения.

readall

Чтение всего содержимого этого большого двоичного объекта. Эта операция блокируется до тех пор, пока не будут загружены все данные.

readall() -> T

Возвращаемое значение

Тип Описание
<xref:T>

Запрошенные данные в виде байтов или строки, если задана кодировка.

readinto

Скачайте содержимое этого файла в поток.

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

Параметры

Имя Описание
stream
Обязательно
IO[<xref:T>]

Поток для скачивания. Это может быть открытый дескриптор файла или любой записываемый поток. Поток должен быть искать, если для скачивания используется несколько параллельных подключений.

Возвращаемое значение

Тип Описание
int

Число переданных байтов.