Jak používat azure queue Storage z Pythonu

pip install azure-storage-queue

pip install azure-storage-queue==2.1.0

Objekt QueueClient umožňuje pracovat s frontou. Do horní části libovolného souboru Pythonu, ve kterém chcete programově přistupovat k frontě Azure, přidejte následující kód:

from azure.storage.queue import (
        QueueClient,
        BinaryBase64EncodePolicy,
        BinaryBase64DecodePolicy
)

import os, uuid

Objekt QueueService umožňuje pracovat s frontami. Následující kód vytvoří QueueService objekt . Do horní části libovolného souboru Pythonu, ve kterém chcete programově přistupovat k souboru, přidejte následující Azure Storage:

from azure.storage.queue import (
        QueueService,
        QueueMessageFormat
)

import os, uuid

Následující kód vytvoří objekt QueueClient pomocí připojovacího řetězce úložiště.

# Retrieve the connection string from an environment
# variable named AZURE_STORAGE_CONNECTION_STRING
connect_str = os.getenv("AZURE_STORAGE_CONNECTION_STRING")

# Create a unique name for the queue
q_name = "queue-" + str(uuid.uuid4())

# Instantiate a QueueClient object which will
# be used to create and manipulate the queue
print("Creating queue: " + q_name)
queue_client = QueueClient.from_connection_string(connect_str, q_name)

# Create the queue
queue_client.create_queue()

Následující kód vytvoří objekt QueueService pomocí připojovacího řetězce úložiště.

# Retrieve the connection string from an environment
# variable named AZURE_STORAGE_CONNECTION_STRING
connect_str = os.getenv("AZURE_STORAGE_CONNECTION_STRING")

# Create a unique name for the queue
queue_name = "queue-" + str(uuid.uuid4())

# Create a QueueService object which will
# be used to create and manipulate the queue
print("Creating queue: " + queue_name)
queue_service = QueueService(connection_string=connect_str)

# Create the queue
queue_service.create_queue(queue_name)

Při vytváření objektu klienta nakonfigurujte funkce kódování a dekódování Base64.

# Setup Base64 encoding and decoding functions
base64_queue_client = QueueClient.from_connection_string(
                            conn_str=connect_str, queue_name=q_name,
                            message_encode_policy = BinaryBase64EncodePolicy(),
                            message_decode_policy = BinaryBase64DecodePolicy()
                        )

Nakonfigurujte funkce kódování a dekódování Base64 u Storage queue.

# Setup Base64 encoding and decoding functions
queue_service.encode_function = QueueMessageFormat.binary_base64encode
queue_service.decode_function = QueueMessageFormat.binary_base64decode

Pokud chcete vložit zprávu do fronty, použijte send_message metodu .

message = u"Hello World"
print("Adding message: " + message)
queue_client.send_message(message)

Pokud chcete vložit zprávu do fronty, pomocí put_message metody vytvořte novou zprávu a přidejte ji do fronty.

message = u"Hello, World"
print("Adding message: " + message)
queue_service.put_message(queue_name, message)

Můžete se podívat na zprávy, aniž byste je odebírali z fronty voláním peek_messages metody . Ve výchozím nastavení tato metoda zobrazí náhled jedné zprávy.

# Peek at the first message
messages = queue_client.peek_messages()

for peeked_message in messages:
    print("Peeked message: " + peeked_message.content)

Můžete se podívat na zprávy, aniž byste je odebírali z fronty voláním peek_messages metody . Ve výchozím nastavení tato metoda zobrazí náhled jedné zprávy.

messages = queue_service.peek_messages(queue_name)

for peeked_message in messages:
    print("Peeked message: " + peeked_message.content)

Následující kód používá update_message metodu k aktualizaci zprávy. Časový limit viditelnosti je nastavený na hodnotu 0, což znamená, že se zpráva zobrazí okamžitě a obsah se aktualizuje.

messages = queue_client.receive_messages()
list_result = next(messages)

message = queue_client.update_message(
        list_result.id, list_result.pop_receipt,
        visibility_timeout=0, content=u'Hello World Again')

print("Updated message to: " + message.content)

Následující kód používá update_message metodu k aktualizaci zprávy. Časový limit viditelnosti je nastavený na hodnotu 0, což znamená, že se zpráva zobrazí okamžitě a obsah se aktualizuje.

messages = queue_service.get_messages(queue_name)

for message in messages:
    queue_service.update_message(
        queue_name, message.id, message.pop_receipt, 0, u"Hello, World Again")

Metoda get_queue_properties vrací vlastnosti fronty včetně approximate_message_count .

properties = queue_client.get_queue_properties()
count = properties.approximate_message_count
print("Message count: " + str(count))

Metoda get_queue_metadata vrátí vlastnosti fronty včetně approximate_message_count .

metadata = queue_service.get_queue_metadata(queue_name)
count = metadata.approximate_message_count
print("Message count: " + str(count))

Při volání receive_messagesse ve výchozím nastavení zobrazí další zpráva ve frontě. Zpráva vrácená z se receive_messages stane neviditelnou pro jakýkoli jiný kód, který čte zprávy z této fronty. Ve výchozím nastavení tato zpráva zůstává neviditelná po dobu 30 sekund. Pokud chcete dokončit odebrání zprávy z fronty, musíte také zavolat delete_message.

messages = queue_client.receive_messages()

for message in messages:
    print("Dequeueing message: " + message.content)
    queue_client.delete_message(message.id, message.pop_receipt)

Při volání get_messagesse ve výchozím nastavení zobrazí další zpráva ve frontě. Zpráva vrácená z se get_messages stane neviditelnou pro jakýkoli jiný kód, který čte zprávy z této fronty. Ve výchozím nastavení tato zpráva zůstává neviditelná po dobu 30 sekund. Pokud chcete dokončit odebrání zprávy z fronty, musíte také zavolat delete_message.

messages = queue_service.get_messages(queue_name)

for message in messages:
    print("Deleting message: " + message.content)
    queue_service.delete_message(queue_name, message.id, message.pop_receipt)

Následující příklad kódu používá receive_messages metodu k získání zpráv v dávkách. Potom zpracuje každou zprávu v rámci každé dávky pomocí vnořené for smyčky. Také se pro každou zprávu nastaví časový limit neviditelnosti 5 minut.

messages = queue_client.receive_messages(messages_per_page=5, visibility_timeout=5*60)

for msg_batch in messages.by_page():
   for msg in msg_batch:
      print("Batch dequeue message: " + msg.content)
      queue_client.delete_message(msg)

Následující příklad kódu používá get_messages metodu k získání 16 zpráv v jednom volání. Pak každou zprávu zpracuje pomocí for smyčky . Také se pro každou zprávu nastaví časový limit neviditelnosti 5 minut.

messages = queue_service.get_messages(queue_name, num_messages=16, visibility_timeout=5*60)

for message in messages:
    print("Deleting message: " + message.content)
    queue_service.delete_message(queue_name, message.id, message.pop_receipt)

Pokud chcete odstranit frontu a všechny zprávy, které obsahuje, zavolejte delete_queue metodu .

print("Deleting queue: " + queue_client.queue_name)
queue_client.delete_queue()

Pokud chcete odstranit frontu a všechny zprávy, které obsahuje, zavolejte delete_queue metodu .

print("Deleting queue: " + queue_name)
queue_service.delete_queue(queue_name)