Udostępnij za pomocą

Wyświetlanie listy obiektów blob za pomocą języka Python

W tym artykule pokazano, jak wyświetlić listę obiektów blob przy użyciu biblioteki klienta usługi Azure Storage dla języka Python.

Aby dowiedzieć się więcej na temat wyświetlania listy obiektów blob przy użyciu asynchronicznych interfejsów API, zobacz Asynchronicznie wyświetlanie listy obiektów blob.

Wymagania wstępne

Konfigurowanie środowiska

Jeśli nie masz istniejącego projektu, w tej sekcji pokazano, jak skonfigurować projekt do pracy z biblioteką klienta usługi Azure Blob Storage dla języka Python. Aby uzyskać więcej informacji, zobacz Rozpoczynanie pracy z usługami Azure Blob Storage i Python.

Aby pracować z przykładami kodu w tym artykule, wykonaj następujące kroki, aby skonfigurować projekt.

Instalowanie pakietów

Zainstaluj następujące pakiety przy użyciu polecenia pip install:

pip install azure-storage-blob azure-identity

Dodaj instrukcje importu

Dodaj następujące instrukcje import:

from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient, ContainerClient, BlobPrefix

Autoryzacja

Mechanizm autoryzacji musi mieć niezbędne uprawnienia do wyświetlania listy obiektów blob. Aby uzyskać autoryzację przy użyciu identyfikatora Entra firmy Microsoft (zalecane), potrzebujesz roli wbudowanej w systemie Azure RBAC Storage Blob Data Reader lub wyższą. Aby dowiedzieć się więcej, zapoznaj się z wytycznymi dotyczącymi autoryzacji dla List Blobs (interfejsu API REST).

Tworzenie obiektu klienta

Aby połączyć aplikację z Blob Storage, utwórz wystąpienie BlobServiceClient. W poniższym przykładzie pokazano, jak utworzyć obiekt klienta przy użyciu DefaultAzureCredential autoryzacji:

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"
credential = DefaultAzureCredential()

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=credential)

Można również tworzyć obiekty klienta dla określonych kontenerów lub obiektów blob, bezpośrednio lub poprzez obiekt BlobServiceClient. Aby dowiedzieć się więcej na temat tworzenia obiektów klienta i zarządzania nimi, zobacz Tworzenie obiektów klienta korzystających z zasobów danych i zarządzanie nimi.

Opcje wyświetlania listy obiektów blob — informacje

Podczas wyświetlania listy obiektów blob z kodu można określić wiele opcji zarządzania sposobem zwracania wyników z usługi Azure Storage. Możesz określić liczbę wyników, które mają być zwracane w każdym zestawie wyników, a następnie pobrać kolejne zestawy. Można określić prefiks do zwracania obiektów blob, których nazwy zaczynają się od tego znaku lub ciągu. Obiekty blob można wyświetlać zarówno w płaskiej strukturze listy, jak i hierarchicznie. Hierarchiczna lista zwraca obiekty blob tak, jak są zorganizowane w folderach.

Aby wyświetlić listę obiektów blob w kontenerze przy użyciu listy płaskiej, wywołaj jedną z następujących metod:

  • ContainerClient.list_blobs (wraz z nazwą można opcjonalnie dołączyć metadane, tagi i inne informacje skojarzone z każdym obiektem blob)
  • ContainerClient.list_blob_names (zwraca tylko nazwę obiektu blob)

Aby wyświetlić listę obiektów blob w kontenerze przy użyciu wyświetlania hierarchicznego, wywołaj następującą metodę:

  • ContainerClient.walk_blobs (wraz z nazwą można opcjonalnie dołączyć metadane, tagi i inne informacje skojarzone z każdym obiektem blob)

Filtrowanie wyników za pomocą prefiksu

Aby przefiltrować listę obiektów blob, podaj ciąg dla argumentu związanego ze słowem kluczowym name_starts_with. Ciąg prefiksu może zawierać co najmniej jeden znak. Następnie usługa Azure Storage zwraca tylko obiekty blob, których nazwy zaczynają się od tego prefiksu.

Lista płaska a lista hierarchiczna

Obiekty blob w usłudze Azure Storage są zorganizowane w modelu płaskim, a nie w modelu hierarchicznym (np. klasycznym systemie plików). Można jednak organizować obiekty blob w katalogach wirtualnych , aby naśladować strukturę folderów. Katalog wirtualny jest częścią nazwy obiektu typu blob i jest określany za pomocą znaku rozdzielającego.

Aby zorganizować obiekty blob w katalogi wirtualne, użyj znaku oddzielającego w nazwie obiektu blob. Domyślny znak ogranicznika to ukośnik (/), ale można określić dowolny znak jako ogranicznik.

Jeśli nazwiesz obiekty blob przy użyciu separatora, możesz wybrać wyświetlanie ich w sposób hierarchiczny. W przypadku operacji hierarchicznego listowania usługa Azure Storage zwraca wszystkie katalogi wirtualne i obiekty blob znajdujące się pod obiektem nadrzędnym. Operację wyświetlania listy można wywołać rekursywnie, aby przejść przez hierarchię, podobnie jak w przypadku programowego przechodzenia przez klasyczny system plików.

Używanie listy płaskiej

Domyślnie operacja wyświetlania listy zwraca obiekty blob w płaskiej liście. W płaskiej liście, obiekty typu blob nie są zorganizowane według katalogu wirtualnego.

W poniższym przykładzie wymieniono obiekty blob w określonym kontenerze przy użyciu listy płaskiej:

def list_blobs_flat(self, blob_service_client: BlobServiceClient, container_name):
    container_client = blob_service_client.get_container_client(container=container_name)

    blob_list = container_client.list_blobs()

    for blob in blob_list:
        print(f"Name: {blob.name}")

Przykładowe dane wyjściowe są podobne do następujących:

List blobs flat:
Name: file4.txt
Name: folderA/file1.txt
Name: folderA/file2.txt
Name: folderA/folderB/file3.txt

Możesz również określić opcje filtrowania wyników listy lub pokazać dodatkowe informacje. W poniższym przykładzie wymieniono obiekty blob i tagi blobów.

def list_blobs_flat_options(self, blob_service_client: BlobServiceClient, container_name):
    container_client = blob_service_client.get_container_client(container=container_name)

    blob_list = container_client.list_blobs(include=['tags'])

    for blob in blob_list:
        print(f"Name: {blob['name']}, Tags: {blob['tags']}")

Przykładowe dane wyjściowe są podobne do następujących:

List blobs flat:
Name: file4.txt, Tags: None
Name: folderA/file1.txt, Tags: None
Name: folderA/file2.txt, Tags: None
Name: folderA/folderB/file3.txt, Tags: {'tag1': 'value1', 'tag2': 'value2'}

Uwaga

Pokazane przykładowe dane wyjściowe zakładają, że masz konto magazynu z przestrzenią nazw płaską. Jeśli włączono funkcję hierarchicznej przestrzeni nazw dla konta magazynowego, katalogi nie są wirtualne. Zamiast tego są to konkretne, niezależne obiekty. W związku z tym katalogi są wyświetlane na liście jako obiekty blob o zerowej długości.

Aby uzyskać alternatywną opcję wyświetlania listy podczas pracy z hierarchiczną przestrzenią nazw, zobacz List directory contents (Azure Data Lake Storage).

Używanie listy hierarchicznej

Kiedy wywołujesz operację listowania hierarchicznie, Azure Storage zwraca katalogi wirtualne i obiekty blob na pierwszym poziomie hierarchii.

Aby wyświetlić hierarchicznie listę obiektów blob, użyj następującej metody:

W poniższym przykładzie wymieniono obiekty blob w określonym kontenerze przy użyciu listy hierarchicznej:

depth = 0
indent = "  "
def list_blobs_hierarchical(self, container_client: ContainerClient, prefix):
    for blob in container_client.walk_blobs(name_starts_with=prefix, delimiter='/'):
        if isinstance(blob, BlobPrefix):
            # Indentation is only added to show nesting in the output
            print(f"{self.indent * self.depth}{blob.name}")
            self.depth += 1
            self.list_blobs_hierarchical(container_client, prefix=blob.name)
            self.depth -= 1
        else:
            print(f"{self.indent * self.depth}{blob.name}")

Przykładowe dane wyjściowe są podobne do następujących:

folderA/
  folderA/folderB/
    folderA/folderB/file3.txt
  folderA/file1.txt
  folderA/file2.txt
file4.txt

Uwaga

Nie można wymienić migawek obiektów blob w operacji hierarchicznej listy.

Wymienianie obiektów blob asynchronicznie

Biblioteka klienta usługi Azure Blob Storage dla języka Python obsługuje asynchroniczne wyświetlanie listy obiektów blob. Aby dowiedzieć się więcej na temat wymagań dotyczących konfiguracji projektu, zobacz Programowanie asynchroniczne.

Wykonaj następujące kroki, aby wyświetlić listę obiektów blob przy użyciu asynchronicznych API:

  1. Dodaj następujące instrukcje importowania:

    import asyncio

from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient, ContainerClient, BlobPrefix

  2. Dodaj kod, aby uruchomić program przy użyciu polecenia asyncio.run. Ta funkcja uruchamia przekazaną korutynę, w naszym przykładzie main(), i zarządza pętlą zdarzeń asyncio. Coroutines są deklarowane przy użyciu składni async/await. W tym przykładzie coroutine najpierw tworzy najwyższy poziom main() przy użyciu BlobServiceClient, a następnie wywołuje metodę, która wyświetla listę blobów. Należy pamiętać, że tylko klient najwyższego poziomu musi używać programu async with, ponieważ inni klienci utworzoni na jego podstawie współużytkować tę samą pulę połączeń.

    async def main():
    sample = BlobSamples()

    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    credential = DefaultAzureCredential()

    async with BlobServiceClient(account_url, credential=credential) as blob_service_client:
        await sample.list_blobs_flat(blob_service_client, "sample-container")

if __name__ == '__main__':
    asyncio.run(main())

  3. Dodaj kod, aby wyświetlić listę blobów. Poniższy przykład kodu wyświetla listę obiektów blob przy użyciu prostej listy. Kod jest taki sam jak w przykładzie synchronicznym, z tą różnicą, że metoda jest zadeklarowana za pomocą słowa kluczowego async i async for jest używana podczas wywoływania list_blobs metody.

    async def list_blobs_flat(self, blob_service_client: BlobServiceClient, container_name):
    container_client = blob_service_client.get_container_client(container=container_name)

    async for blob in container_client.list_blobs():
        print(f"Name: {blob.name}")

Ta podstawowa konfiguracja umożliwia zaimplementowanie innych przykładów w tym artykule jako korutyny przy użyciu składni async/await.

Zasoby

Aby dowiedzieć się więcej na temat wyświetlania listy obiektów blob przy użyciu biblioteki klienta usługi Azure Blob Storage dla języka Python, zobacz następujące zasoby.

Przykłady kodu

Operacje interfejsu API REST

Zestaw Azure SDK dla języka Python zawiera biblioteki, które bazują na interfejsie API REST platformy Azure, umożliwiając interakcję z operacjami interfejsu API REST za pomocą znanych paradygmatów języka Python. Metody biblioteki klienta do wyświetlania listy obiektów blob używają następującej operacji interfejsu API REST:

Zasoby biblioteki klienta

Zobacz też

Powiązana zawartość

  • Ten artykuł jest częścią przewodnika dla deweloperów usługi Blob Storage dla języka Python. Aby dowiedzieć się więcej, zobacz pełną listę artykułów z przewodnika dla deweloperów w temacie Tworzenie aplikacji w języku Python.
  • Last updated on