Refactor import statements for consistency and clarity across multiple modules

Author: grongierisc

src/iop/_async_request.py

@@ -1,8 +1,9 @@
 import asyncio
-from . import _iris
 from typing import Any, Optional, Union
-from iop._dispatch import dispatch_deserializer, dispatch_serializer
-from iop._message import _Message as Message
+
+from . import _iris
+from ._dispatch import dispatch_deserializer, dispatch_serializer
+from ._message import _Message as Message
 
 class AsyncRequest(asyncio.Future):
     _message_header_id: int = 0
@@ -19,6 +20,8 @@ def __init__(self, target: str, request: Union[Message, Any],
         self.timeout = timeout
         self.description = description
         self.host = host
+        if host is None:
+            raise ValueError("host parameter cannot be None")
         self._iris_handle = host.iris_handle
         asyncio.create_task(self.send())
 

src/iop/_business_host.py

@@ -2,12 +2,11 @@
 from typing import Any,List, Optional, Tuple, Union
 
 from . import _iris
-
-from iop._common import _Common
-from iop._message import _Message as Message
-from iop._decorators import input_serializer_param, output_deserializer
-from iop._dispatch import dispatch_serializer, dispatch_deserializer
-from iop._async_request import AsyncRequest
+from ._common import _Common
+from ._message import _Message as Message
+from ._decorators import input_serializer_param, output_deserializer
+from ._dispatch import dispatch_serializer, dispatch_deserializer
+from ._async_request import AsyncRequest
 
 class _BusinessHost(_Common):
     """Base class for business components that defines common methods.

src/iop/_business_operation.py

@@ -1,8 +1,9 @@
 import importlib
 from typing import Any, List, Optional, Union, Tuple
-from iop._business_host import _BusinessHost
-from iop._decorators import input_deserializer, output_serializer, input_serializer, output_deserializer
-from iop._dispatch import create_dispatch, dispach_message
+
+from ._business_host import _BusinessHost
+from ._decorators import input_deserializer, output_serializer, input_serializer, output_deserializer
+from ._dispatch import create_dispatch, dispach_message
 
 class _BusinessOperation(_BusinessHost):
     """Business operation component that handles outbound communication.

src/iop/_business_process.py

@@ -1,7 +1,8 @@
 from typing import Any, List, Optional, Union
-from iop._business_host import _BusinessHost
-from iop._decorators import input_deserializer, input_serializer_param, output_serializer, input_serializer, output_deserializer
-from iop._dispatch import create_dispatch, dispach_message
+
+from ._business_host import _BusinessHost
+from ._decorators import input_deserializer, input_serializer_param, output_serializer, input_serializer, output_deserializer
+from ._dispatch import create_dispatch, dispach_message
 
 class _BusinessProcess(_BusinessHost):
     """Business process component that contains routing and transformation logic.
@@ -72,23 +73,23 @@ def reply(self, response: Any) -> None:
         return self.iris_handle.dispatchReply(response)
 
     @input_serializer_param(1,'request')
-    def send_request_async(self, target: str, request: Any, response_required: bool=True, completion_key: Optional[str]=None, description: Optional[str]=None) -> None:
+    def send_request_async(self, target: str, request: Any, description: Optional[str]=None, completion_key: Optional[str]=None, response_required: bool=True) -> None:
         """Send the specified message to the target business process or business operation asynchronously.
         
         Args:
             target: The name of the business process or operation to receive the request
             request: The message to send to the target
-            response_required: Whether a response is required
-            completion_key: A string that will be returned with the response if the maximum time is exceeded
             description: An optional description property in the message header
+            completion_key: A string that will be returned with the response if the maximum time is exceeded
+            response_required: Whether a response is required
             
         Raises:
             TypeError: If request is not of type Message or IRISObject
         """
         if response_required:
-            response_required = 1
+            response_required = True
         else:
-            response_required = 0
+            response_required = False
         return self.iris_handle.dispatchSendRequestAsync(target, request, response_required, completion_key, description)
 
     def set_timer(self, timeout: Union[int, str], completion_key: Optional[str]=None) -> None:

src/iop/_business_service.py

@@ -1,6 +1,7 @@
 import importlib
-from iop._business_host import _BusinessHost
-from iop._decorators import input_deserializer, output_serializer, input_serializer, output_deserializer
+
+from ._business_host import _BusinessHost
+from ._decorators import input_deserializer, output_serializer, input_serializer, output_deserializer
 
 class _BusinessService(_BusinessHost):
     """ This class is responsible for receiving the data from external system and sending it to business processes or business operations in the production.

src/iop/_cli.py

@@ -7,8 +7,9 @@
 import sys
 from typing import Optional, Callable
 from importlib.metadata import version
-from iop._director import _Director
-from iop._utils import _Utils
+
+from ._director import _Director
+from ._utils import _Utils
 
 
 class CommandType(Enum):

src/iop/_common.py

@@ -1,14 +1,11 @@
 import abc
 import inspect
 import traceback
-
 from typing import Any, ClassVar, List, Optional, Tuple
 
 from . import _iris
-
-from iop._log_manager import LogManager, logging
-
-from iop._debugpy import debugpython
+from ._log_manager import LogManager, logging
+from ._debugpy import debugpython
 
 class _Common(metaclass=abc.ABCMeta):
     """Base class that defines common methods for all component types.
@@ -21,7 +18,12 @@ class _Common(metaclass=abc.ABCMeta):
     ICON_URL: ClassVar[str]
     iris_handle: Any = None
     _log_to_console: bool = False
-    _logger: logging.Logger = None
+    _logger: Optional[logging.Logger] = None
+
+    @staticmethod
+    def get_adapter_type() -> Optional[str]:
+        """Get the adapter type for this component. Override in subclasses."""
+        return None
 
     @property
     def logger(self) -> logging.Logger:
@@ -104,7 +106,7 @@ def _get_info(cls) -> List[str]:
                     super_class = classname[1:-1]
                     adapter = cls.get_adapter_type()
                     if adapter is None:
-                        adapter = cls.getAdapterType()
+                        adapter = cls.getAdapterType() # For backwards compatibility
                     break
                 elif classname in ["'iop.BusinessProcess'","'iop.DuplexProcess'","'iop.InboundAdapter'","'iop.OutboundAdapter'",
                                    "'grongier.pex.BusinessProcess'","'grongier.pex.DuplexProcess'","'grongier.pex.InboundAdapter'","'grongier.pex.OutboundAdapter'"] :
@@ -113,7 +115,7 @@ def _get_info(cls) -> List[str]:
                     break
 
             if ""==super_class:
-                return ""
+                return []
             ret.append(super_class)
 
             # Get the class documentation, if any

src/iop/_debugpy.py

@@ -83,7 +83,7 @@ def wait_for_debugpy_connected(timeout: float = 30, port: int = 0) -> bool:
 
     def timeout_handler():
         time.sleep(timeout)
-        debugpy.wait_for_client.cancel()
+        debugpy.wait_for_client.cancel() # type: ignore
 
     threading.Thread(target=timeout_handler, daemon=True).start()
 

src/iop/_decorators.py

@@ -1,6 +1,7 @@
 from functools import wraps
 from typing import Any, Callable
-from iop._dispatch import dispatch_deserializer, dispatch_serializer
+
+from ._dispatch import dispatch_deserializer, dispatch_serializer
 
 def input_serializer(fonction: Callable) -> Callable:
     """Decorator that serializes all input arguments."""

src/iop/_director.py

@@ -1,12 +1,24 @@
 import asyncio
 import datetime
 import functools
-from . import _iris
 import signal
 from dataclasses import dataclass
 
-from iop._dispatch import dispatch_deserializer, dispatch_serializer
-from iop._utils import _Utils
+from . import _iris
+from ._dispatch import dispatch_deserializer, dispatch_serializer
+from ._utils import _Utils
+
+@dataclass
+class SigintHandler():
+    
+    sigint: bool = False
+    sigint_log: bool = False
+    log_only: bool = False
+
+    def signal_handler(self, signal, frame):
+        if self.sigint or self.log_only:
+            self.sigint_log = True
+        self.sigint = True
 
 class _Director():
     """ The Directorclass is used for nonpolling business services, that is, business services which are not automatically
@@ -89,7 +101,7 @@ def start_production_with_log(production_name=None):
         loop.close()
 
     @staticmethod
-    async def _start_production_async(production_name=None, handler=None):
+    async def _start_production_async(production_name:str, handler: SigintHandler):
         _Director.start_production(production_name)
         while True:
             if handler.sigint:
@@ -286,15 +298,3 @@ def test_component(target,message=None,classname=None,body=None):
             deserialized_response = f'{response.classname} : {_Utils.stream_to_string(response.jstr)}'
         return deserialized_response
 
-            
-@dataclass
-class SigintHandler():
-    
-    sigint: bool = False
-    sigint_log: bool = False
-    log_only: bool = False
-
-    def signal_handler(self, signal, frame):
-        if self.sigint or self.log_only:
-            self.sigint_log = True
-        self.sigint = True