improving AddressHelper utility functions

Author: DanielePalaia

examples/getting_started/main.py

@@ -1,57 +1,60 @@
 # type: ignore
+
+
 from rabbitmq_amqp_python_client import (
+    AddressHelper,
     BindingSpecification,
     Connection,
+    DeliveryConsumerHandler,
     Event,
     ExchangeSpecification,
     Message,
-    MessageAck,
-    MessagingHandler,
     QuorumQueueSpecification,
-    exchange_address,
-    queue_address,
 )
 
 
-class MyMessageHandler(MessagingHandler):
+class MyMessageHandler(DeliveryConsumerHandler):
 
     def __init__(self):
-        super().__init__(auto_accept=False, auto_settle=False)
+        super().__init__()
         self._count = 0
 
     def on_message(self, event: Event):
         print("received message: " + str(event.message.annotations))
 
         # accepting
-        MessageAck.accept(event)
+        self.delivery_context.accept(event)
 
         # in case of rejection (+eventually deadlettering)
-        # MessageAck.discard(event)
+        # self.delivery_context.discard(event)
 
         # in case of requeuing
-        # MessageAck.requeue(event)
+        # self.delivery_context.requeue(event)
 
         # annotations = {}
         # annotations[symbol('x-opt-string')] = 'x-test1'
         # in case of requeuing with annotations added
-        # MessageAck.requeue_with_annotations(event, annotations)
+        # self.delivery_context.requeue_with_annotations(event, annotations)
 
         # in case of rejection with annotations added
-        # MessageAck.discard_with_annotations(event)
+        # self.delivery_context.discard_with_annotations(event)
 
         print("count " + str(self._count))
 
         self._count = self._count + 1
 
         if self._count == 100:
             print("closing receiver")
-            event.receiver.close()
-            event.connection.close()
+            # if you want you can add cleanup operations here
+            # event.receiver.close()
+            # event.connection.close()
 
     def on_connection_closed(self, event: Event):
+        # if you want you can add cleanup operations here
         print("connection closed")
 
     def on_link_closed(self, event: Event) -> None:
+        # if you want you can add cleanup operations here
         print("link closed")
 
 
@@ -91,9 +94,9 @@ def main() -> None:
         )
     )
 
-    addr = exchange_address(exchange_name, routing_key)
+    addr = AddressHelper.exchange_address(exchange_name, routing_key)
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     print("create a publisher and publish a test message")
     publisher = connection.publisher(addr)
@@ -102,7 +105,7 @@ def main() -> None:
     messages_purged = management.purge_queue(queue_name)
 
     print("messages purged: " + str(messages_purged))
-    management.close()
+    # management.close()
 
     # publish 10 messages
     for i in range(messages_to_publish):
@@ -121,22 +124,22 @@ def main() -> None:
         pass
 
     print("cleanup")
-    # once we finish consuming we close the connection so we need to create a new one
-    connection = create_connection()
+    consumer.close()
+    # once we finish consuming if we close the connection we need to create a new one
+    # connection = create_connection()
+    # management = connection.management()
 
-    management = connection.management()
     print("unbind")
     management.unbind(bind_name)
 
     print("delete queue")
-    # management.delete_queue(queue_name)
+    management.delete_queue(queue_name)
 
     print("delete exchange")
     management.delete_exchange(exchange_name)
 
     print("closing connections")
     management.close()
-    # consumer.close()
     print("after management closing")
     connection.close()
     print("after connection closing")

rabbitmq_amqp_python_client/__init__.py

@@ -1,15 +1,17 @@
 from importlib import metadata
 
-from .address_helper import exchange_address, queue_address
+from .address_helper import AddressHelper
 from .common import ExchangeType, QueueType
 from .connection import Connection
 from .consumer import Consumer
+from .delivery_consumer_handler import (
+    DeliveryConsumerHandler,
+)
 from .entities import (
     BindingSpecification,
     ExchangeSpecification,
 )
 from .management import Management
-from .message_ack import MessageAck
 from .publisher import Publisher
 from .qpid.proton._data import symbol  # noqa: E402
 from .qpid.proton._delivery import Delivery
@@ -41,14 +43,13 @@
     "BindingSpecification",
     "QueueType",
     "Publisher",
-    "exchange_address",
-    "queue_address",
     "Message",
     "Consumer",
     "MessagingHandler",
     "Event",
     "Delivery",
-    "MessageAck",
     "symbol",
     "ExchangeType",
+    "AddressHelper",
+    "DeliveryConsumerHandler",
 ]

rabbitmq_amqp_python_client/address_helper.py

@@ -1,7 +1,7 @@
 from .entities import BindingSpecification
 
 
-def is_unreserved(char: str) -> bool:
+def _is_unreserved(char: str) -> bool:
     # According to RFC 3986, unreserved characters are A-Z, a-z, 0-9, '-', '.', '_', and '~'
     return char.isalnum() or char in "-._~"
 
@@ -12,7 +12,7 @@ def encode_path_segment(input_string: str) -> str:
     # Iterate over each character in the input string
     for char in input_string:
         # Check if the character is an unreserved character
-        if is_unreserved(char):
+        if _is_unreserved(char):
             encoded.append(char)  # Append as is
         else:
             # Encode character to %HH format
@@ -21,49 +21,54 @@ def encode_path_segment(input_string: str) -> str:
     return "".join(encoded)
 
 
-def exchange_address(exchange_name: str, routing_key: str = "") -> str:
-    if routing_key == "":
-        path = "/exchanges/" + encode_path_segment(exchange_name)
-    else:
-        path = (
-            "/exchanges/"
-            + encode_path_segment(exchange_name)
-            + "/"
-            + encode_path_segment(routing_key)
-        )
-
-    return path
-
+class AddressHelper:
 
-def queue_address(queue_name: str) -> str:
-    path = "/queues/" + encode_path_segment(queue_name)
-
-    return path
+    @staticmethod
+    def exchange_address(exchange_name: str, routing_key: str = "") -> str:
+        if routing_key == "":
+            path = "/exchanges/" + encode_path_segment(exchange_name)
+        else:
+            path = (
+                "/exchanges/"
+                + encode_path_segment(exchange_name)
+                + "/"
+                + encode_path_segment(routing_key)
+            )
 
+        return path
 
-def purge_queue_address(queue_name: str) -> str:
-    path = "/queues/" + encode_path_segment(queue_name) + "/messages"
+    @staticmethod
+    def queue_address(queue_name: str) -> str:
+        path = "/queues/" + encode_path_segment(queue_name)
 
-    return path
+        return path
 
+    @staticmethod
+    def purge_queue_address(queue_name: str) -> str:
+        path = "/queues/" + encode_path_segment(queue_name) + "/messages"
 
-def path_address() -> str:
-    path = "/bindings"
+        return path
 
-    return path
+    @staticmethod
+    def path_address() -> str:
+        path = "/bindings"
 
+        return path
 
-def binding_path_with_exchange_queue(bind_specification: BindingSpecification) -> str:
-    binding_path_wth_exchange_queue_key = (
-        "/bindings"
-        + "/"
-        + "src="
-        + encode_path_segment(bind_specification.source_exchange)
-        + ";"
-        + "dstq="
-        + encode_path_segment(bind_specification.destination_queue)
-        + ";key="
-        + encode_path_segment(bind_specification.binding_key)
-        + ";args="
-    )
-    return binding_path_wth_exchange_queue_key
+    @staticmethod
+    def binding_path_with_exchange_queue(
+        bind_specification: BindingSpecification,
+    ) -> str:
+        binding_path_wth_exchange_queue_key = (
+            "/bindings"
+            + "/"
+            + "src="
+            + encode_path_segment(bind_specification.source_exchange)
+            + ";"
+            + "dstq="
+            + encode_path_segment(bind_specification.destination_queue)
+            + ";key="
+            + encode_path_segment(bind_specification.binding_key)
+            + ";args="
+        )
+        return binding_path_wth_exchange_queue_key

rabbitmq_amqp_python_client/connection.py

@@ -32,7 +32,9 @@ def management(self) -> Management:
     # closes the connection to the AMQP 1.0 server.
     def close(self) -> None:
         logger.debug("Closing connection")
+        print("closing connection")
         self._conn.close()
+        print("after closing connection")
 
     def publisher(self, destination: str) -> Publisher:
         publisher = Publisher(self._conn, destination)

rabbitmq_amqp_python_client/delivery_consumer_handler.py

@@ -0,0 +1,10 @@
+from .delivery_context import DeliveryContext
+from .qpid.proton.handlers import MessagingHandler
+
+
+class DeliveryConsumerHandler(MessagingHandler):  # type: ignore
+
+    def __init__(self, auto_accept: bool = False, auto_settle: bool = True):
+        super().__init__(auto_accept=auto_accept, auto_settle=auto_settle)
+        self._count = 0
+        self.delivery_context: DeliveryContext = DeliveryContext()

rabbitmq_amqp_python_client/message_ack.py renamed to rabbitmq_amqp_python_client/delivery_context.py

@@ -5,23 +5,20 @@
 from .qpid.proton._events import Event
 
 
-class MessageAck:
+class DeliveryContext:
 
-    @staticmethod
-    def accept(event: Event) -> None:
+    def accept(self, event: Event) -> None:
         dlv = event.delivery
         dlv.update(Delivery.ACCEPTED)
         dlv.settle()
 
-    @staticmethod
-    def discard(event: Event) -> None:
+    def discard(self, event: Event) -> None:
         dlv = event.delivery
         dlv.update(Delivery.REJECTED)
         dlv.settle()
 
-    @staticmethod
     def discard_with_annotations(
-        event: Event, annotations: Dict[str, "PythonAMQPData"]
+        self, event: Event, annotations: Dict[str, "PythonAMQPData"]
     ) -> None:
         dlv = event.delivery
         dlv.local.annotations = annotations
@@ -31,15 +28,13 @@ def discard_with_annotations(
         dlv.update(Delivery.MODIFIED)
         dlv.settle()
 
-    @staticmethod
-    def requeue(event: Event) -> None:
+    def requeue(self, event: Event) -> None:
         dlv = event.delivery
         dlv.update(Delivery.RELEASED)
         dlv.settle()
 
-    @staticmethod
     def requeue_with_annotations(
-        event: Event, annotations: Dict[str, "PythonAMQPData"]
+        self, event: Event, annotations: Dict[str, "PythonAMQPData"]
     ) -> None:
         dlv = event.delivery
         dlv.local.annotations = annotations