Краткое руководство. Управление большими двоичными объектами с помощью пакета SDK для Python версии 12Quickstart: Manage blobs with Python v12 SDK

Из этого краткого руководства вы узнаете, как управлять большими двоичными объектами с использованием Python.In this quickstart, you learn to manage blobs by using Python. Большие двоичные объекты — это объекты, которые могут содержать большие объемы текстовых или двоичных данных, включая изображения, документы, потоковое мультимедиа и архивные данные.Blobs are objects that can hold large amounts of text or binary data, including images, documents, streaming media, and archive data. Вы научитесь отправлять и скачивать большие двоичные объекты, получать список таких объектов, а также создавать и удалять контейнеры.You'll upload, download, and list blobs, and you'll create and delete containers.

Дополнительные ресурсы:Additional resources:

Предварительные требованияPrerequisites

Примечание

Функции, описанные в этой статье, теперь доступны для учетных записей с иерархическим пространством имен.The features described in this article are now available to accounts that have a hierarchical namespace. Чтобы просмотреть ограничения, ознакомьтесь с возможностями хранилища BLOB-объектов, доступными в Azure Data Lake Storage 2-го поколения статье.To review limitations, see the Blob storage features available in Azure Data Lake Storage Gen2 article.

НастройкаSetting up

В этом разделе рассматривается подготовка проекта для работы с клиентской библиотекой хранилища BLOB-объектов Azure версии 12 для Python.This section walks you through preparing a project to work with the Azure Blob storage client library v12 for Python.

Создание проектаCreate the project

Создайте приложение Python с именем blob-quickstart-v12.Create a Python application named blob-quickstart-v12.

  1. В окне консоли (командная строка, PowerShell или Bash) создайте каталог для проекта.In a console window (such as cmd, PowerShell, or Bash), create a new directory for the project.

    mkdir blob-quickstart-v12
    
  2. Перейдите в только что созданный каталог blob-quickstart-v12.Switch to the newly created blob-quickstart-v12 directory.

    cd blob-quickstart-v12
    
  3. В каталоге blob-quickstart-v12 создайте каталог data.In side the blob-quickstart-v12 directory, create another directory called data. Это каталог для создания и хранения файлов данных больших двоичных объектов.This is where the blob data files will be created and stored.

    mkdir data
    

Установка пакетаInstall the package

Оставаясь в каталоге приложения, установите клиентскую библиотеку хранилища BLOB-объектов Azure для пакета Python с помощью команды pip install.While still in the application directory, install the Azure Blob storage client library for Python package by using the pip install command.

pip install azure-storage-blob

Эта команда устанавливает клиентскую библиотеку хранилища BLOB-объектов Azure для пакета Python и все библиотеки, от которых она зависит.This command installs the Azure Blob storage client library for Python package and all the libraries on which it depends. В данном случае это только основная библиотека Azure для Python.In this case, that is just the Azure core library for Python.

Настройка платформы приложенияSet up the app framework

Из каталога проекта:From the project directory:

  1. Откройте новый текстовый файл в редакторе кода.Open a new text file in your code editor

  2. Добавьте в него операторы import.Add import statements

  3. Создайте структуру программы, включая простую обработку исключений.Create the structure for the program, including basic exception handling

    Вот этот код:Here's the code:

    import os, uuid
    from azure.storage.blob import BlobServiceClient, BlobClient, ContainerClient
    
    try:
        print("Azure Blob storage v12 - Python quickstart sample")
        # Quick start code goes here
    except Exception as ex:
        print('Exception:')
        print(ex)
    
  4. Сохраните новый файл как blob-quickstart-v12.py в каталоге blob-quickstart-v12.Save the new file as blob-quickstart-v12.py in the blob-quickstart-v12 directory.

Копирование учетных данных с портала AzureCopy your credentials from the Azure portal

Когда пример приложения выполняет запрос к службе хранилища Azure, он должен быть авторизован.When the sample application makes a request to Azure Storage, it must be authorized. Для авторизации запроса добавьте в приложение учетные данные учетной записи хранения в виде строки подключения.To authorize a request, add your storage account credentials to the application as a connection string. Чтобы просмотреть учетные данные учетной записи хранения, выполните следующие действия:View your storage account credentials by following these steps:

  1. Войдите на портал Azure.Sign in to the Azure portal.

  2. Перейдите к учетной записи хранения.Locate your storage account.

  3. В разделе Параметры учетной записи хранения выберите параметр Ключи доступа.In the Settings section of the storage account overview, select Access keys. На этой странице вы увидите ключи доступа к учетной записи и полную строку подключения для каждого ключа.Here, you can view your account access keys and the complete connection string for each key.

  4. Найдите значение для параметра Строка подключения в разделе Key1 и нажмите кнопку Скопировать, чтобы скопировать строку подключения.Find the Connection string value under key1, and select the Copy button to copy the connection string. На следующем этапе вы добавите значение строки подключения в переменную среды.You will add the connection string value to an environment variable in the next step.

    Снимок экрана, на котором показано, как скопировать строку подключения с портала Azure

Настройка строки подключения хранилищаConfigure your storage connection string

После копирования строки подключения запишите ее в переменной среды на локальном компьютере, где выполняется приложение.After you have copied your connection string, write it to a new environment variable on the local machine running the application. Чтобы задать переменную среды, откройте окно консоли и следуйте инструкциям для используемой операционной системы.To set the environment variable, open a console window, and follow the instructions for your operating system. Замените <yourconnectionstring> фактической строкой подключения.Replace <yourconnectionstring> with your actual connection string.

WindowsWindows

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

После добавления переменной среды в Windows вам необходимо запустить новый экземпляр командного окна.After you add the environment variable in Windows, you must start a new instance of the command window.

LinuxLinux

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

macOSmacOS

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

Перезапуск программRestart programs

После добавления переменной среды перезапустите все запущенные программы, которым может понадобиться считать переменную среды.After you add the environment variable, restart any running programs that will need to read the environment variable. Например, перезапустите среду разработки или редактор, прежде чем продолжить.For example, restart your development environment or editor before continuing.

Объектная модельObject model

Хранилище BLOB-объектов Azure оптимизировано для хранения больших объемов неструктурированных данных.Azure Blob storage is optimized for storing massive amounts of unstructured data. Неструктурированные данные — это данные, которые не соответствуют определенной модели данных или определению, например текстовых или двоичных данных.Unstructured data is data that does not adhere to a particular data model or definition, such as text or binary data. В хранилище BLOB-объектов предлагается три типа ресурсов:Blob storage offers three types of resources:

  • учетная запись хранения;The storage account
  • контейнер в учетной записи хранения;A container in the storage account
  • большой двоичный объект в контейнере.A blob in the container

На следующей схеме показана связь между этими ресурсами.The following diagram shows the relationship between these resources.

Схема архитектуры службы хранилища BLOB-объектов

Используйте следующие классы Python для взаимодействия с этими ресурсами.Use the following Python classes to interact with these resources:

  • BlobServiceClient. Класс BlobServiceClient позволяет управлять ресурсами службы хранилища Azure и контейнерами больших двоичных объектов.BlobServiceClient: The BlobServiceClient class allows you to manipulate Azure Storage resources and blob containers.
  • ContainerClient. Класс ContainerClient позволяет управлять контейнерами службы хранилища Azure и содержащимися в них большими двоичными объектами.ContainerClient: The ContainerClient class allows you to manipulate Azure Storage containers and their blobs.
  • BlobClient. Класс BlobClient позволяет управлять большими двоичными объектами службы хранилища Azure.BlobClient: The BlobClient class allows you to manipulate Azure Storage blobs.

Примеры кодаCode examples

В этих примерах фрагментов кода показано, как выполнять следующие действия с помощью клиентской библиотеки хранилища BLOB-объектов Azure для Python:These example code snippets show you how to perform the following with the Azure Blob storage client library for Python:

Получение строки подключенияGet the connection string

Приведенный ниже код извлекает строку подключения для учетной записи хранения из переменной среды, созданной в разделе Настройка строки подключения хранилища.The code below retrieves the connection string for the storage account from the environment variable created in the Configure your storage connection string section.

Добавьте этот код в блок try.Add this code inside the try block:

# Retrieve the connection string for use with the application. The storage
# connection string is stored in an environment variable on the machine
# running the application called AZURE_STORAGE_CONNECTION_STRING. If the environment variable is
# created after the application is launched in a console or with Visual Studio,
# the shell or application needs to be closed and reloaded to take the
# environment variable into account.
connect_str = os.getenv('AZURE_STORAGE_CONNECTION_STRING')

Создание контейнераCreate a container

Выберите имя нового контейнера.Decide on a name for the new container. Приведенный ниже код добавляет к имени контейнера значение UUID, чтобы сделать это имя уникальным.The code below appends a UUID value to the container name to ensure that it is unique.

Важно!

Имена контейнеров должны состоять из знаков нижнего регистра.Container names must be lowercase. Дополнительные сведения об именовании контейнеров и больших двоичных объектов см. в статье Naming and Referencing Containers, Blobs, and Metadata (Именование контейнеров, больших двоичных объектов и метаданных и ссылка на них).For more information about naming containers and blobs, see Naming and Referencing Containers, Blobs, and Metadata.

Создайте экземпляр класса BlobServiceClient, вызвав метод from_connection_string.Create an instance of the BlobServiceClient class by calling the from_connection_string method. Затем вызовите метод create_container, чтобы создать контейнер в учетной записи хранения.Then, call the create_container method to actually create the container in your storage account.

Добавьте следующий код в конец блока try.Add this code to the end of the try block:

# Create the BlobServiceClient object which will be used to create a container client
blob_service_client = BlobServiceClient.from_connection_string(connect_str)

# Create a unique name for the container
container_name = "quickstart" + str(uuid.uuid4())

# Create the container
container_client = blob_service_client.create_container(container_name)

Отправка больших двоичных объектов в контейнерUpload blobs to a container

Приведенный ниже фрагмент кода:The following code snippet:

  1. Создает текстовый файл в локальном каталоге.Creates a text file in the local directory.
  2. Возвращает ссылку на объект BlobClient, вызывая метод get_blob_client для BlobServiceClient из раздела Создание контейнера.Gets a reference to a BlobClient object by calling the get_blob_client method on the BlobServiceClient from the Create a container section.
  3. Передает локальный текстовый файл в большой двоичный объект, вызывая метод upload_blob.Uploads the local text file to the blob by calling the upload_blob method.

Добавьте следующий код в конец блока try.Add this code to the end of the try block:

# Create a file in local data directory to upload and download
local_path = "./data"
local_file_name = "quickstart" + str(uuid.uuid4()) + ".txt"
upload_file_path = os.path.join(local_path, local_file_name)

# Write text to the file
file = open(upload_file_path, 'w')
file.write("Hello, World!")
file.close()

# Create a blob client using the local file name as the name for the blob
blob_client = blob_service_client.get_blob_client(container=container_name, blob=local_file_name)

print("\nUploading to Azure Storage as blob:\n\t" + local_file_name)

# Upload the created file
with open(upload_file_path, "rb") as data:
    blob_client.upload_blob(data)

Перечисление BLOB-объектов в контейнереList the blobs in a container

Выведите список больших двоичных объектов в контейнере, вызвав метод list_blobs.List the blobs in the container by calling the list_blobs method. В этом случае в контейнер был добавлен лишь один большой двоичный объект, поэтому операция перечисления возвращает только его.In this case, only one blob has been added to the container, so the listing operation returns just that one blob.

Добавьте следующий код в конец блока try.Add this code to the end of the try block:

print("\nListing blobs...")

# List the blobs in the container
blob_list = container_client.list_blobs()
for blob in blob_list:
    print("\t" + blob.name)

Скачивание больших двоичных объектовDownload blobs

Скачайте созданный ранее большой двоичный объект, вызвав метод download_blob.Download the previously created blob by calling the download_blob method. Пример кода добавляет суффикс "DOWNLOAD" к имени файла, чтобы в локальной файловой системе можно было просмотреть оба файла.The example code adds a suffix of "DOWNLOAD" to the file name so that you can see both files in local file system.

Добавьте следующий код в конец блока try.Add this code to the end of the try block:

# Download the blob to a local file
# Add 'DOWNLOAD' before the .txt extension so you can see both files in the data directory
download_file_path = os.path.join(local_path, str.replace(local_file_name ,'.txt', 'DOWNLOAD.txt'))
print("\nDownloading blob to \n\t" + download_file_path)

with open(download_file_path, "wb") as download_file:
    download_file.write(blob_client.download_blob().readall())

Удаление контейнераDelete a container

Следующий код очищает созданные приложением ресурсы, полностью удаляя контейнер с помощью метода delete_container.The following code cleans up the resources the app created by removing the entire container using the delete_container method. Кроме того, при необходимости можно удалить локальные файлы.You can also delete the local files, if you like.

Приложение приостанавливается для ввода пользователя, вызывая input(), перед удалением большого двоичного объекта, контейнера и локальных файлов.The app pauses for user input by calling input() before it deletes the blob, container, and local files. Это хорошая возможность проверить правильность создания ресурсов перед их удалением.This is a good chance to verify that the resources were created correctly, before they are deleted.

Добавьте следующий код в конец блока try.Add this code to the end of the try block:

# Clean up
print("\nPress the Enter key to begin clean up")
input()

print("Deleting blob container...")
container_client.delete_container()

print("Deleting the local source and downloaded files...")
os.remove(upload_file_path)
os.remove(download_file_path)

print("Done")

Выполнение кодаRun the code

В этом приложении тестовый файл создается в локальной папке, а затем передается в хранилище BLOB-объектов.This app creates a test file in your local folder and uploads it to Blob storage. После этого выводится список больших двоичных объектов в контейнере, а затем файл загружается с новым именем, чтобы можно было сравнить старый и новый файлы.The example then lists the blobs in the container and downloads the file with a new name so that you can compare the old and new files.

Перейдите в каталог, содержащий файл blob-quickstart-v12.py, а затем выполните указанную команду python, чтобы запустить приложение.Navigate to the directory containing the blob-quickstart-v12.py file, then execute the following python command to run the app.

python blob-quickstart-v12.py

Вы должны увидеть выходные данные приложения, как показано ниже.The output of the app is similar to the following example:

Azure Blob storage v12 - Python quickstart sample

Uploading to Azure Storage as blob:
        quickstartcf275796-2188-4057-b6fb-038352e35038.txt

Listing blobs...
        quickstartcf275796-2188-4057-b6fb-038352e35038.txt

Downloading blob to
        ./data/quickstartcf275796-2188-4057-b6fb-038352e35038DOWNLOAD.txt

Press the Enter key to begin clean up

Deleting blob container...
Deleting the local source and downloaded files...
Done

Прежде чем начать удаление, проверьте наличие двух файлов в папке data.Before you begin the clean up process, check your data folder for the two files. Вы можете открыть их и убедиться, что они идентичны.You can open them and observe that they are identical.

После проверки файлов нажмите клавишу ВВОД, чтобы завершить работу с демонстрационной версией и удалить тестовые файлы.After you've verified the files, press the Enter key to delete the test files and finish the demo.

Дальнейшие действияNext steps

В этом кратком руководстве вы узнали, как передавать и скачивать большие двоичные объекты, а также выводить их список с помощью Python.In this quickstart, you learned how to upload, download, and list blobs using Python.

Чтобы просмотреть примеры приложений для хранилища BLOB-объектов, перейдите к следующему разделу:To see Blob storage sample apps, continue to: