Freigeben über


StorageStreamDownloader Klasse

Ein Streamingobjekt zum Herunterladen aus Azure Storage.

Vererbung
StorageStreamDownloader

Konstruktor

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)

Parameter

Name Beschreibung
clients
Standardwert: None
config
Standardwert: None
start_range
Standardwert: None
end_range
Standardwert: None
validate_content
Standardwert: None
encryption_options
Standardwert: None
max_concurrency
Standardwert: 1
name
Standardwert: None
container
Standardwert: None
encoding
Standardwert: None
download_cls
Standardwert: None

Variablen

Name Beschreibung
name
str

Der Name des heruntergeladenen Blobs.

container
str

Der Name des Containers, in dem sich das Blob befindet.

properties

Die Eigenschaften des heruntergeladenen Blobs. Wenn nur ein Bereich der Daten heruntergeladen wird, wird dies in den Eigenschaften widerspiegelt.

size
int

Die Größe der Gesamtdaten im Stream. Dies ist der Bytebereich, falls angegeben, andernfalls die Gesamtgröße des Blobs.

Methoden

chunks

Durchlaufen Sie Blöcke im Downloadstream.

content_as_bytes

VERALTET: Laden Sie den Inhalt dieser Datei herunter.

Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readall .

content_as_text

VERALTET: Laden Sie den Inhalt dieses Blobs herunter, und decodieren Sie als Text.

Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readall .

download_to_stream

VERALTET: Laden Sie den Inhalt dieses Blobs in einen Stream herunter.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readinto .

read

Lesen Sie bis zu große Bytes aus dem Stream, und geben Sie sie zurück. Wenn die Größe nicht angegeben ist oder -1 ist, werden alle Bytes gelesen.

readall

Lesen Sie den gesamten Inhalt dieses Blobs. Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

readinto

Laden Sie den Inhalt dieser Datei in einen Stream herunter.

chunks

Durchlaufen Sie Blöcke im Downloadstream.

chunks() -> Iterator[bytes]

Gibt zurück

Typ Beschreibung

Ein Iterator der Blöcke im Downloadstream.

content_as_bytes

VERALTET: Laden Sie den Inhalt dieser Datei herunter.

Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readall .

content_as_bytes(max_concurrency=1)

Parameter

Name Beschreibung
max_concurrency
int

Die Anzahl der parallelen Verbindungen, mit denen heruntergeladen werden soll.

Standardwert: 1

Gibt zurück

Typ Beschreibung

Der Inhalt der Datei als Bytes.

content_as_text

VERALTET: Laden Sie den Inhalt dieses Blobs herunter, und decodieren Sie als Text.

Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readall .

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

Parameter

Name Beschreibung
max_concurrency
int

Die Anzahl der parallelen Verbindungen, mit denen heruntergeladen werden soll.

Standardwert: 1
encoding
str

Testen Sie die Codierung, um die heruntergeladenen Bytes zu decodieren. Der Standardwert ist UTF-8.

Standardwert: UTF-8

Gibt zurück

Typ Beschreibung
str

Der Inhalt der Datei als str.

download_to_stream

VERALTET: Laden Sie den Inhalt dieses Blobs in einen Stream herunter.

Diese Methode ist veraltet, verwenden Sie stattdessen func:readinto .

download_to_stream(stream, max_concurrency=1)

Parameter

Name Beschreibung
stream
Erforderlich
IO[<xref:T>]

Der Stream, in den heruntergeladen werden soll. Dies kann ein geöffneter Dateihandle oder ein beliebiger beschreibbarer Stream sein. Der Stream muss suchbar sein, wenn beim Download mehr als eine parallele Verbindung verwendet wird.

max_concurrency
int

Die Anzahl der parallelen Verbindungen, mit denen heruntergeladen werden soll.

Standardwert: 1

Gibt zurück

Typ Beschreibung
Any

Die Eigenschaften des heruntergeladenen Blobs.

read

Lesen Sie bis zu große Bytes aus dem Stream, und geben Sie sie zurück. Wenn die Größe nicht angegeben ist oder -1 ist, werden alle Bytes gelesen.

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

Parameter

Name Beschreibung
size

Die Anzahl der Bytes, die aus dem Stream heruntergeladen werden sollen. Lassen Sie nicht angegeben oder legen Sie auf -1 fest, um alle Bytes herunterzuladen.

Standardwert: -1

Gibt zurück

Typ Beschreibung
<xref:T>

Die angeforderten Daten als Bytes oder eine Zeichenfolge, wenn die Codierung angegeben wurde. Wenn der Rückgabewert leer ist, sind keine weiteren Daten mehr zu lesen.

readall

Lesen Sie den gesamten Inhalt dieses Blobs. Dieser Vorgang blockiert, bis alle Daten heruntergeladen werden.

readall() -> T

Gibt zurück

Typ Beschreibung
<xref:T>

Die angeforderten Daten als Bytes oder eine Zeichenfolge, wenn die Codierung angegeben wurde.

readinto

Laden Sie den Inhalt dieser Datei in einen Stream herunter.

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

Parameter

Name Beschreibung
stream
Erforderlich

Der Stream, in den heruntergeladen werden soll. Dies kann ein geöffneter Dateihandle oder ein beliebiger beschreibbarer Stream sein. Der Stream muss suchbar sein, wenn beim Download mehr als eine parallele Verbindung verwendet wird.

Gibt zurück

Typ Beschreibung
int

Die Anzahl der gelesenen Bytes.