Share via

StorageStreamDownloader Classe

  • Referência

Um objeto de streaming a ser baixado do Armazenamento do Azure.

Herança
Generic
StorageStreamDownloader

Construtor

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)

Parâmetros

Nome Description
clients
valor padrão: None
config
valor padrão: None
start_range
valor padrão: None
end_range
valor padrão: None
validate_content
valor padrão: None
encryption_options
valor padrão: None
max_concurrency
valor padrão: 1
name
valor padrão: None
container
valor padrão: None
encoding
valor padrão: None
download_cls
valor padrão: None

Variáveis

Nome Description
name
str

O nome do blob que está sendo baixado.
container
str

O nome do contêiner em que o blob está.
properties
BlobProperties

As propriedades do blob que está sendo baixado. Se apenas um intervalo de dados estiver sendo baixado, isso será refletido nas propriedades.
size
int

O tamanho do total de dados no fluxo. Esse será o intervalo de bytes se especificado, caso contrário, o tamanho total do blob.

Métodos

chunks

Iterar em partes no fluxo de download.
content_as_bytes

PRETERIDO: baixe o conteúdo deste arquivo.

Essa operação está bloqueando até que todos os dados sejam baixados.

Esse método foi preterido, use func:readall .
content_as_text

PRETERIDO: baixe o conteúdo desse blob e decodificado como texto.

Essa operação está bloqueando até que todos os dados sejam baixados.

Esse método foi preterido, use func:readall .
download_to_stream

PRETERIDO: baixe o conteúdo desse blob em um fluxo.

Esse método foi preterido, use func:readinto .
read

Leia até tamanho de bytes do fluxo e retorne-os. Se o tamanho não for especificado ou for -1, todos os bytes serão lidos.
readall

Leia todo o conteúdo deste blob. Essa operação está bloqueando até que todos os dados sejam baixados.
readinto

Baixe o conteúdo desse arquivo em um fluxo.

chunks

Iterar em partes no fluxo de download.

chunks() -> Iterator[bytes]

Retornos

Tipo Description
Iterator[bytes]

Um iterador das partes no fluxo de download.

content_as_bytes

PRETERIDO: baixe o conteúdo deste arquivo.

Essa operação está bloqueando até que todos os dados sejam baixados.

Esse método foi preterido, use func:readall .

content_as_bytes(max_concurrency=1)

Parâmetros

Nome Description
max_concurrency
int

O número de conexões paralelas com as quais baixar.

valor padrão: 1

Retornos

Tipo Description
bytes

O conteúdo do arquivo como bytes.

content_as_text

PRETERIDO: baixe o conteúdo desse blob e decodificado como texto.

Essa operação está bloqueando até que todos os dados sejam baixados.

Esse método foi preterido, use func:readall .

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

Parâmetros

Nome Description
max_concurrency
int

O número de conexões paralelas com as quais baixar.

valor padrão: 1
encoding
str

Testar a codificação para decodificar os bytes baixados. Padrão é UTF-8.

valor padrão: UTF-8

Retornos

Tipo Description
str

O conteúdo do arquivo como um str.

download_to_stream

PRETERIDO: baixe o conteúdo desse blob em um fluxo.

Esse método foi preterido, use func:readinto .

download_to_stream(stream, max_concurrency=1)

Parâmetros

Nome Description
stream
Obrigatório
IO[<xref:T>]

O fluxo para o qual baixar. Isso pode ser um identificador de arquivo aberto ou qualquer fluxo gravável. O fluxo deverá ser buscado se o download usar mais de uma conexão paralela.
max_concurrency
int

O número de conexões paralelas com as quais baixar.

valor padrão: 1

Retornos

Tipo Description
Any

As propriedades do blob baixado.

read

Leia até tamanho de bytes do fluxo e retorne-os. Se o tamanho não for especificado ou for -1, todos os bytes serão lidos.

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

Parâmetros

Nome Description
size
Optional[int]

O número de bytes a serem baixados do fluxo. Deixe não especificado ou definido como -1 para baixar todos os bytes.

valor padrão: -1

Retornos

Tipo Description
<xref:T>

Os dados solicitados como bytes ou uma cadeia de caracteres se a codificação tiver sido especificada. Se o valor retornado estiver vazio, não haverá mais dados a serem lidos.

readall

Leia todo o conteúdo deste blob. Essa operação está bloqueando até que todos os dados sejam baixados.

readall() -> T

Retornos

Tipo Description
<xref:T>

Os dados solicitados como bytes ou uma cadeia de caracteres se a codificação tiver sido especificada.

readinto

Baixe o conteúdo desse arquivo em um fluxo.

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

Parâmetros

Nome Description
stream
Obrigatório
IO[bytes]

O fluxo para o qual baixar. Isso pode ser um identificador de arquivo aberto ou qualquer fluxo gravável. O fluxo deverá ser buscado se o download usar mais de uma conexão paralela.

Retornos

Tipo Description
int

O número de bytes lidos.