Partager via


StorageStreamDownloader Classe

Objet de streaming à télécharger à partir du Stockage Azure.

Héritage
StorageStreamDownloader

Constructeur

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)

Paramètres

Nom Description
clients
valeur par défaut: None
config
valeur par défaut: None
start_range
valeur par défaut: None
end_range
valeur par défaut: None
validate_content
valeur par défaut: None
encryption_options
valeur par défaut: None
max_concurrency
valeur par défaut: 1
name
valeur par défaut: None
container
valeur par défaut: None
encoding
valeur par défaut: None
download_cls
valeur par défaut: None

Variables

Nom Description
name
str

Nom de l’objet blob en cours de téléchargement.

container
str

Nom du conteneur où se trouve l’objet blob.

properties

Propriétés de l’objet blob en cours de téléchargement. Si seule une plage de données est en cours de téléchargement, cela sera reflété dans les propriétés.

size
int

Taille du total des données dans le flux. Il s’agit de la plage d’octets si elle est spécifiée, sinon la taille totale de l’objet blob.

Méthodes

chunks

Itérer sur des segments dans le flux de téléchargement.

content_as_bytes

DEPRECATED : téléchargez le contenu de ce fichier.

Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

Cette méthode est déconseillée, utilisez func:readall à la place.

content_as_text

DEPRECATED : téléchargez le contenu de cet objet blob et décodez en tant que texte.

Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

Cette méthode est déconseillée, utilisez func:readall à la place.

download_to_stream

DÉPRÉCIÉ : téléchargez le contenu de cet objet blob dans un flux.

Cette méthode est déconseillée, utilisez plutôt func:readinto .

read

Lisez la taille des octets du flux et retournez-les. Si la taille n’est pas spécifiée ou est -1, tous les octets sont lus.

readall

Lisez l’intégralité du contenu de cet objet blob. Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

readinto

Téléchargez le contenu de ce fichier dans un flux.

chunks

Itérer sur des segments dans le flux de téléchargement.

chunks() -> Iterator[bytes]

Retours

Type Description

Itérateur des segments dans le flux de téléchargement.

content_as_bytes

DEPRECATED : téléchargez le contenu de ce fichier.

Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

Cette méthode est déconseillée, utilisez func:readall à la place.

content_as_bytes(max_concurrency=1)

Paramètres

Nom Description
max_concurrency
int

Nombre de connexions parallèles à télécharger.

valeur par défaut: 1

Retours

Type Description

Contenu du fichier sous forme d’octets.

content_as_text

DEPRECATED : téléchargez le contenu de cet objet blob et décodez en tant que texte.

Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

Cette méthode est déconseillée, utilisez func:readall à la place.

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

Paramètres

Nom Description
max_concurrency
int

Nombre de connexions parallèles à télécharger.

valeur par défaut: 1
encoding
str

Testez l’encodage pour décoder les octets téléchargés. La valeur par défaut est UTF-8.

valeur par défaut: UTF-8

Retours

Type Description
str

Contenu du fichier en tant que str.

download_to_stream

DÉPRÉCIÉ : téléchargez le contenu de cet objet blob dans un flux.

Cette méthode est déconseillée, utilisez plutôt func:readinto .

download_to_stream(stream, max_concurrency=1)

Paramètres

Nom Description
stream
Obligatoire
IO[<xref:T>]

Flux vers laquelle télécharger. Il peut s’agir d’un handle de fichier ouvert ou d’un flux accessible en écriture. Le flux doit être recherché si le téléchargement utilise plusieurs connexions parallèles.

max_concurrency
int

Nombre de connexions parallèles à télécharger.

valeur par défaut: 1

Retours

Type Description
Any

Propriétés de l’objet blob téléchargé.

read

Lisez la taille des octets du flux et retournez-les. Si la taille n’est pas spécifiée ou est -1, tous les octets sont lus.

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

Paramètres

Nom Description
size

Nombre d’octets à télécharger à partir du flux. Laissez non spécifié ou défini sur -1 pour télécharger tous les octets.

valeur par défaut: -1

Retours

Type Description
<xref:T>

Données demandées sous forme d’octets ou de chaîne si l’encodage a été spécifié. Si la valeur de retour est vide, il n’y a plus de données à lire.

readall

Lisez l’intégralité du contenu de cet objet blob. Cette opération est bloquée jusqu’à ce que toutes les données soient téléchargées.

readall() -> T

Retours

Type Description
<xref:T>

Données demandées sous forme d’octets ou de chaîne si l’encodage a été spécifié.

readinto

Téléchargez le contenu de ce fichier dans un flux.

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

Paramètres

Nom Description
stream
Obligatoire

Flux vers laquelle télécharger. Il peut s’agir d’un handle de fichier ouvert ou d’un flux accessible en écriture. Le flux doit être recherché si le téléchargement utilise plusieurs connexions parallèles.

Retours

Type Description
int

Nombre d'octets lus.