pyModbusTCP.client: use a logger as in server

sourceperl · sourceperl · commit c0a33eda2e1d · 2024-09-03T18:09:51.000+02:00
diff --git a/CHANGES b/CHANGES
@@ -1,5 +1,10 @@
 Revision history for pyModbusTCP
 
+0.3.0.dev0 xxxx-xx-xx
+
+    - pyModbusTCP.client: now use the standard logging method as in the server part.
+    - ModbusClient: debug flag is removed (see examples/client_debug.py).
+
 0.2.2 2024-07-31
 
     - fix ModbusServer: wrong check of discrete inputs length in DataBank (thanks to OTnetproj).
diff --git a/docs/quickstart/index.rst b/docs/quickstart/index.rst
@@ -129,30 +129,29 @@ See http://en.wikipedia.org/wiki/Modbus for full table.
 |            | Read Device Identification   | 43            | :py:meth:`~pyModbusTCP.client.ModbusClient.read_device_identification`   |
 +------------+------------------------------+---------------+--------------------------------------------------------------------------+
 
-ModbusClient: debug mode
-------------------------
+ModbusClient: how-to debug
+--------------------------
 
-If need, you can enable a debug mode for ModbusClient like this::
+If need, you can enable debug log for ModbusClient like this::
+
+    import logging
 
     from pyModbusTCP.client import ModbusClient
-    c = ModbusClient(host="localhost", port=502, debug=True)
 
-or::
+    # set debug level for pyModbusTCP.client to see frame exchanges
+    logging.basicConfig()
+    logging.getLogger('pyModbusTCP.client').setLevel(logging.DEBUG)
 
-    c.debug = True
+    c = ModbusClient(host="localhost", port=502)
 
-when debug is enable all debug message is print on console and you can see
-modbus frame::
+when debug level is set, all debug messages are displayed on the console::
 
-    c.read_holding_registers(0, 4)
+    c.read_coils(0)
 
-print::
+will give us the following result::
 
-    Tx
-    [E7 53 00 00 00 06 01] 03 00 00 00 04
-    Rx
-    [E7 53 00 00 00 0B 01] 03 08 00 00 00 6F 00 00 00 00
-    [0, 111, 0, 0]
+    DEBUG:pyModbusTCP.client:(localhost:502:1) Tx [8F 8A 00 00 00 06 01] 01 00 00 00 01
+    DEBUG:pyModbusTCP.client:(localhost:502:1) Rx [8F 8A 00 00 00 04 01] 01 01 00
 
 
 utils module: Modbus data mangling
diff --git a/examples/client_debug.py b/examples/client_debug.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+""" An example of basic logging for ModbusClient debugging purposes. """
+
+import logging
+import time
+
+from pyModbusTCP.server import ModbusServer
+from pyModbusTCP.client import ModbusClient
+
+# a logger for this script
+logger = logging.getLogger(__name__)
+
+# global log conf: sets a default format and level for all loggers in this application (include pyModbusTCP)
+logging.basicConfig(format='%(asctime)s - %(name)-20s - %(levelname)-8s - %(message)s', level=logging.INFO)
+# set debug level for pyModbusTCP.client to see frame exchanges
+logging.getLogger('pyModbusTCP.client').setLevel(logging.DEBUG)
+
+# run a modbus server at localhost:5020
+ModbusServer(host='localhost', port=5020, no_block=True).start()
+
+# this message is show
+logger.info(f'app startup')
+
+# init modbus client to connect to localhost:5020
+c = ModbusClient(port=5020)
+
+# main loop
+for i in range(100):
+    # this message is not not show (global log level is set to INFO)
+    logger.debug(f'run loop #{i}')
+    # modbus i/o
+    c.read_coils(0)
+    time.sleep(2)
diff --git a/examples/client_float.py b/examples/client_float.py
@@ -3,8 +3,8 @@
 """ How-to add float support to ModbusClient. """
 
 from pyModbusTCP.client import ModbusClient
-from pyModbusTCP.utils import encode_ieee, decode_ieee, \
-                              long_list_to_word, word_list_to_long
+from pyModbusTCP.utils import (decode_ieee, encode_ieee, long_list_to_word,
+                               word_list_to_long)
 
 
 class FloatModbusClient(ModbusClient):
diff --git a/examples/client_read_coils.py b/examples/client_read_coils.py
@@ -3,10 +3,11 @@
 """ Read 10 coils and print result on stdout. """
 
 import time
+
 from pyModbusTCP.client import ModbusClient
 
 # init modbus client
-c = ModbusClient(host='localhost', port=502, auto_open=True, debug=False)
+c = ModbusClient(host='localhost', port=502, auto_open=True)
 
 # main read loop
 while True:
diff --git a/examples/client_read_h_registers.py b/examples/client_read_h_registers.py
@@ -3,11 +3,11 @@
 """ Read 10 holding registers and print result on stdout. """
 
 import time
-from pyModbusTCP.client import ModbusClient
 
+from pyModbusTCP.client import ModbusClient
 
 # init modbus client
-c = ModbusClient(debug=False, auto_open=True)
+c = ModbusClient(auto_open=True)
 
 # main read loop
 while True:
diff --git a/examples/client_serial_gw.py b/examples/client_serial_gw.py
@@ -13,12 +13,14 @@
 import argparse
 import logging
 import struct
-from pyModbusTCP.client import ModbusClient
-from pyModbusTCP.utils import crc16
-from pyModbusTCP.constants import EXP_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND
+
 # need sudo pip3 install pyserial==3.4
 from serial import Serial, serialutil
 
+from pyModbusTCP.client import ModbusClient
+from pyModbusTCP.constants import EXP_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND
+from pyModbusTCP.utils import crc16
+
 
 # some class
 class ModbusRTUFrame:
diff --git a/examples/client_thread.py b/examples/client_thread.py
@@ -9,7 +9,8 @@
 """
 
 import time
-from threading import Thread, Lock
+from threading import Lock, Thread
+
 from pyModbusTCP.client import ModbusClient
 
 SERVER_HOST = "localhost"
diff --git a/examples/client_write_coils.py b/examples/client_write_coils.py
@@ -3,10 +3,11 @@
 """Write 4 coils to True, wait 2s, write False and redo it."""
 
 import time
+
 from pyModbusTCP.client import ModbusClient
 
 # init
-c = ModbusClient(host='localhost', port=502, auto_open=True, debug=False)
+c = ModbusClient(host='localhost', port=502, auto_open=True)
 bit = True
 
 # main loop
diff --git a/examples/server.py b/examples/server.py
@@ -12,8 +12,8 @@
 
 import argparse
 import logging
-from pyModbusTCP.server import ModbusServer
 
+from pyModbusTCP.server import ModbusServer
 
 # init logging
 logging.basicConfig()
diff --git a/examples/server_allow.py b/examples/server_allow.py
@@ -8,9 +8,9 @@
 """
 
 import argparse
-from pyModbusTCP.server import ModbusServer, DataHandler
-from pyModbusTCP.constants import EXP_ILLEGAL_FUNCTION
 
+from pyModbusTCP.constants import EXP_ILLEGAL_FUNCTION
+from pyModbusTCP.server import DataHandler, ModbusServer
 
 # some const
 ALLOW_R_L = ['127.0.0.1', '192.168.0.10']
diff --git a/examples/server_change_log.py b/examples/server_change_log.py
@@ -8,7 +8,8 @@
 
 import argparse
 import logging
-from pyModbusTCP.server import ModbusServer, DataBank
+
+from pyModbusTCP.server import DataBank, ModbusServer
 
 
 class MyDataBank(DataBank):
diff --git a/examples/server_schedule.py b/examples/server_schedule.py
@@ -14,10 +14,12 @@
 
 import argparse
 import time
-from pyModbusTCP.server import ModbusServer
+
 # need https://github.com/dbader/schedule
 import schedule
 
+from pyModbusTCP.server import ModbusServer
+
 
 def alive_word_job():
     """Update holding register @0 with day second (since 00:00).
diff --git a/examples/server_serial_gw.py b/examples/server_serial_gw.py
@@ -16,14 +16,17 @@
 import logging
 import queue
 import struct
-from threading import Event
 from queue import Queue
-from pyModbusTCP.server import ModbusServer
-from pyModbusTCP.utils import crc16
-from pyModbusTCP.constants import EXP_GATEWAY_PATH_UNAVAILABLE, EXP_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND
+from threading import Event
+
 # need sudo pip install pyserial==3.4
 from serial import Serial, serialutil
 
+from pyModbusTCP.constants import (EXP_GATEWAY_PATH_UNAVAILABLE,
+                                   EXP_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND)
+from pyModbusTCP.server import ModbusServer
+from pyModbusTCP.utils import crc16
+
 
 # some class
 class ModbusRTUFrame:
diff --git a/examples/server_virtual_data.py b/examples/server_virtual_data.py
@@ -12,9 +12,10 @@
 """
 
 import argparse
-from pyModbusTCP.server import ModbusServer, DataBank
 from datetime import datetime
 
+from pyModbusTCP.server import DataBank, ModbusServer
+
 
 class MyDataBank(DataBank):
     """A custom ModbusServerDataBank for override get_holding_registers method."""
diff --git a/pyModbusTCP/__init__.py b/pyModbusTCP/__init__.py
@@ -6,12 +6,14 @@
 #                 1,2,4,5,6 (Class 1)
 #                 15,23,43
 
-from .constants import VERSION
+import logging
 
+from .constants import VERSION
 
-__all__ = ['constants', 'client', 'server', 'utils']
 __title__ = 'pyModbusTCP'
 __description__ = 'A simple Modbus/TCP library for Python.'
 __url__ = 'https://github.com/sourceperl/pyModbusTCP'
 __version__ = VERSION
 __license__ = 'MIT'
+
+logger = logging.getLogger(__name__)
diff --git a/pyModbusTCP/client.py b/pyModbusTCP/client.py
diff --git a/pyModbusTCP/constants.py b/pyModbusTCP/constants.py
diff --git a/pyModbusTCP/server.py b/pyModbusTCP/server.py
diff --git a/tests/test_client.py b/tests/test_client.py
