Update to use DecodePDU. (#2391)

janiversen · web-flow · commit b907133dfbaa · 2024-10-17T18:43:50.000+02:00
diff --git a/examples/client_custom_msg.py b/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 DecoderResponses factory.
+# and response with the active DecodePDU object.
 # --------------------------------------------------------------------------- #
 
 
diff --git a/examples/message_parser.py b/examples/message_parser.py
@@ -17,7 +17,7 @@
     FramerRTU,
     FramerSocket,
 )
-from pymodbus.pdu import DecoderRequests, DecoderResponses
+from pymodbus.pdu import DecodePDU
 
 
 _logger = logging.getLogger(__file__)
@@ -73,8 +73,8 @@ def decode(self, message):
         print(f"Decoding Message {value}")
         print("=" * 80)
         decoders = [
-            self.framer(DecoderRequests()),
-            self.framer(DecoderResponses()),
+            self.framer(DecodePDU(True)),
+            self.framer(DecodePDU(False)),
         ]
         for decoder in decoders:
             print(f"{decoder.decoder.__class__.__name__}")
diff --git a/pymodbus/client/base.py b/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 DecoderResponses, ModbusPDU
+from pymodbus.pdu import DecodePDU, 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])(DecoderResponses())
+        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(DecodePDU(False))
         self.transaction = SyncModbusTransactionManager(
             self,
             self.retries,
diff --git a/pymodbus/client/modbusclientprotocol.py b/pymodbus/client/modbusclientprotocol.py
@@ -9,7 +9,7 @@
     FramerType,
 )
 from pymodbus.logging import Log
-from pymodbus.pdu import DecoderResponses
+from pymodbus.pdu import DecodePDU
 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])(DecoderResponses())
+        self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(DecodePDU(False))
         self.transaction = ModbusTransactionManager()
 
     def _handle_response(self, reply):
diff --git a/pymodbus/framer/base.py b/pymodbus/framer/base.py
@@ -10,7 +10,7 @@
 
 from pymodbus.exceptions import ModbusIOException
 from pymodbus.logging import Log
-from pymodbus.pdu import DecoderRequests, DecoderResponses, ModbusPDU
+from pymodbus.pdu import DecodePDU, ModbusPDU
 
 
 class FramerType(str, Enum):
@@ -30,7 +30,7 @@ class FramerBase:
 
     def __init__(
         self,
-        decoder: DecoderResponses | DecoderRequests,
+        decoder: DecodePDU,
     ) -> None:
         """Initialize a ADU (framer) instance."""
         self.decoder = decoder
diff --git a/pymodbus/pdu/__init__.py b/pymodbus/pdu/__init__.py
@@ -1,13 +1,12 @@
 """Framer."""
 __all__ = [
-    "DecoderRequests",
-    "DecoderResponses",
+    "DecodePDU",
     "ExceptionResponse",
     "ModbusExceptions",
     "ModbusPDU",
 ]
 
-from pymodbus.pdu.decoders import DecoderRequests, DecoderResponses
+from pymodbus.pdu.decoders import DecodePDU
 from pymodbus.pdu.pdu import (
     ExceptionResponse,
     ModbusExceptions,
diff --git a/pymodbus/pdu/decoders.py b/pymodbus/pdu/decoders.py
@@ -62,7 +62,7 @@ class DecodePDU:
 
     def __init__(self, is_server: bool) -> None:
         """Initialize function_tables."""
-        inx = 1 if is_server else 0
+        inx = 0 if is_server else 1
         self.lookup: dict[int, Callable] = {cl[inx].function_code: cl[inx] for cl in self._pdu_class_table}  # type: ignore[attr-defined]
         self.sub_lookup: dict[int, dict[int, Callable]] = {f: {} for f in self.lookup}
         for f in self._pdu_sub_class_table:
@@ -116,19 +116,3 @@ def decode(self, frame):
         except ModbusException as exc:
             Log.warning("Unable to decode frame {}", exc)
         return None
-
-
-class DecoderRequests(DecodePDU):
-    """Decode request Message (Server)."""
-
-    def __init__(self) -> None:
-        """Initialize the client lookup tables."""
-        super().__init__(False)
-
-
-class DecoderResponses(DecodePDU):
-    """Decode response Message (Client)."""
-
-    def __init__(self) -> None:
-        """Initialize the client lookup tables."""
-        super().__init__(True)
diff --git a/pymodbus/server/async_io.py b/pymodbus/server/async_io.py
@@ -12,7 +12,7 @@
 from pymodbus.exceptions import ModbusException, NoSuchSlaveException
 from pymodbus.framer import FRAMER_NAME_TO_CLASS, FramerBase, FramerType
 from pymodbus.logging import Log
-from pymodbus.pdu import DecoderRequests
+from pymodbus.pdu import DecodePDU
 from pymodbus.pdu import ModbusExceptions as merror
 from pymodbus.pdu.pdu import ExceptionResponse
 from pymodbus.transport import CommParams, CommType, ModbusProtocol
@@ -267,7 +267,7 @@ def __init__(
             True,
         )
         self.loop = asyncio.get_running_loop()
-        self.decoder = DecoderRequests()
+        self.decoder = DecodePDU(True)
         self.context = context or ModbusServerContext()
         self.control = ModbusControlBlock()
         self.ignore_missing_slaves = ignore_missing_slaves
diff --git a/pymodbus/server/simulator/http_server.py b/pymodbus/server/simulator/http_server.py
@@ -25,7 +25,7 @@
 from pymodbus.datastore.simulator import Label
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.logging import Log
-from pymodbus.pdu import DecoderRequests, ExceptionResponse
+from pymodbus.pdu import DecodePDU, ExceptionResponse
 from pymodbus.server.async_io import (
     ModbusSerialServer,
     ModbusTcpServer,
@@ -214,7 +214,7 @@ def __init__(
         self.refresh_rate = 0
         self.register_filter: list[int] = []
         self.call_list: list[CallTracer] = []
-        self.request_lookup = DecoderRequests().lookup
+        self.request_lookup = DecodePDU(True).lookup
         self.call_monitor = CallTypeMonitor()
         self.call_response = CallTypeResponse()
         app_key = getattr(web, 'AppKey', str)  # fall back to str for aiohttp < 3.9.0
diff --git a/test/framer/conftest.py b/test/framer/conftest.py
@@ -4,7 +4,7 @@
 import pytest
 
 from pymodbus.framer import FRAMER_NAME_TO_CLASS, FramerType
-from pymodbus.pdu import DecoderRequests, DecoderResponses
+from pymodbus.pdu import DecodePDU
 
 
 @pytest.fixture(name="entry")
@@ -20,6 +20,4 @@ def prepare_is_server():
 @pytest.fixture(name="test_framer")
 async def prepare_test_framer(entry, is_server):
     """Return framer object."""
-    return FRAMER_NAME_TO_CLASS[entry](
-        (DecoderRequests if is_server else DecoderResponses)(),
-    )
+    return FRAMER_NAME_TO_CLASS[entry](DecodePDU(is_server))
diff --git a/test/framer/generator.py b/test/framer/generator.py
@@ -7,7 +7,7 @@
     FramerSocket,
     FramerTLS,
 )
-from pymodbus.pdu import DecoderRequests, DecoderResponses
+from pymodbus.pdu import DecodePDU
 from pymodbus.pdu import ModbusExceptions as merror
 from pymodbus.pdu.register_read_message import (
     ReadHoldingRegistersRequest,
@@ -23,13 +23,13 @@ def set_calls():
             print(f"  dev_id --> {dev_id}")
             for tid in (0, 3077):
                 print(f"    tid --> {tid}")
-                client = framer(DecoderResponses())
+                client = framer(DecodePDU(False))
                 request = ReadHoldingRegistersRequest(124, 2, dev_id)
                 request.transaction_id = tid
                 result = client.buildFrame(request)
                 print(f"      request --> {result}")
                 print(f"      request --> {result.hex()}")
-                server = framer(DecoderRequests())
+                server = framer(DecodePDU(True))
                 response = ReadHoldingRegistersResponse([141,142])
                 response.slave_id = dev_id
                 response.transaction_id = tid
diff --git a/test/framer/test_extras.py b/test/framer/test_extras.py
@@ -6,7 +6,7 @@
     FramerSocket,
     FramerTLS,
 )
-from pymodbus.pdu import DecoderRequests
+from pymodbus.pdu import DecodePDU
 
 
 TEST_MESSAGE = b"\x7b\x01\x03\x00\x00\x00\x05\x85\xC9\x7d"
@@ -30,7 +30,7 @@ class TestExtas:
     def setup_method(self):
         """Set up the test environment."""
         self.client = None
-        self.decoder = DecoderRequests()
+        self.decoder = DecodePDU(True)
         self._tcp = FramerSocket(self.decoder)
         self._tls = FramerTLS(self.decoder)
         self._rtu = FramerRTU(self.decoder)
diff --git a/test/framer/test_framer.py b/test/framer/test_framer.py
@@ -11,7 +11,7 @@
     FramerTLS,
     FramerType,
 )
-from pymodbus.pdu import DecoderResponses, ModbusPDU
+from pymodbus.pdu import DecodePDU, ModbusPDU
 
 from .generator import set_calls
 
@@ -27,7 +27,7 @@ def test_setup(self, entry, is_server):
 
     def test_base(self):
         """Test FramerBase."""
-        framer = FramerBase(DecoderResponses())
+        framer = FramerBase(DecodePDU(False))
         framer.decode(b'')
         framer.encode(b'', 0, 0)
         framer.encode(b'', 2, 0)
@@ -189,7 +189,7 @@ def test_encode_type(self, frame, frame_expected, data, dev_id, tr_id, inx1, inx
         """Test encode method."""
         if frame == FramerTLS and dev_id + tr_id:
             return
-        frame_obj = frame(DecoderResponses())
+        frame_obj = frame(DecodePDU(False))
         expected = frame_expected[inx1 + inx2 + inx3]
         encoded_data = frame_obj.encode(data, dev_id, tr_id)
         assert encoded_data == expected
diff --git a/test/framer/test_multidrop.py b/test/framer/test_multidrop.py
@@ -5,7 +5,7 @@
 
 from pymodbus.exceptions import ModbusIOException
 from pymodbus.framer import FramerAscii, FramerRTU
-from pymodbus.pdu import DecoderRequests, DecoderResponses
+from pymodbus.pdu import DecodePDU
 
 
 class TestMultidrop:
@@ -16,7 +16,7 @@ class TestMultidrop:
     @pytest.fixture(name="framer")
     def fixture_framer(self):
         """Prepare framer."""
-        return FramerRTU(DecoderRequests())
+        return FramerRTU(DecodePDU(True))
 
     @pytest.fixture(name="callback")
     def fixture_callback(self):
@@ -50,7 +50,7 @@ def test_big_split_response_frame_from_other_id(self, framer):
         """Test split response."""
         # This is a single *response* from device id 1 after being queried for 125 holding register values
         # Because the response is so long it spans several serial events
-        framer = FramerRTU(DecoderResponses())
+        framer = FramerRTU(DecodePDU(False))
         serial_events = [
             b'\x01\x03\xfa\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00',
             b'\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00\x11\x00',
@@ -153,7 +153,7 @@ def return_none(_data):
             """Return none."""
             return None
 
-        framer = FramerAscii(DecoderRequests())
+        framer = FramerAscii(DecodePDU(True))
         framer.decoder.decode = return_none
         with pytest.raises(ModbusIOException):
             framer.processIncomingFrame(b':1103007C00026E\r\n')
diff --git a/test/pdu/test_decoders.py b/test/pdu/test_decoders.py
@@ -3,14 +3,14 @@
 
 from pymodbus.exceptions import MessageRegisterException
 from pymodbus.pdu import ModbusPDU
-from pymodbus.pdu.decoders import DecoderRequests, DecoderResponses
+from pymodbus.pdu.decoders import DecodePDU
 
 
 class TestFactory:
     """Unittest for the pymod.exceptions module."""
 
-    client: DecoderResponses
-    server: DecoderRequests
+    client: DecodePDU
+    server: DecodePDU
     request = (
         (0x01, b"\x01\x00\x01\x00\x01"),  # read coils
         (0x02, b"\x02\x00\x01\x00\x01"),  # read discrete inputs
@@ -93,8 +93,8 @@ class TestFactory:
     @pytest.fixture(autouse=True)
     def _setup(self):
         """Do common setup function."""
-        self.client = DecoderResponses()
-        self.server = DecoderRequests()
+        self.client = DecodePDU(False)
+        self.server = DecodePDU(True)
 
     def test_exception_lookup(self):
         """Test that we can look up exception messages."""
diff --git a/test/sub_client/test_client_faulty_response.py b/test/sub_client/test_client_faulty_response.py
@@ -4,7 +4,7 @@
 
 from pymodbus.exceptions import ModbusIOException
 from pymodbus.framer import FramerRTU, FramerSocket
-from pymodbus.pdu import DecoderResponses
+from pymodbus.pdu import DecodePDU
 
 
 class TestFaultyResponses:
@@ -15,7 +15,7 @@ class TestFaultyResponses:
     @pytest.fixture(name="framer")
     def fixture_framer(self):
         """Prepare framer."""
-        return FramerSocket(DecoderResponses())
+        return FramerSocket(DecodePDU(False))
 
     def test_ok_frame(self, framer):
         """Test ok frame."""
@@ -26,7 +26,7 @@ def test_ok_frame(self, framer):
     def test_1917_frame(self):
         """Test invalid frame in issue 1917."""
         recv = b"\x01\x86\x02\x00\x01"
-        framer = FramerRTU(DecoderResponses())
+        framer = FramerRTU(DecodePDU(False))
         used_len, pdu = framer.processIncomingFrame(recv)
         assert not pdu
         assert used_len
diff --git a/test/sub_current/test_transaction.py b/test/sub_current/test_transaction.py
@@ -10,7 +10,7 @@
     FramerSocket,
     FramerTLS,
 )
-from pymodbus.pdu import DecoderRequests, ModbusPDU
+from pymodbus.pdu import DecodePDU, ModbusPDU
 from pymodbus.transaction import (
     ModbusTransactionManager,
     SyncModbusTransactionManager,
@@ -37,7 +37,7 @@ class TestTransaction:  # pylint: disable=too-many-public-methods
     # ----------------------------------------------------------------------- #
     def setup_method(self):
         """Set up the test environment."""
-        self.decoder = DecoderRequests()
+        self.decoder = DecodePDU(True)
         self._tcp = FramerSocket(self.decoder)
         self._tls = FramerTLS(self.decoder)
         self._rtu = FramerRTU(self.decoder)
