PDU classes --> pymodbus/pdu. (#2160)

API_changes.rst

@@ -11,6 +11,7 @@ API changes 3.7.0
 - on_connect_callback(true/false) added to async clients.
 - binary framer no longer supported
 - Framer.<type> renamed to FramerType.<type>
+- PDU classes moved to pymodbus/pdu
 
 
 API changes 3.6.0

doc/source/library/pymodbus.rst

@@ -6,84 +6,87 @@ Extra functions
     :undoc-members:
     :show-inheritance:
 
-
-.. automodule:: pymodbus.bit_read_message
+.. automodule:: pymodbus.device
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.bit_write_message
+.. automodule:: pymodbus.events
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.device
+.. automodule:: pymodbus.exceptions
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.diag_message
+.. automodule:: pymodbus.factory
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.events
+.. automodule:: pymodbus.payload
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.exceptions
+.. automodule:: pymodbus.transaction
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.factory
+.. automodule:: pymodbus.utilities
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.file_message
+
+PDU classes
+===========
+
+.. automodule:: pymodbus.pdu.bit_read_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.mei_message
+.. automodule:: pymodbus.pdu.bit_write_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.other_message
+.. automodule:: pymodbus.pdu.diag_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.payload
+.. automodule:: pymodbus.pdu.file_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.pdu
+.. automodule:: pymodbus.pdu.mei_message
     :members:
     :undoc-members:
     :show-inheritance:
-    :noindex:
 
-.. automodule:: pymodbus.register_read_message
+.. automodule:: pymodbus.pdu.other_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.register_write_message
+.. automodule:: pymodbus.pdu.pdu
     :members:
     :undoc-members:
     :show-inheritance:
+    :noindex:
 
-.. automodule:: pymodbus.transaction
+.. automodule:: pymodbus.pdu.register_read_message
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.utilities
+.. automodule:: pymodbus.pdu.register_write_message
     :members:
     :undoc-members:
     :show-inheritance:

examples/client_custom_msg.py

@@ -14,9 +14,9 @@
 import struct
 
 from pymodbus import FramerType
-from pymodbus.bit_read_message import ReadCoilsRequest
 from pymodbus.client import AsyncModbusTcpClient as ModbusClient
 from pymodbus.pdu import ModbusExceptions, ModbusRequest, ModbusResponse
+from pymodbus.pdu.bit_read_message import ReadCoilsRequest
 
 
 # --------------------------------------------------------------------------- #

examples/message_generator.py

@@ -4,14 +4,14 @@
 import codecs as c
 import logging
 
-import pymodbus.bit_read_message as modbus_bit
-import pymodbus.bit_write_message as modbus_bit_write
-import pymodbus.diag_message as modbus_diag
-import pymodbus.file_message as modbus_file
-import pymodbus.mei_message as modbus_mei
-import pymodbus.other_message as modbus_other
-import pymodbus.register_read_message as modbus_register
-import pymodbus.register_write_message as modbus_register_write
+import pymodbus.pdu.bit_read_message as modbus_bit
+import pymodbus.pdu.bit_write_message as modbus_bit_write
+import pymodbus.pdu.diag_message as modbus_diag
+import pymodbus.pdu.file_message as modbus_file
+import pymodbus.pdu.mei_message as modbus_mei
+import pymodbus.pdu.other_message as modbus_other
+import pymodbus.pdu.register_read_message as modbus_register
+import pymodbus.pdu.register_write_message as modbus_register_write
 from pymodbus.transaction import (
     ModbusAsciiFramer,
     ModbusRtuFramer,

pymodbus/client/mixin.py

@@ -5,14 +5,14 @@
 from enum import Enum
 from typing import Any, Generic, TypeVar
 
-import pymodbus.bit_read_message as pdu_bit_read
-import pymodbus.bit_write_message as pdu_bit_write
-import pymodbus.diag_message as pdu_diag
-import pymodbus.file_message as pdu_file_msg
-import pymodbus.mei_message as pdu_mei
-import pymodbus.other_message as pdu_other_msg
-import pymodbus.register_read_message as pdu_reg_read
-import pymodbus.register_write_message as pdu_req_write
+import pymodbus.pdu.bit_read_message as pdu_bit_read
+import pymodbus.pdu.bit_write_message as pdu_bit_write
+import pymodbus.pdu.diag_message as pdu_diag
+import pymodbus.pdu.file_message as pdu_file_msg
+import pymodbus.pdu.mei_message as pdu_mei
+import pymodbus.pdu.other_message as pdu_other_msg
+import pymodbus.pdu.register_read_message as pdu_reg_read
+import pymodbus.pdu.register_write_message as pdu_req_write
 from pymodbus.exceptions import ModbusException
 from pymodbus.pdu import ModbusRequest
 

pymodbus/factory.py

@@ -12,17 +12,17 @@
 # pylint: disable=missing-type-doc
 from collections.abc import Callable
 
-from pymodbus import bit_read_message as bit_r_msg
-from pymodbus import bit_write_message as bit_w_msg
-from pymodbus import diag_message as diag_msg
-from pymodbus import file_message as file_msg
-from pymodbus import mei_message as mei_msg
-from pymodbus import other_message as o_msg
-from pymodbus import pdu
-from pymodbus import register_read_message as reg_r_msg
-from pymodbus import register_write_message as reg_w_msg
 from pymodbus.exceptions import MessageRegisterException, ModbusException
 from pymodbus.logging import Log
+from pymodbus.pdu import bit_read_message as bit_r_msg
+from pymodbus.pdu import bit_write_message as bit_w_msg
+from pymodbus.pdu import diag_message as diag_msg
+from pymodbus.pdu import file_message as file_msg
+from pymodbus.pdu import mei_message as mei_msg
+from pymodbus.pdu import other_message as o_msg
+from pymodbus.pdu import pdu
+from pymodbus.pdu import register_read_message as reg_r_msg
+from pymodbus.pdu import register_write_message as reg_w_msg
 
 
 # --------------------------------------------------------------------------- #

pymodbus/pdu/__init__.py

@@ -0,0 +1,18 @@
+"""Framer."""
+__all__ = [
+    "ExceptionResponse",
+    "IllegalFunctionRequest",
+    "ModbusExceptions",
+    "ModbusPDU",
+    "ModbusRequest",
+    "ModbusResponse",
+]
+
+from pymodbus.pdu.pdu import (
+    ExceptionResponse,
+    IllegalFunctionRequest,
+    ModbusExceptions,
+    ModbusPDU,
+    ModbusRequest,
+    ModbusResponse,
+)

test/framers/generator.py

@@ -9,7 +9,7 @@
     ModbusTlsFramer,
 )
 from pymodbus.pdu import ModbusExceptions as merror
-from pymodbus.register_read_message import (
+from pymodbus.pdu.register_read_message import (
     ReadHoldingRegistersRequest,
     ReadHoldingRegistersResponse,
 )

test/framers/test_old_framers.py

@@ -4,7 +4,6 @@
 import pytest
 
 from pymodbus import FramerType
-from pymodbus.bit_read_message import ReadCoilsRequest
 from pymodbus.client.base import ModbusBaseClient
 from pymodbus.exceptions import ModbusIOException
 from pymodbus.factory import ClientDecoder
@@ -14,6 +13,7 @@
     ModbusSocketFramer,
     ModbusTlsFramer,
 )
+from pymodbus.pdu.bit_read_message import ReadCoilsRequest
 from pymodbus.transport import CommType
 from pymodbus.utilities import ModbusTransactionState
 

test/sub_client/test_client.py

@@ -6,14 +6,14 @@
 
 import pytest
 
-import pymodbus.bit_read_message as pdu_bit_read
-import pymodbus.bit_write_message as pdu_bit_write
 import pymodbus.client as lib_client
-import pymodbus.diag_message as pdu_diag
-import pymodbus.file_message as pdu_file_msg
-import pymodbus.other_message as pdu_other_msg
-import pymodbus.register_read_message as pdu_reg_read
-import pymodbus.register_write_message as pdu_req_write
+import pymodbus.pdu.bit_read_message as pdu_bit_read
+import pymodbus.pdu.bit_write_message as pdu_bit_write
+import pymodbus.pdu.diag_message as pdu_diag
+import pymodbus.pdu.file_message as pdu_file_msg
+import pymodbus.pdu.other_message as pdu_other_msg
+import pymodbus.pdu.register_read_message as pdu_reg_read
+import pymodbus.pdu.register_write_message as pdu_req_write
 from examples.helper import get_certificate
 from pymodbus import FramerType
 from pymodbus.client.base import ModbusBaseClient

test/sub_function_codes/test_all_messages.py

@@ -1,25 +1,25 @@
 """Test all messages."""
-from pymodbus.bit_read_message import (
+from pymodbus.pdu.bit_read_message import (
     ReadCoilsRequest,
     ReadCoilsResponse,
     ReadDiscreteInputsRequest,
     ReadDiscreteInputsResponse,
 )
-from pymodbus.bit_write_message import (
+from pymodbus.pdu.bit_write_message import (
     WriteMultipleCoilsRequest,
     WriteMultipleCoilsResponse,
     WriteSingleCoilRequest,
     WriteSingleCoilResponse,
 )
-from pymodbus.register_read_message import (
+from pymodbus.pdu.register_read_message import (
     ReadHoldingRegistersRequest,
     ReadHoldingRegistersResponse,
     ReadInputRegistersRequest,
     ReadInputRegistersResponse,
     ReadWriteMultipleRegistersRequest,
     ReadWriteMultipleRegistersResponse,
 )
-from pymodbus.register_write_message import (
+from pymodbus.pdu.register_write_message import (
     WriteMultipleRegistersRequest,
     WriteMultipleRegistersResponse,
     WriteSingleRegisterRequest,

test/sub_function_codes/test_bit_read_messages.py

@@ -9,13 +9,13 @@
 import struct
 from test.conftest import MockContext
 
-from pymodbus.bit_read_message import (
+from pymodbus.pdu import ModbusExceptions
+from pymodbus.pdu.bit_read_message import (
     ReadBitsRequestBase,
     ReadBitsResponseBase,
     ReadCoilsRequest,
     ReadDiscreteInputsRequest,
 )
-from pymodbus.pdu import ModbusExceptions
 
 
 res = [True] * 21

test/sub_function_codes/test_bit_write_messages.py

@@ -8,13 +8,13 @@
 """
 from test.conftest import FakeList, MockContext
 
-from pymodbus.bit_write_message import (
+from pymodbus.pdu import ModbusExceptions
+from pymodbus.pdu.bit_write_message import (
     WriteMultipleCoilsRequest,
     WriteMultipleCoilsResponse,
     WriteSingleCoilRequest,
     WriteSingleCoilResponse,
 )
-from pymodbus.pdu import ModbusExceptions
 
 
 # ---------------------------------------------------------------------------#

test/sub_function_codes/test_diag_messages.py

@@ -2,7 +2,8 @@
 import pytest
 
 from pymodbus.constants import ModbusPlusOperation
-from pymodbus.diag_message import (
+from pymodbus.exceptions import NotImplementedException
+from pymodbus.pdu.diag_message import (
     ChangeAsciiInputDelimiterRequest,
     ChangeAsciiInputDelimiterResponse,
     ClearCountersRequest,
@@ -42,7 +43,6 @@
     ReturnSlaveNoResponseCountRequest,
     ReturnSlaveNoResponseCountResponse,
 )
-from pymodbus.exceptions import NotImplementedException
 
 
 class TestDataStore:

test/sub_function_codes/test_mei_messages.py

@@ -7,7 +7,7 @@
 
 from pymodbus.constants import DeviceInformation
 from pymodbus.device import ModbusControlBlock
-from pymodbus.mei_message import (
+from pymodbus.pdu.mei_message import (
     ReadDeviceInformationRequest,
     ReadDeviceInformationResponse,
 )

test/sub_function_codes/test_other_messages.py

@@ -1,7 +1,7 @@
 """Test other messages."""
 from unittest import mock
 
-import pymodbus.other_message as pymodbus_message
+import pymodbus.pdu.other_message as pymodbus_message
 
 
 class TestOtherMessage:
@@ -86,7 +86,7 @@ def test_get_comm_event_log_with_events(self):
 
     def test_report_slave_id_request(self):
         """Test report slave id request."""
-        with mock.patch("pymodbus.other_message.DeviceInformationFactory") as dif:
+        with mock.patch("pymodbus.pdu.other_message.DeviceInformationFactory") as dif:
             # First test regular identity strings
             identity = {
                 0x00: "VN",  # VendorName
@@ -126,7 +126,7 @@ def test_report_slave_id_request(self):
 
     def test_report_slave_id(self):
         """Test report slave id."""
-        with mock.patch("pymodbus.other_message.DeviceInformationFactory") as dif:
+        with mock.patch("pymodbus.pdu.other_message.DeviceInformationFactory") as dif:
             dif.get.return_value = {}
             request = pymodbus_message.ReportSlaveIdRequest()
             request.decode(b"\x12")

test/sub_function_codes/test_register_read_messages.py

@@ -2,7 +2,7 @@
 from test.conftest import FakeList, MockContext
 
 from pymodbus.pdu import ModbusExceptions
-from pymodbus.register_read_message import (
+from pymodbus.pdu.register_read_message import (
     ReadHoldingRegistersRequest,
     ReadHoldingRegistersResponse,
     ReadInputRegistersRequest,

test/sub_function_codes/test_register_write_messages.py

@@ -3,7 +3,7 @@
 
 from pymodbus.payload import BinaryPayloadBuilder, Endian
 from pymodbus.pdu import ModbusExceptions
-from pymodbus.register_write_message import (
+from pymodbus.pdu.register_write_message import (
     MaskWriteRegisterRequest,
     MaskWriteRegisterResponse,
     WriteMultipleRegistersRequest,