Stopping listener closes handler which closes communicators.

Fixes #59

pyleco/utils/listener.py

@@ -146,7 +146,7 @@ def stop_listen(self) -> None:
                 log.debug("Stopping listener thread.")
                 self.stop_event.set()
                 self.thread.join()
-                self.communicator.close()
+                self.message_handler.close()
                 log.removeHandler(self.message_handler.log_handler)
                 if self.logger is not None:
                     self.logger.removeHandler(self.message_handler.log_handler)

pyleco/utils/pipe_handler.py

@@ -170,7 +170,11 @@ def full_name(self) -> str:
         return self.handler.full_name
 
     def _send_pipe_message(self, typ: PipeCommands, *content: bytes) -> None:
-        self.socket.send_multipart((typ, *content))
+        try:
+            self.socket.send_multipart((typ, *content))
+        except zmq.ZMQError as exc:
+            raise ConnectionRefusedError(f"Connection to the handler refused with '{exc}', "
+                                         "probably the handler stopped.")
 
     def send_message(self, message: Message) -> None:
         if not message.sender:
@@ -262,6 +266,7 @@ def setup_message_buffer(self) -> None:
 
     def close(self) -> None:
         self.internal_pipe.close(1)
+        self.close_all_communicators()
         super().close()
 
     def set_full_name(self, full_name: str) -> None:
@@ -355,3 +360,7 @@ def get_communicator(self, **kwargs) -> CommunicatorPipe:
             return self.create_communicator(**kwargs)
         else:
             return com
+
+    def close_all_communicators(self) -> None:
+        for communicator in self._communicators.values():
+            communicator.close()

tests/utils/test_listener.py

@@ -25,8 +25,9 @@
 import pytest
 
 from pyleco.test import FakeCommunicator
+from pyleco.core.message import Message
 
-from pyleco.utils.listener import Listener
+from pyleco.utils.listener import Listener, CommunicatorPipe
 
 
 @pytest.fixture
@@ -38,3 +39,30 @@ def listener() -> Listener:
 
 def test_communicator_name_is_returned(listener: Listener):
     assert listener.name == "N.Pipe"
+
+
+class Test_communicator_closed_at_stopped_listener():
+    @pytest.fixture(scope="class")
+    def communicator(self) -> CommunicatorPipe:
+        # scope is class as starting the listener takes some time
+        listener = Listener(name="test")
+        listener.start_listen()
+        communicator = listener.communicator
+        listener.stop_listen()
+        return communicator
+
+    def test_socket_closed(self, communicator: CommunicatorPipe):
+        assert communicator.socket.closed is True
+
+    def test_internal_method(self, communicator: CommunicatorPipe):
+        """A method which is handled in the handler and not sent from the handler via LECO."""
+        with pytest.raises(ConnectionRefusedError):
+            communicator.ask_handler("pong")
+
+    def test_sending_messages(self, communicator: CommunicatorPipe):
+        with pytest.raises(ConnectionRefusedError):
+            communicator.send_message(Message("rec", "send"))
+
+    def test_changing_name(self, communicator: CommunicatorPipe):
+        with pytest.raises(ConnectionRefusedError):
+            communicator.name = "abc"

tests/utils/test_pipe_handler.py

@@ -149,6 +149,13 @@ def communicator(pipe_handler_pipe: PipeHandler):
     return pipe_handler_pipe.get_communicator()
 
 
+def test_close_closes_all_communicators(
+    pipe_handler_pipe: PipeHandler, communicator: CommunicatorPipe
+):
+    pipe_handler_pipe.close()
+    assert communicator.socket.closed is True
+
+
 class Test_PipeHandler_read_message:
     def test_handle_response(self, pipe_handler: PipeHandler):
         message = Message("rec", "send")
@@ -195,6 +202,11 @@ def test_second_call_returns_same_communicator(self, pipe_handler_setup: PipeHan
         assert com2 == pipe_handler_setup.external_pipe  # type: ignore
 
 
+def test_close_all_communicators(pipe_handler_pipe: PipeHandler, communicator: CommunicatorPipe):
+    pipe_handler_pipe.close_all_communicators()
+    assert communicator.socket.closed is True
+
+
 def test_communicator_send_message(pipe_handler_pipe: PipeHandler, communicator: CommunicatorPipe):
     message = Message("rec", "send")
     pipe_handler_pipe._send_frames = MagicMock()  # type: ignore[method-assign]