amqp-client-python 0.1.13__py3-none-any.whl → 0.2.0__py3-none-any.whl

amqp_client_python/__init__.py

@@ -1,3 +1,4 @@
 from .rabbitmq import EventbusRabbitMQ, AsyncEventbusRabbitMQ, EventbusWrapperRabbitMQ
 from .domain.models import Config, Options, SSLOptions
+from .domain.utils import ConnectionType
 from pika import DeliveryMode

amqp_client_python/domain/models/config.py

@@ -9,22 +9,58 @@ class Config:
     def __init__(
         self, options: Options, ssl_options: Optional[SSLOptions] = None
     ) -> None:
+        """
+        Create an Config object thats hold and mount the connection information.
+
+        Args:
+            options: hold information for estabilish connection
+            ssl_options: hold information for estabilish SSL connections
+
+        Returns:
+
+        Raises:
+
+        Examples:
+            >>> Config(
+                    Options("example", "example.rpc", "example.rpc", "amqp://admin:admin@localhost:5672/"),
+                    SSLOptions("./.certs/cert.pem", "./.certs/privkey.pem", "./.certs/ca.pem")
+                )
+        """
         self.url = None
         self.options = options
         self.ssl_options = ssl_options
 
-    def build(self):
+    def build(self) -> "Config":
+        """
+        Create an Config object thats hold and mount the connection information.
+
+        Args:
+
+        Returns:
+            Config object
+
+        Raises:
+
+        Examples:
+            >>> config.build()
+        """
         opt = {
             **self.options.kwargs,
             "heartbeat": self.options.heartbeat,
         }
-        if bool(self.ssl_options):
+        if self.ssl_options is not None:
+            protocol = "amqps"
+            if self.options.port is None:
+                self.options.port = 5671
             opt["ssl_options"] = {
-                "certfile": self.ssl_options.certfile_path,
                 "keyfile": self.ssl_options.keyfile_path,
+                "certfile": self.ssl_options.certfile_path,
                 "ca_certs": self.ssl_options.ca_certs_path,
             }
-        protocol = "amqps" if bool(self.ssl_options) else "amqp"
+        else:
+            protocol = "amqp"
+            if self.options.port is None:
+                self.options.port = 5672
         if self.options.uri:
             url = "{}?{} ".format(self.options.uri, urlencode(opt))
         else:

amqp_client_python/domain/models/options.py

@@ -7,16 +7,48 @@ class Options:
         queue_name: str,
         rpc_queue_name: str,
         rpc_exchange_name: str,
-        uri: str = None,
+        uri: Optional[str] = None,
         login: str = "guest",
         passwd: str = "guest",
         domain: str = "localhost",
-        port: int = 5672,
+        port: Optional[int] = None,
         vhost: str = "/",
         heartbeat: Optional[int] = 60,
-        publisher_confirms=False,
+        publisher_confirms: bool = False,
         **kwargs: Dict[str, Any]
     ) -> None:
+        """
+        Create an Options object that hold the credentials and configs options.
+
+        Args:
+            queue_name: name of queue that will be used for subscriptions
+            rpc_queue_name: name of queue that will be used for provide resources
+            rpc_exchange_name: name of exchange that will be used for provide resources
+            uri: uri for connection
+            login: username
+            passwd: password
+            domain: domain
+            port: port information
+            vhost: vhost information
+            heartbeat: interval between heartbeat
+            publisher_confirms: wait for publisher confirmations
+            **kwargs: pika options
+
+        Returns:
+
+        Raises:
+
+        Examples:
+            >>> Options("example", "example.rpc", "example.rpc", "amqp://admin:admin@localhost:5672/")
+
+            >>> Options("example", "example.rpc", "example.rpc", "amqps://admin:admin@localhost:5671/")
+
+            >>> Options("example", "example.rpc", "example.rpc", login="admin", passwd="admin",
+                    domain="localhost", port=5672)
+
+            >>> Options("example", "example.rpc", "example.rpc", login="admin", passwd="admin",
+                    domain="localhost", port=5671)
+        """
         self.queue_name = queue_name
         self.rpc_queue_name = rpc_queue_name
         self.rpc_exchange_name = rpc_exchange_name

amqp_client_python/domain/models/ssl_options.py

@@ -2,6 +2,22 @@ class SSLOptions:
     def __init__(
         self, certfile_path: str, keyfile_path: str, ca_certs_path: str
     ) -> None:
+        """
+        Create an SslOptions object that hold the certs paths.
+
+        Args:
+            certfile_path: cert file path string
+            keyfile_path: private key file path string
+            ca_certs_path: ca file path string
+
+        Returns:
+            Um dicionário com as notas da escala e os graus.
+
+        Raises:
+
+        Examples:
+            >>> SSLOptions("./.certs/cert.pem", "./.certs/privkey.pem", "./.certs/ca.pem")
+        """
         self.certfile_path = certfile_path
         self.keyfile_path = keyfile_path
         self.ca_certs_path = ca_certs_path

amqp_client_python/domain/utils/__init__.py

@@ -0,0 +1,2 @@
+from .connection_type import ConnectionType
+from .types import HandlerType

amqp_client_python/domain/utils/connection_type.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class ConnectionType(Enum):
+    PUBLISH = "publish"
+    SUBSCRIBE = "subscribe"
+    RPC_CLIENT = "rpc_client"
+    RPC_SERVER = "rpc_server"

amqp_client_python/domain/utils/types.py

@@ -0,0 +1,7 @@
+from typing import TypedDict, Optional, Callable
+
+
+class HandlerType(TypedDict):
+    response_timeout: Optional[int]
+    handle: Callable
+    content_type: str

amqp_client_python/event/__init__.py

@@ -1,2 +1,6 @@
 from .integration_event import IntegrationEvent
 from .integration_event_handler import IntegrationEventHandler
+from .async_provider_handler import AsyncProviderHandler
+from .async_subscriber_handler import AsyncSubscriberHandler
+from .provider_handler import ProviderHandler
+from .subscriber_handler import SubscriberHandler

amqp_client_python/event/async_provider_handler.py

@@ -0,0 +1,9 @@
+from typing import Union, List, Any
+from abc import ABC, abstractmethod
+
+
+class AsyncProviderHandler(ABC):
+
+    @abstractmethod
+    async def handle(self, body: List[Any]) -> Union[bytes, str]:
+        raise NotImplementedError

amqp_client_python/event/async_subscriber_handler.py

@@ -0,0 +1,9 @@
+from typing import List, Any
+from abc import ABC, abstractmethod
+
+
+class AsyncSubscriberHandler(ABC):
+
+    @abstractmethod
+    async def handle(self, body: List[Any]) -> None:
+        raise NotImplementedError

amqp_client_python/event/event.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Event(Enum):
+    CONNECTED = "connected"
+    CONNECTING_BEFORE = "connecting.before"

amqp_client_python/event/provider_handler.py

@@ -0,0 +1,9 @@
+from typing import Union, List, Any
+from abc import ABC, abstractmethod
+
+
+class ProviderHandler(ABC):
+
+    @abstractmethod
+    def handle(self, body: List[Any]) -> Union[bytes, str]:
+        raise NotImplementedError

amqp_client_python/event/subscriber_handler.py

@@ -0,0 +1,9 @@
+from typing import List, Any
+from abc import ABC, abstractmethod
+
+
+class SubscriberHandler(ABC):
+
+    @abstractmethod
+    def handle(self, body: List[Any]) -> None:
+        raise NotImplementedError

amqp_client_python/exceptions/auto_reconnect_exception.py

@@ -2,8 +2,8 @@ from .eventbus_exception import EventBusException
 
 
 class AutoReconnectException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
     def __init__(self, message, description="") -> None:
         self.message = message

amqp_client_python/exceptions/blocking_exception.py

@@ -2,9 +2,9 @@ from .eventbus_exception import EventBusException
 
 
 class BlockingException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
-    def __init__(self, message, description="") -> None:
+    def __init__(self, message: str, description="") -> None:
         self.message = message
         self.description = description

amqp_client_python/exceptions/eventbus_exception.py

@@ -1,7 +1,7 @@
 class EventBusException(Exception):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
-    def __init__(self, message, description="") -> None:
+    def __init__(self, message: str, description="") -> None:
         self.message = message
         self.description = description

amqp_client_python/exceptions/nack_exception.py

@@ -2,8 +2,8 @@ from .eventbus_exception import EventBusException
 
 
 class NackException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
     def __init__(self, message, description="") -> None:
         self.message = message

amqp_client_python/exceptions/publish_timeout_exception.py

@@ -2,8 +2,8 @@ from .timeout_exception import TimeoutException
 
 
 class PublishTimeoutException(TimeoutException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
     def __init__(self, message, description="") -> None:
         self.message = message

amqp_client_python/exceptions/response_timeout_exception.py

@@ -2,8 +2,8 @@ from .timeout_exception import TimeoutException
 
 
 class ResponseTimeoutException(TimeoutException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
     def __init__(self, message, description="") -> None:
         self.message = message

amqp_client_python/exceptions/rpc_provider_exception.py

@@ -2,9 +2,9 @@ from .eventbus_exception import EventBusException
 
 
 class RpcProviderException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
-    def __init__(self, message, description="") -> None:
+    def __init__(self, message: str, description="") -> None:
         self.message = message
         self.description = description

amqp_client_python/exceptions/thread_unsafe_exception.py

@@ -2,9 +2,9 @@ from .eventbus_exception import EventBusException
 
 
 class ThreadUnsafeException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
-    def __init__(self, message, description="") -> None:
+    def __init__(self, message: str, description="") -> None:
         self.message = message
         self.description = description

amqp_client_python/exceptions/timeout_exception.py

@@ -2,8 +2,8 @@ from .eventbus_exception import EventBusException
 
 
 class TimeoutException(EventBusException):
-    message: str = None
-    description: str = None
+    message: str = ""
+    description: str = ""
 
     def __init__(self, message, description="") -> None:
         self.message = message

amqp_client_python/rabbitmq/__init__.py

@@ -1,6 +1,6 @@
 from .async_eventbus_rabbitmq import AsyncEventbusRabbitMQ
 from .async_connection_factory import AsyncConnectionFactoryRabbitMQ
-from .async_connection import AsyncConnection
+from .async_connection import AsyncConnection, ConnectionType
 from .async_channel_factory import AsyncChannelFactoryRabbitMQ
 from .async_channel import AsyncChannel
 from .eventbus_rabbitmq import EventbusRabbitMQ