added fixes for automatically registering signal handler on non-main thread

Author: Voyz

ibind/base/rest_client.py

@@ -84,6 +84,7 @@ def __init__(
             timeout: float = 10,
             max_retries: int = 3,
             use_session: bool = var.IBIND_USE_SESSION,
+            auto_register_shutdown: bool = var.IBIND_AUTO_REGISTER_SHUTDOWN,
     ) -> None:
         """
         Parameters:
@@ -93,6 +94,7 @@ def __init__(
             timeout (float, optional): Timeout in seconds for the API requests. Defaults to 10.
             max_retries (int, optional): Maximum number of retries for failed API requests. Defaults to 3.
             use_session (bool, optional): Whether to use a persistent session for making requests. Defaults to True.
+            auto_register_shutdown (bool, optional): Whether to automatically register a shutdown handler for this client. Defaults to True.
         """
 
         if url is None:
@@ -115,17 +117,15 @@ def __init__(
         if use_session:
             self.make_session()
 
-        self.register_shutdown_handler()
+        if auto_register_shutdown:
+            self.register_shutdown_handler()
 
     def _make_logger(self):
         self._logger = new_daily_rotating_file_handler('RestClient', os.path.join(var.LOGS_DIR, f'rest_client'))
 
     def make_session(self):
         """Creates a new session, ensuring old one (if exists) is closed properly."""
         self._session = requests.Session()
-        adapter = HTTPAdapter(pool_connections=10, pool_maxsize=10, pool_block=True)
-        self._session.mount("https://", adapter)
-        self._session.mount("http://", adapter)
 
     @property
     def logger(self):
@@ -306,7 +306,6 @@ def _close_handler():
             if self._closed:
                 return
             self._closed = True
-
             self.close()
 
         def _signal_handler(signum, frame):
@@ -318,8 +317,14 @@ def _signal_handler(signum, frame):
             if signum == signal.SIGTERM and callable(existing_handler_term):
                 existing_handler_term(signum, frame)
 
-        signal.signal(signal.SIGINT, _signal_handler)
-        signal.signal(signal.SIGTERM, _signal_handler)
+        try:
+            signal.signal(signal.SIGINT, _signal_handler)
+            signal.signal(signal.SIGTERM, _signal_handler)
+        except ValueError as e:
+            if str(e) == 'signal only works in main thread of the main interpreter':
+                pass # we cannot register signal, we ignore it and continue working as normal
+            else:
+                raise
         atexit.register(_close_handler)
 
     def __str__(self):

ibind/client/ibkr_client.py

@@ -50,8 +50,10 @@ def __init__(
             timeout: float = 10,
             max_retries: int = 3,
             use_session: bool = var.IBIND_USE_SESSION,
+            auto_register_shutdown: bool = var.IBIND_AUTO_REGISTER_SHUTDOWN,
             use_oauth: bool = var.IBIND_USE_OAUTH,
-            oauth_config: 'OAuthConfig' = None
+            oauth_config: 'OAuthConfig' = None,
+
     ) -> None:
         """
         Parameters:
@@ -69,6 +71,7 @@ def __init__(
             timeout (float, optional): Timeout in seconds for the API requests. Defaults to 10.
             max_retries (int, optional): Maximum number of retries for failed API requests. Defaults to 3.
             use_session (bool, optional): Whether to use a persistent session for making requests. Defaults to True.
+            auto_register_shutdown (bool, optional): Whether to automatically register a shutdown handler for this client. Defaults to True.
             use_oauth (bool, optional): Whether to use OAuth authentication. Defaults to False.
             oauth_config (OAuthConfig, optional): The configuration for the OAuth authentication. OAuth1aConfig is used if not specified.
         """
@@ -87,7 +90,14 @@ def __init__(
         self.account_id = account_id
 
         cacert = True if self._use_oauth else cacert
-        super().__init__(url=url, cacert=cacert, timeout=timeout, max_retries=max_retries, use_session=use_session)
+        super().__init__(
+            url=url,
+            cacert=cacert,
+            timeout=timeout,
+            max_retries=max_retries,
+            use_session=use_session,
+            auto_register_shutdown=auto_register_shutdown,
+        )
 
         self.logger.info('#################')
         self.logger.info(f'New IbkrClient(base_url={self.base_url!r}, account_id={self.account_id!r}, ssl={self.cacert!r}, timeout={self._timeout}, max_retries={self._max_retries}, use_oauth={self._use_oauth})')
@@ -248,4 +258,4 @@ def oauth_shutdown(self):
         """
         _LOGGER.info(f'{self}: Shutting down OAuth')
         self.stop_tickler()
-        self.logout()
+        self.logout()

ibind/var.py

@@ -33,6 +33,9 @@ def to_bool(value):
 IBIND_USE_SESSION = to_bool(os.environ.get('IBIND_USE_SESSION', True))
 """ Whether to use persistent session in REST requests. """
 
+IBIND_AUTO_REGISTER_SHUTDOWN = to_bool(os.environ.get('IBIND_AUTO_REGISTER_SHUTDOWN', True))
+""" Whether to automatically register the shutdown handler. """
+
 ##### LOGS #####
 
 LOG_TO_CONSOLE = to_bool(os.environ.get('IBIND_LOG_TO_CONSOLE', True))

test/integration/base/test_rest_client_i.py

@@ -1,5 +1,7 @@
+import threading
 from unittest import TestCase
 from unittest.mock import patch, MagicMock
+import asyncio
 
 from requests import ReadTimeout, Timeout
 
@@ -10,7 +12,7 @@
 
 
 @patch('ibind.base.rest_client.requests')
-class TestIbkrClientI(TestCase):
+class TestRestClientI(TestCase):
     def setUp(self):
         self.url = 'https://localhost:5000'
         self.account_id = 'TEST_ACCOUNT_ID'
@@ -81,3 +83,65 @@ def test_response_raise_generic(self, requests_mock):
             self.client.get(self.default_path)
 
         self.assertEqual(f"RestClient: response error {self.result.copy(data=None)} :: {self.response.status_code} :: {self.response.reason} :: {self.response.text}", str(cm_err.exception))
+
+class TestRestClientInThread(TestCase):
+    def _worker(self, results:[]):
+        try:
+            IbkrClient()
+        except Exception as e:
+            results.append(e)
+
+    def test_in_thread(self):
+        """ Run in thread ensuring client still is constructed without an exception."""
+        results = []
+        t = threading.Thread(target=self._worker, args=(results,))
+        t.daemon = True
+        t.start()
+        t.join(1)
+        for result in results:
+            if isinstance(result, Exception):
+                raise result
+
+
+    def test_without_thread(self):
+        """ Run without a thread to ensure it still works as expected."""
+        results = []
+        self._worker(results)
+        for result in results:
+            if isinstance(result, Exception):
+                raise result
+
+
+class TestRestClientAsync(TestCase):
+    def _worker(self, results: []):
+        """Runs the async test inside a new thread to check if signal handling breaks."""
+        try:
+            asyncio.run(self._async_worker(results))
+        except Exception as e:
+            results.append(e)
+
+    async def _async_worker(self, results: []):
+        """Async version of the worker function to run in an asyncio event loop."""
+        try:
+            IbkrClient()
+        except Exception as e:
+            results.append(e)
+
+    def test_in_thread_async(self):
+        """Test that IbkrClient() does not break in an asyncio thread."""
+        results = []
+        t = threading.Thread(target=self._worker, args=(results,))
+        t.daemon = True
+        t.start()
+        t.join(1)
+        for result in results:
+            if isinstance(result, Exception):
+                raise result
+
+    def test_without_thread_async(self):
+        """Test that IbkrClient() does not break in the main asyncio event loop."""
+        results = []
+        asyncio.run(self._async_worker(results))
+        for result in results:
+            if isinstance(result, Exception):
+                raise result