Client/Server decoder renamed and moved to pdu. (#2390)

Author: janiversen

doc/source/roadmap.rst

@@ -21,8 +21,7 @@ The following bullet points are what the maintainers focus on:
         - more typing in the core
         - 100% test coverage fixed for all new parts (currently transport and framer)
         - Updated PDU, moving client/server decoder into pdu
-    - better broadcast handling
-    - better broadcast handling
+    - better client no_response handling
     - Simplify PDU classes
     - better retry handling (only disconnect when really needed)
 - 3.7.5, bug fix release, hopefully with:

examples/client_custom_msg.py

@@ -26,7 +26,7 @@
 # Since the function code is already registered with the decoder factory,
 # this will be decoded as a read coil response. If you implement a new
 # method that is not currently implemented, you must register the request
-# and response with a ClientDecoder factory.
+# and response with a DecoderResponses factory.
 # --------------------------------------------------------------------------- #
 
 

examples/message_parser.py

@@ -17,7 +17,7 @@
     FramerRTU,
     FramerSocket,
 )
-from pymodbus.pdu import ClientDecoder, ServerDecoder
+from pymodbus.pdu import DecoderRequests, DecoderResponses
 
 
 _logger = logging.getLogger(__file__)
@@ -73,8 +73,8 @@ def decode(self, message):
         print(f"Decoding Message {value}")
         print("=" * 80)
         decoders = [
-            self.framer(ServerDecoder()),
-            self.framer(ClientDecoder()),
+            self.framer(DecoderRequests()),
+            self.framer(DecoderResponses()),
         ]
         for decoder in decoders:
             print(f"{decoder.decoder.__class__.__name__}")

pymodbus/client/base.py

@@ -11,7 +11,7 @@
 from pymodbus.exceptions import ConnectionException, ModbusIOException
 from pymodbus.framer import FRAMER_NAME_TO_CLASS, FramerBase, FramerType
 from pymodbus.logging import Log
-from pymodbus.pdu import ClientDecoder, ModbusPDU
+from pymodbus.pdu import DecoderResponses, ModbusPDU
 from pymodbus.transaction import SyncModbusTransactionManager
 from pymodbus.transport import CommParams
 from pymodbus.utilities import ModbusTransactionState
@@ -182,7 +182,7 @@ def __init__(
         self.slaves: list[int] = []
 
         # Common variables.
-        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(ClientDecoder())
+        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(DecoderResponses())
         self.transaction = SyncModbusTransactionManager(
             self,
             self.retries,

pymodbus/client/modbusclientprotocol.py

@@ -9,7 +9,7 @@
     FramerType,
 )
 from pymodbus.logging import Log
-from pymodbus.pdu import ClientDecoder
+from pymodbus.pdu import DecoderResponses
 from pymodbus.transaction import ModbusTransactionManager
 from pymodbus.transport import CommParams, ModbusProtocol
 
@@ -35,7 +35,7 @@ def __init__(
         self.on_connect_callback = on_connect_callback
 
         # Common variables.
-        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(ClientDecoder())
+        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(DecoderResponses())
         self.transaction = ModbusTransactionManager()
 
     def _handle_response(self, reply):

pymodbus/framer/base.py

@@ -10,7 +10,7 @@
 
 from pymodbus.exceptions import ModbusIOException
 from pymodbus.logging import Log
-from pymodbus.pdu import ClientDecoder, ModbusPDU, ServerDecoder
+from pymodbus.pdu import DecoderRequests, DecoderResponses, ModbusPDU
 
 
 class FramerType(str, Enum):
@@ -30,7 +30,7 @@ class FramerBase:
 
     def __init__(
         self,
-        decoder: ClientDecoder | ServerDecoder,
+        decoder: DecoderResponses | DecoderRequests,
     ) -> None:
         """Initialize a ADU (framer) instance."""
         self.decoder = decoder

pymodbus/pdu/__init__.py

@@ -1,13 +1,13 @@
 """Framer."""
 __all__ = [
-    "ClientDecoder",
+    "DecoderRequests",
+    "DecoderResponses",
     "ExceptionResponse",
     "ModbusExceptions",
     "ModbusPDU",
-    "ServerDecoder"
 ]
 
-from pymodbus.pdu.decoders import ClientDecoder, ServerDecoder
+from pymodbus.pdu.decoders import DecoderRequests, DecoderResponses
 from pymodbus.pdu.pdu import (
     ExceptionResponse,
     ModbusExceptions,