Remove message_generator example (not part of API)

doc/source/examples.rst

@@ -177,15 +177,6 @@ Source: :github:`examples/datastore_simulator_share.py`
     :noindex:
 
 
-Message generator
-^^^^^^^^^^^^^^^^^
-Source: :github:`examples/message_generator.py`
-
-.. automodule:: examples.message_generator
-    :undoc-members:
-    :noindex:
-
-
 Message Parser
 ^^^^^^^^^^^^^^
 Source: :github:`examples/message_parser.py`

examples/client_async.py

@@ -113,6 +113,8 @@ def setup_async_client(description=None, cmdline=None):
             ),
             server_hostname="localhost",
         )
+    else:
+        raise RuntimeError(f"Unknown commtype {args.comm}")
     return client
 
 

examples/client_custom_msg.py

@@ -121,6 +121,9 @@ async def main(host="localhost", port=5020):
     async with ModbusClient(host=host, port=port, framer_name=FramerType.SOCKET) as client:
         await client.connect()
 
+        # create a response object to control it works
+        CustomModbusResponse()
+
         # new modbus function code.
         client.register(CustomModbusResponse)
         request = CustomModbusRequest(32, slave=1)

examples/helper.py

@@ -20,7 +20,7 @@ def get_commandline(server=False, description=None, extras=None, cmdline=None):
     parser.add_argument(
         "-c",
         "--comm",
-        choices=["tcp", "udp", "serial", "tls"],
+        choices=["tcp", "udp", "serial", "tls", "unknown"],
         help="set communication, default is tcp",
         dest="comm",
         default="tcp",

test/sub_examples/test_client_server_async.py

@@ -56,6 +56,12 @@ async def test_client_exception(self, mock_server, mock_clc):
         )
         await run_async_client(test_client, modbus_calls=run_a_few_calls)
 
+    async def test_client_no_calls(self, mock_server, mock_clc):
+        """Run async client and server."""
+        assert mock_server
+        test_client = setup_async_client(cmdline=mock_clc)
+        await run_async_client(test_client, modbus_calls=None)
+
     async def test_server_no_client(self, mock_server):
         """Run async server without client."""
         assert mock_server
@@ -76,3 +82,9 @@ async def test_client_no_server(self, mock_clc):
         test_client = setup_async_client(cmdline=mock_clc)
         with pytest.raises((AssertionError, asyncio.TimeoutError)):
             await run_async_client(test_client, modbus_calls=run_a_few_calls)
+
+async def test_illegal_commtype():
+        """Run async client and server."""
+        with pytest.raises(RuntimeError):
+            setup_async_client(cmdline=["--comm", "unknown", "--framer", "rtu", "--port", "5912"]
+)

test/sub_examples/test_examples.py

@@ -18,7 +18,6 @@
 from examples.client_custom_msg import main as main_custom_client
 from examples.client_payload import main as main_payload_calls
 from examples.datastore_simulator_share import main as main_datastore_simulator_share
-from examples.message_generator import generate_messages
 from examples.message_parser import main as main_parse_messages
 from examples.server_async import setup_server
 from examples.server_callback import run_callback_server
@@ -43,11 +42,6 @@ def get_port_in_class(base_ports):
         base_ports[__class__.__name__] += 1
         return base_ports[__class__.__name__]
 
-    @pytest.mark.parametrize("framer", ["socket", "rtu", "ascii"])
-    def test_message_generator(self, framer):
-        """Test all message generator."""
-        generate_messages(cmdline=["--framer", framer])
-
     @pytest.mark.parametrize("framer", ["socket", "rtu", "ascii"])
     def test_message_parser(self, framer):
         """Test message parser."""