From ea84b9b1c714b02eaf1081f4e37fd130a3159d8c Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Tue, 26 Oct 2021 20:28:33 +0100 Subject: [PATCH] Option to disable the SIGINT handler in the client (Fixes #792) --- setup.cfg | 2 +- src/socketio/asyncio_client.py | 5 +++++ src/socketio/client.py | 11 +++++++++-- tests/common/test_client.py | 8 ++++++-- 4 files changed, 21 insertions(+), 5 deletions(-) diff --git a/setup.cfg b/setup.cfg index bc330b3..145aded 100644 --- a/setup.cfg +++ b/setup.cfg @@ -25,7 +25,7 @@ packages = find: python_requires = >=3.6 install_requires = bidict >= 0.21.0 - python-engineio >= 4.1.0 + python-engineio >= 4.3.0 [options.packages.find] where = src diff --git a/src/socketio/asyncio_client.py b/src/socketio/asyncio_client.py index 7409505..efb28b0 100644 --- a/src/socketio/asyncio_client.py +++ b/src/socketio/asyncio_client.py @@ -40,6 +40,11 @@ class AsyncClient(client.Client): packets. Custom json modules must have ``dumps`` and ``loads`` functions that are compatible with the standard library versions. + :param handle_sigint: Set to ``True`` to automatically handle disconnection + when the process is interrupted, or to ``False`` to + leave interrupt handling to the calling application. + Interrupt handling can only be enabled when the + client instance is created in the main thread. The Engine.IO configuration supports the following settings: diff --git a/src/socketio/client.py b/src/socketio/client.py index 9a00dbc..2c1e164 100644 --- a/src/socketio/client.py +++ b/src/socketio/client.py @@ -68,6 +68,11 @@ class Client(object): packets. Custom json modules must have ``dumps`` and ``loads`` functions that are compatible with the standard library versions. + :param handle_sigint: Set to ``True`` to automatically handle disconnection + when the process is interrupted, or to ``False`` to + leave interrupt handling to the calling application. + Interrupt handling can only be enabled when the + client instance is created in the main thread. The Engine.IO configuration supports the following settings: @@ -90,9 +95,9 @@ class Client(object): def __init__(self, reconnection=True, reconnection_attempts=0, reconnection_delay=1, reconnection_delay_max=5, randomization_factor=0.5, logger=False, serializer='default', - json=None, **kwargs): + json=None, handle_sigint=True, **kwargs): global original_signal_handler - if original_signal_handler is None and \ + if handle_sigint and original_signal_handler is None and \ threading.current_thread() == threading.main_thread(): original_signal_handler = signal.signal(signal.SIGINT, signal_handler) @@ -101,8 +106,10 @@ class Client(object): self.reconnection_delay = reconnection_delay self.reconnection_delay_max = reconnection_delay_max self.randomization_factor = randomization_factor + self.handle_sigint = handle_sigint engineio_options = kwargs + engineio_options['handle_sigint'] = handle_sigint engineio_logger = engineio_options.pop('engineio_logger', None) if engineio_logger is not None: engineio_options['logger'] = engineio_logger diff --git a/tests/common/test_client.py b/tests/common/test_client.py index e87e86e..2c3a93d 100644 --- a/tests/common/test_client.py +++ b/tests/common/test_client.py @@ -29,6 +29,7 @@ class TestClient(unittest.TestCase): reconnection_delay=5, reconnection_delay_max=10, randomization_factor=0.2, + handle_sigint=False, foo='bar', ) assert not c.reconnection @@ -36,7 +37,9 @@ class TestClient(unittest.TestCase): assert c.reconnection_delay == 5 assert c.reconnection_delay_max == 10 assert c.randomization_factor == 0.2 - engineio_client_class().assert_called_once_with(foo='bar') + assert not c.handle_sigint + engineio_client_class().assert_called_once_with( + foo='bar', handle_sigint=False) assert c.connection_url is None assert c.connection_headers is None assert c.connection_transports is None @@ -89,7 +92,8 @@ class TestClient(unittest.TestCase): @mock.patch('socketio.client.Client._engineio_client_class') def test_engineio_logger(self, engineio_client_class): client.Client(engineio_logger='foo') - engineio_client_class().assert_called_once_with(logger='foo') + engineio_client_class().assert_called_once_with( + handle_sigint=True, logger='foo') def test_on_event(self): c = client.Client()