Merge new message layer and old framer directory. (#2135)

* message ==> framers.

* Rename message to framing.

* Framer ==> FramerType.

* Update doc.

* Move complete.

Author: janiversen

API_changes.rst

@@ -10,6 +10,7 @@ API changes 3.7.0
 - on_reconnect_callback() removed from clients (sync/async).
 - on_connect_callback(true/false) added to async clients.
 - binary framer no longer supported
+- Framer.<type> renamed to FramerType.<type>
 
 
 API changes 3.6.0

check_ci.sh

@@ -9,5 +9,5 @@ codespell
 ruff check --fix --exit-non-zero-on-fix .
 pylint --recursive=y examples pymodbus test
 mypy pymodbus
-pytest --cov --numprocesses auto
+pytest -x --cov --numprocesses auto
 echo "Ready to push"

doc/source/_static/examples.tgz

@@ -5,14 +5,16 @@ The internal structure of pymodbus is a bit complicated, mostly due to the mixtu
 
 The overall architecture can be viewed as:
 
+
     Client classes (interface to applications)
     mixin (interface with all requests defined as methods)
-    transaction (handles transactions and allow concurrent calls)
-    framers (add pre/post headers to make a valid package)
-    transport (handles actual transportation)
+    Lower levels are Common
 
     Server classes (interface to applications)
     datastores (handles registers/values to be returned)
+    Lower levels are Common
+
+    pdu (build/create response/request class)
     transaction (handles transactions and allow concurrent calls)
     framers (add pre/post headers to make a valid package)
     transport (handles actual transportation)
@@ -25,4 +27,3 @@ In detail the packages can viewed as:
 In detail the classes can be viewed as:
 
 .. image:: classes.png
-

doc/source/_static/examples.zip

@@ -1,26 +1,34 @@
 Framer
 ======
 
-pymodbus\.framer\.ascii_framer module
--------------------------------------
+pymodbus\.framer\.old_framer_ascii module
+-----------------------------------------
 
-.. automodule:: pymodbus.framer.ascii_framer
+.. automodule:: pymodbus.framer.old_framer_ascii
     :members:
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.framer\.rtu_framer module
------------------------------------
+pymodbus\.framer\.old_framer_rtu module
+---------------------------------------
 
-.. automodule:: pymodbus.framer.rtu_framer
+.. automodule:: pymodbus.framer.old_framer_rtu
     :members:
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.framer\.socket_framer module
---------------------------------------
+pymodbus\.framer\.old_framer_socket module
+------------------------------------------
 
-.. automodule:: pymodbus.framer.socket_framer
+.. automodule:: pymodbus.framer.old_framer_socket
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pymodbus\.framer\.old_framer_tls module
+---------------------------------------
+
+.. automodule:: pymodbus.framer.old_framer_tls
     :members:
     :undoc-members:
     :show-inheritance:

doc/source/library/architecture/architecture.rst

@@ -13,7 +13,7 @@
 import asyncio
 import struct
 
-from pymodbus import Framer
+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
@@ -118,7 +118,7 @@ def __init__(self, address, **kwargs):
 
 async def main(host="localhost", port=5020):
     """Run versions of read coil."""
-    async with ModbusClient(host=host, port=port, framer_name=Framer.SOCKET) as client:
+    async with ModbusClient(host=host, port=port, framer_name=FramerType.SOCKET) as client:
         await client.connect()
 
         # new modbus function code.

doc/source/library/framer.rst

@@ -16,7 +16,7 @@
 import asyncio
 import time
 
-from pymodbus import Framer
+from pymodbus import FramerType
 from pymodbus.client import AsyncModbusSerialClient, ModbusSerialClient
 
 
@@ -29,7 +29,7 @@ def run_sync_client_test():
     print("--- Testing sync client v3.4.1")
     client = ModbusSerialClient(
         "/dev/ttys007",
-        framer_name=Framer.RTU,
+        framer_name=FramerType.RTU,
         baudrate=9600,
     )
     client.connect()
@@ -56,7 +56,7 @@ async def run_async_client_test():
     print("--- Testing async client v3.4.1")
     client = AsyncModbusSerialClient(
         "/dev/ttys007",
-        framer_name=Framer.RTU,
+        framer_name=FramerType.RTU,
         baudrate=9600,
     )
     await client.connect()

examples/client_custom_msg.py

@@ -49,7 +49,7 @@
 
 import pymodbus.client as modbusClient
 import pymodbus.server as modbusServer
-from pymodbus import Framer, ModbusException, pymodbus_apply_logging_config
+from pymodbus import FramerType, ModbusException, pymodbus_apply_logging_config
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
@@ -160,14 +160,14 @@ def __init__(self, comm: CommType):
         if comm == CommType.TCP:
             self.server = modbusServer.ModbusTcpServer(
                 self.context,
-                framer=Framer.SOCKET,
+                framer=FramerType.SOCKET,
                 identity=self.identity,
                 address=(NULLMODEM_HOST, test_port),
             )
         elif comm == CommType.SERIAL:
             self.server = modbusServer.ModbusSerialServer(
                 self.context,
-                framer=Framer.SOCKET,
+                framer=FramerType.SOCKET,
                 identity=self.identity,
                 port=f"{NULLMODEM_HOST}:{test_port}",
             )

examples/client_performance.py

@@ -7,7 +7,7 @@
 import asyncio
 import logging
 
-from pymodbus import Framer, pymodbus_apply_logging_config
+from pymodbus import FramerType, pymodbus_apply_logging_config
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
@@ -63,7 +63,7 @@ async def setup(self):
         )
         self.server = ModbusTcpServer(
             context,
-            Framer.SOCKET,
+            FramerType.SOCKET,
             None,
             ("127.0.0.1", 5020),
             request_tracer=self.server_request_tracer,