StorageStreamDownloader Klasa

Obiekt przesyłania strumieniowego do pobrania z usługi Azure Storage.

Dziedziczenie

Generic

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)

Parametry

Nazwa	Opis
clients	wartość domyślna: None
config	wartość domyślna: None
start_range	wartość domyślna: None
end_range	wartość domyślna: None
validate_content	wartość domyślna: None
encryption_options	wartość domyślna: None
max_concurrency	wartość domyślna: 1
name	wartość domyślna: None
container	wartość domyślna: None
encoding	wartość domyślna: None
download_cls	wartość domyślna: None

Zmienne

Nazwa	Opis
name	str Nazwa pobieranego obiektu blob.
container	str Nazwa kontenera, w którym znajduje się obiekt blob.
properties	BlobProperties Właściwości pobieranego obiektu blob. Jeśli pobierany jest tylko zakres danych, zostaną one odzwierciedlone we właściwościach.
size	int Rozmiar całkowitej ilości danych w strumieniu. Będzie to zakres bajtów, jeśli zostanie określony, w przeciwnym razie łączny rozmiar obiektu blob.

Metody

chunks	Iterowanie fragmentów w strumieniu pobierania.
content_as_bytes	PRZESTARZAŁE: pobierz zawartość tego pliku. Ta operacja jest blokowana do momentu pobrania wszystkich danych. Ta metoda jest przestarzała, zamiast tego użyj func:readall .
content_as_text	PRZESTARZAŁE: pobierz zawartość tego obiektu blob i zdekoduj jako tekst. Ta operacja jest blokowana do momentu pobrania wszystkich danych. Ta metoda jest przestarzała, zamiast tego użyj func:readall .
download_to_stream	PRZESTARZAŁE: pobierz zawartość tego obiektu blob do strumienia. Ta metoda jest przestarzała, zamiast tego użyj polecenia func:readinto .
read	Odczytaj do rozmiaru bajtów ze strumienia i zwróć je. Jeśli rozmiar jest nieokreślony lub wynosi -1, wszystkie bajty zostaną odczytane.
readall	Odczytywanie całej zawartości tego obiektu blob. Ta operacja jest blokowana do momentu pobrania wszystkich danych.
readinto	Pobierz zawartość tego pliku do strumienia.

chunks

Iterowanie fragmentów w strumieniu pobierania.

chunks() -> Iterator[bytes]

Zwraca

Typ	Opis
Iterator[bytes]	Iterator fragmentów w strumieniu pobierania.

content_as_bytes

PRZESTARZAŁE: pobierz zawartość tego pliku.

Ta operacja jest blokowana do momentu pobrania wszystkich danych.

Ta metoda jest przestarzała, zamiast tego użyj func:readall .

content_as_bytes(max_concurrency=1)

Parametry

Nazwa	Opis
max_concurrency	int Liczba połączeń równoległych, z którymi należy pobrać. wartość domyślna: 1

Zwraca

Typ	Opis
bytes	Zawartość pliku jako bajty.

content_as_text

PRZESTARZAŁE: pobierz zawartość tego obiektu blob i zdekoduj jako tekst.

Ta operacja jest blokowana do momentu pobrania wszystkich danych.

Ta metoda jest przestarzała, zamiast tego użyj func:readall .

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

Parametry

Nazwa	Opis
max_concurrency	int Liczba połączeń równoległych, z którymi należy pobrać. wartość domyślna: 1
encoding	str Testowanie kodowania w celu dekodowania pobranych bajtów. Wartość domyślna to UTF-8. wartość domyślna: UTF-8

Zwraca

Typ	Opis
str	Zawartość pliku jako str.

download_to_stream

PRZESTARZAŁE: pobierz zawartość tego obiektu blob do strumienia.

Ta metoda jest przestarzała, zamiast tego użyj polecenia func:readinto .

download_to_stream(stream, max_concurrency=1)

Parametry

Nazwa	Opis
stream Wymagane	IO[<xref:T>] Strumień do pobrania. Może to być otwarty dojście do plików lub dowolny strumień zapisywalny. Strumień musi być wyszukiwany, jeśli pobieranie używa więcej niż jednego połączenia równoległego.
max_concurrency	int Liczba połączeń równoległych, z którymi należy pobrać. wartość domyślna: 1

Zwraca

Typ	Opis
Any	Właściwości pobranego obiektu blob.

read

Odczytaj do rozmiaru bajtów ze strumienia i zwróć je. Jeśli rozmiar jest nieokreślony lub wynosi -1, wszystkie bajty zostaną odczytane.

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

Parametry

Nazwa	Opis
size	Optional[int] Liczba bajtów do pobrania ze strumienia. Pozostaw nieokreślone lub ustawione na -1, aby pobrać wszystkie bajty. wartość domyślna: -1

Zwraca

Typ	Opis
<xref:T>	Żądane dane jako bajty lub ciąg, jeśli określono kodowanie. Jeśli wartość zwracana jest pusta, nie ma więcej danych do odczytania.

readall

Odczytywanie całej zawartości tego obiektu blob. Ta operacja jest blokowana do momentu pobrania wszystkich danych.

readall() -> T

Zwraca

Typ	Opis
<xref:T>	Żądane dane jako bajty lub ciąg, jeśli określono kodowanie.

readinto

Pobierz zawartość tego pliku do strumienia.

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

Parametry

Nazwa	Opis
stream Wymagane	IO[bytes] Strumień do pobrania. Może to być otwarty dojście do plików lub dowolny strumień zapisywalny. Strumień musi być wyszukiwany, jeśli pobieranie używa więcej niż jednego połączenia równoległego.

Zwraca

Typ	Opis
int	Liczba odczytanych bajtów.