improving AddressHelper utility functions

Author: DanielePalaia

examples/getting_started/main.py

@@ -1,5 +1,6 @@
 # type: ignore
 from rabbitmq_amqp_python_client import (
+    AddressHelper,
     BindingSpecification,
     Connection,
     Event,
@@ -8,8 +9,6 @@
     MessageAck,
     MessagingHandler,
     QuorumQueueSpecification,
-    exchange_address,
-    queue_address,
 )
 
 
@@ -91,9 +90,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)

rabbitmq_amqp_python_client/__init__.py

@@ -1,6 +1,6 @@
 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
@@ -41,8 +41,6 @@
     "BindingSpecification",
     "QueueType",
     "Publisher",
-    "exchange_address",
-    "queue_address",
     "Message",
     "Consumer",
     "MessagingHandler",
@@ -51,4 +49,5 @@
     "MessageAck",
     "symbol",
     "ExchangeType",
+    "AddressHelper",
 ]

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/management.py

@@ -2,13 +2,7 @@
 import uuid
 from typing import Any, Optional, Union
 
-from .address_helper import (
-    binding_path_with_exchange_queue,
-    exchange_address,
-    path_address,
-    purge_queue_address,
-    queue_address,
-)
+from .address_helper import AddressHelper
 from .common import CommonValues, QueueType
 from .entities import (
     BindingSpecification,
@@ -113,7 +107,7 @@ def declare_exchange(
         body["internal"] = exchange_specification.is_internal
         body["arguments"] = exchange_specification.arguments  # type: ignore
 
-        path = exchange_address(exchange_specification.name)
+        path = AddressHelper.exchange_address(exchange_specification.name)
 
         self.request(
             body,
@@ -146,7 +140,7 @@ def declare_queue(
         elif isinstance(queue_specification, StreamSpecification):
             body = self._declare_stream(queue_specification)
 
-        path = queue_address(queue_specification.name)
+        path = AddressHelper.queue_address(queue_specification.name)
 
         self.request(
             body,
@@ -255,7 +249,7 @@ def _declare_stream(
 
     def delete_exchange(self, exchange_name: str) -> None:
         logger.debug("delete_exchange operation called")
-        path = exchange_address(exchange_name)
+        path = AddressHelper.exchange_address(exchange_name)
 
         self.request(
             None,
@@ -268,7 +262,7 @@ def delete_exchange(self, exchange_name: str) -> None:
 
     def delete_queue(self, queue_name: str) -> None:
         logger.debug("delete_queue operation called")
-        path = queue_address(queue_name)
+        path = AddressHelper.queue_address(queue_name)
 
         self.request(
             None,
@@ -302,7 +296,7 @@ def bind(self, bind_specification: BindingSpecification) -> str:
         body["destination_queue"] = bind_specification.destination_queue
         body["arguments"] = {}  # type: ignore
 
-        path = path_address()
+        path = AddressHelper.path_address()
 
         self.request(
             body,
@@ -313,7 +307,9 @@ def bind(self, bind_specification: BindingSpecification) -> str:
             ],
         )
 
-        binding_path_with_queue = binding_path_with_exchange_queue(bind_specification)
+        binding_path_with_queue = AddressHelper.binding_path_with_exchange_queue(
+            bind_specification
+        )
         return binding_path_with_queue
 
     def unbind(self, binding_exchange_queue_path: str) -> None:
@@ -329,7 +325,7 @@ def unbind(self, binding_exchange_queue_path: str) -> None:
 
     def purge_queue(self, queue_name: str) -> int:
         logger.debug("purge_queue operation called")
-        path = purge_queue_address(queue_name)
+        path = AddressHelper.purge_queue_address(queue_name)
 
         response = self.request(
             None,
@@ -344,7 +340,7 @@ def purge_queue(self, queue_name: str) -> int:
 
     def queue_info(self, queue_name: str) -> QueueInfo:
         logger.debug("queue_info operation called")
-        path = queue_address(queue_name)
+        path = AddressHelper.queue_address(queue_name)
 
         message = self.request(
             None,

tests/conftest.py

@@ -1,11 +1,11 @@
 import pytest
 
 from rabbitmq_amqp_python_client import (
+    AddressHelper,
     Connection,
     Event,
     MessageAck,
     MessagingHandler,
-    queue_address,
     symbol,
 )
 
@@ -40,7 +40,7 @@ def consumer(pytestconfig):
     connection.dial()
     try:
         queue_name = "test-queue"
-        addr_queue = queue_address(queue_name)
+        addr_queue = AddressHelper.queue_address(queue_name)
         consumer = connection.consumer(addr_queue)
         yield consumer
 

tests/test_address_helper.py

@@ -1,28 +1,25 @@
-from rabbitmq_amqp_python_client import (
-    exchange_address,
-    queue_address,
-)
+from rabbitmq_amqp_python_client import AddressHelper
 
 
 def test_encoding_queue_simple() -> None:
     queue = "my_queue"
 
-    address = queue_address(queue)
+    address = AddressHelper.queue_address(queue)
 
     assert address == "/queues/my_queue"
 
 
 def test_encoding_queue_hex() -> None:
     queue = "my_queue>"
 
-    address = queue_address(queue)
+    address = AddressHelper.queue_address(queue)
 
     assert address == "/queues/my_queue%3E"
 
 
 def test_encoding_exchange_hex() -> None:
     queue = "my_exchange/()"
 
-    address = exchange_address(queue)
+    address = AddressHelper.exchange_address(queue)
 
     assert address == "/exchanges/my_exchange%2F%28%29"

tests/test_consumer.py

@@ -1,7 +1,7 @@
 from rabbitmq_amqp_python_client import (
+    AddressHelper,
     Connection,
     QuorumQueueSpecification,
-    queue_address,
 )
 
 from .conftest import (
@@ -29,7 +29,7 @@ def test_consumer_sync_queue_accept(connection: Connection) -> None:
 
     management.declare_queue(QuorumQueueSpecification(name=queue_name))
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
     consumer = connection.consumer(addr_queue)
 
     consumed = 0
@@ -61,7 +61,7 @@ def test_consumer_async_queue_accept(connection: Connection) -> None:
 
     management.declare_queue(QuorumQueueSpecification(name=queue_name))
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     publish_messages(connection, messages_to_send, queue_name)
 
@@ -99,7 +99,7 @@ def test_consumer_async_queue_no_ack(connection: Connection) -> None:
 
     management.declare_queue(QuorumQueueSpecification(name=queue_name))
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     publish_messages(connection, messages_to_send, queue_name)
 
@@ -138,7 +138,7 @@ def test_consumer_async_queue_with_discard(connection: Connection) -> None:
 
     # configuring dead lettering
     bind_path = setup_dead_lettering(management)
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     management.declare_queue(
         QuorumQueueSpecification(
@@ -204,8 +204,8 @@ def test_consumer_async_queue_with_discard_with_annotations(
     publish_messages(connection, messages_to_send, queue_name)
 
     bind_path = setup_dead_lettering(management)
-    addr_queue = queue_address(queue_name)
-    addr_queue_dl = queue_address(queue_dead_lettering)
+    addr_queue = AddressHelper.queue_address(queue_name)
+    addr_queue_dl = AddressHelper.queue_address(queue_dead_lettering)
 
     # workaround: it looks like when the consumer finish to consume invalidate the connection
     # so for the moment we need to use one dedicated
@@ -254,7 +254,7 @@ def test_consumer_async_queue_with_requeue(connection: Connection) -> None:
 
     management.declare_queue(QuorumQueueSpecification(name=queue_name))
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     publish_messages(connection, messages_to_send, queue_name)
 
@@ -293,7 +293,7 @@ def test_consumer_async_queue_with_requeue_with_annotations(
 
     management.declare_queue(QuorumQueueSpecification(name=queue_name))
 
-    addr_queue = queue_address(queue_name)
+    addr_queue = AddressHelper.queue_address(queue_name)
 
     publish_messages(connection, messages_to_send, queue_name)