Move get_commandline into setup_x. (#1440)

Author: janiversen

examples/client_async.py

@@ -40,8 +40,9 @@
 _logger = logging.getLogger()
 
 
-def setup_async_client(args):
+def setup_async_client(description=None, cmdline=None):
     """Run client setup."""
+    args = get_commandline(server=False, description=description, cmdline=cmdline)
     _logger.info("### Create client object")
     if args.comm == "tcp":
         client = AsyncModbusTcpClient(
@@ -128,9 +129,5 @@ async def run_async_client(client, modbus_calls=None):
 
 
 if __name__ == "__main__":
-    cmd_args = get_commandline(
-        server=False,
-        description="Run asynchronous client.",
-    )
-    testclient = setup_async_client(cmd_args)
+    testclient = setup_async_client(description="Run asynchronous client.")
     asyncio.run(run_async_client(testclient), debug=True)

examples/client_calls.py

@@ -42,7 +42,6 @@
 import pymodbus.other_message as req_other
 from examples.client_async import run_async_client, setup_async_client
 from examples.client_sync import run_sync_client, setup_sync_client
-from examples.helper import get_commandline
 from pymodbus.exceptions import ModbusException
 from pymodbus.pdu import ExceptionResponse
 
@@ -289,11 +288,11 @@ def run_sync_calls(client):
 
 
 if __name__ == "__main__":
-    cmd_args = get_commandline(
-        server=False,
-        description="Run modbus calls in asynchronous client.",
+    testclient = setup_async_client(
+        description="Run modbus calls in asynchronous client."
     )
-    testclient = setup_async_client(cmd_args)
     asyncio.run(run_async_client(testclient, modbus_calls=run_async_calls))
-    testclient = setup_sync_client(cmd_args)
+    testclient = setup_sync_client(
+        description="Run modbus calls in synchronous client."
+    )
     run_sync_client(testclient, modbus_calls=run_sync_calls)

examples/client_payload.py

@@ -12,7 +12,6 @@
 from collections import OrderedDict
 
 from examples.client_async import run_async_client, setup_async_client
-from examples.helper import get_commandline
 from pymodbus.constants import Endian
 from pymodbus.payload import BinaryPayloadBuilder, BinaryPayloadDecoder
 
@@ -138,8 +137,5 @@ async def run_payload_calls(client):
 
 
 if __name__ == "__main__":
-    cmd_args = get_commandline(
-        description="Run payload client.",
-    )
-    testclient = setup_async_client(cmd_args)
+    testclient = setup_async_client(description="Run payload client.")
     asyncio.run(run_async_client(testclient, modbus_calls=run_payload_calls))

examples/client_sync.py

@@ -39,8 +39,13 @@
 _logger = logging.getLogger()
 
 
-def setup_sync_client(args):
+def setup_sync_client(description=None, cmdline=None):
     """Run client setup."""
+    args = get_commandline(
+        server=False,
+        description=description,
+        cmdline=cmdline,
+    )
     _logger.info("### Create client object")
     if args.comm == "tcp":
         client = ModbusTcpClient(
@@ -126,9 +131,5 @@ def run_sync_client(client, modbus_calls=None):
 
 
 if __name__ == "__main__":
-    cmd_args = get_commandline(
-        server=False,
-        description="Run synchronous client.",
-    )
-    testclient = setup_sync_client(cmd_args)
+    testclient = setup_sync_client(description="Run synchronous client.")
     run_sync_client(testclient)

examples/client_test.py

@@ -13,7 +13,6 @@
 import pymodbus.diag_message as req_diag
 import pymodbus.mei_message as req_mei
 from examples.client_async import run_async_client, setup_async_client
-from examples.helper import get_commandline
 from pymodbus.pdu import ExceptionResponse
 
 
@@ -86,17 +85,15 @@ async def _execute_diagnostic_requests(client):
 
 async def run_async_calls(client):
     """Demonstrate basic read/write calls."""
-    # await _handle_coils(client)
-    # await _handle_discrete_input(client)
-    # await _handle_holding_registers(client)
+    await _handle_coils(client)
+    await _handle_discrete_input(client)
+    await _handle_holding_registers(client)
     await _execute_information_requests(client)
-    # await _execute_diagnostic_requests(client)
+    await _execute_diagnostic_requests(client)
 
 
 if __name__ == "__main__":
-    cmd_args = get_commandline(
-        server=False,
-        description="Run modbus calls in asynchronous client.",
+    testclient = setup_async_client(
+        description="Run modbus calls in asynchronous client."
     )
-    testclient = setup_async_client(cmd_args)
     asyncio.run(run_async_client(testclient, modbus_calls=run_async_calls))

examples/helper.py

@@ -5,7 +5,6 @@
 get_command_line
 """
 import argparse
-import dataclasses
 import logging
 
 from pymodbus import pymodbus_apply_logging_config
@@ -21,59 +20,40 @@
 _logger = logging.getLogger()
 
 
-@dataclasses.dataclass
-class Commandline:
-    """Simulate commandline parameters.
-
-    Replaces get_commandline() and allows application to set arguments directly.
-    """
-
-    comm = None
-    framer = None
-    host = "127.0.0.1"
-    port = None
-    baudrate = 9600
-    store = "sequential"
-    identity = None
-    context = None
-    slaves = None
-    client_port = None
-    client = None
-    log = "debug"
-
-    @classmethod
-    def copy(cls):
-        """Copy kl"""
-        to_copy = cls()
-        return dataclasses.replace(to_copy)
-
-
 def get_commandline(server=False, description=None, extras=None, cmdline=None):
     """Read and validate command line arguments"""
     parser = argparse.ArgumentParser(description=description)
     parser.add_argument(
+        "-c",
         "--comm",
         choices=["tcp", "udp", "serial", "tls"],
         help="set communication, default is tcp",
+        dest="comm",
         default="tcp",
         type=str,
     )
     parser.add_argument(
+        "-f",
         "--framer",
         choices=["ascii", "binary", "rtu", "socket", "tls"],
         help="set framer, default depends on --comm",
+        dest="framer",
         type=str,
     )
     parser.add_argument(
+        "-l",
         "--log",
         choices=["critical", "error", "warning", "info", "debug"],
         help="set log level, default is info",
+        dest="log",
         default="info",
         type=str,
     )
     parser.add_argument(
+        "-p",
         "--port",
         help="set port",
+        dest="port",
         type=str,
     )
     parser.add_argument(
@@ -106,10 +86,10 @@ def get_commandline(server=False, description=None, extras=None, cmdline=None):
         parser.add_argument(
             "--host",
             help="set host, default is 127.0.0.1",
+            dest="host",
             default="127.0.0.1",
             type=str,
         )
-
     if extras:
         for extra in extras:
             parser.add_argument(extra[0], **extra[1])