Split server into each transport.

janiversen · janiversen · commit 8512581aca2d · 2022-09-01T19:11:03.000+02:00
diff --git a/doc/source/library/pymodbus.client.rst b/doc/source/library/pymodbus.client.rst
@@ -1,3 +1,5 @@
+
+
 ================
 pymodbus\.client
 ================
diff --git a/doc/source/library/pymodbus.server.rst b/doc/source/library/pymodbus.server.rst
@@ -1,3 +1,25 @@
+================
+pymodbus\.server
+================
+
+Pymodbus offers servers with transport protocols for
+
+- *Serial* (RS-485) typically using a dongle
+- *TCP*
+- *TLS*
+- *UDP*
+- possibility to add a custom transport protocol
+
+communication in 2 versions:
+
+- :mod:`synchronous server`,
+- :mod:`asynchronous server` using asyncio.
+
+*Remark* All servers are implemented with asyncio, and the
+synchronous servers are just an interface layer allowing synchronous
+applications to use the server as if it was synchronous.
+
+
 pymodbus\.server package
 ========================
 
@@ -9,18 +31,10 @@ pymodbus\.server package
 Submodules
 ----------
 
-pymodbus\.server\.asynchronous module
--------------------------------------
+pymodbus\.server module
+-----------------------
 
 .. automodule:: pymodbus.server.async_io
     :members:
     :undoc-members:
     :show-inheritance:
-
-pymodbus\.server\.sync module
------------------------------
-
-.. automodule:: pymodbus.server.sync
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/examples/common/callback_server.py b/examples/common/callback_server.py
@@ -16,7 +16,7 @@
     ModbusSparseDataBlock,
 )
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartTcpServer
 
 # --------------------------------------------------------------------------- #
 # import the modbus libraries we need
diff --git a/examples/common/custom_datablock.py b/examples/common/custom_datablock.py
@@ -13,7 +13,7 @@
     ModbusSparseDataBlock,
 )
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartTcpServer
 
 # --------------------------------------------------------------------------- #
 # import the modbus libraries we need
diff --git a/examples/common/custom_synchronous_server.py b/examples/common/custom_synchronous_server.py
@@ -67,7 +67,7 @@ def decode(self, data):
     ModbusSlaveContext,
 )
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.sync import StartTcpServer
+from pymodbus.server import StartTcpServer
 from pymodbus.version import version
 
 
diff --git a/examples/common/dbstore_update_server.py b/examples/common/dbstore_update_server.py
@@ -20,7 +20,7 @@
 from pymodbus.datastore import ModbusSequentialDataBlock, ModbusServerContext
 from pymodbus.datastore.database import SqlSlaveContext
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartAsyncTcpServer
 
 # --------------------------------------------------------------------------- #
 # import the modbus libraries we need
@@ -68,7 +68,7 @@ def updating_writer(parm1):
     log.debug(txt)
 
 
-def run_dbstore_update_server():
+async def run_dbstore_update_server():
     """Run dbstore update server."""
     # ----------------------------------------------------------------------- #
     # initialize your data store
@@ -100,8 +100,8 @@ def run_dbstore_update_server():
     loop = asyncio.get_event_loop()
     loop.start(time, now=False)  # initially delay by time
     loop.stop()
-    StartTcpServer(context, identity=identity, address=("", 5020))
+    await StartAsyncTcpServer(context, identity=identity, address=("", 5020))
 
 
 if __name__ == "__main__":
-    run_dbstore_update_server()
+    asyncio.run(run_dbstore_update_server())
diff --git a/examples/common/payload_server.py b/examples/common/payload_server.py
@@ -14,7 +14,7 @@
 )
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.payload import BinaryPayloadBuilder
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartAsyncTcpServer
 
 # --------------------------------------------------------------------------- #
 # import the various server implementations
@@ -73,7 +73,7 @@ async def run_payload_server():
             "MajorMinorRevision": version.short(),
         }
     )
-    server = await StartTcpServer(
+    server = await StartAsyncTcpServer(
         context,
         identity=identity,
         address=("0.0.0.0", 5020),
diff --git a/examples/common/updating_server.py b/examples/common/updating_server.py
@@ -18,7 +18,7 @@
     ModbusSlaveContext,
 )
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartAsyncTcpServer
 from pymodbus.version import version
 
 
@@ -85,7 +85,7 @@ async def run_updating_server():
     # run the server you want
     # ----------------------------------------------------------------------- #
     log.debug("Start server")
-    await StartTcpServer(
+    await StartAsyncTcpServer(
         context, identity=identity, address=("localhost", 5020), defer_start=False
     )
     log.debug("Done")
diff --git a/examples/contrib/deviceinfo_showcase_server.py b/examples/contrib/deviceinfo_showcase_server.py
@@ -13,11 +13,11 @@
 from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import ModbusServerContext, ModbusSlaveContext
 
-# from pymodbus.server.sync import StartUdpServer
-# from pymodbus.server.sync import StartSerialServer
+# from pymodbus.server import StartUdpServer
+# from pymodbus.server import StartSerialServer
 # from pymodbus.transaction import ModbusRtuFramer, ModbusBinaryFramer
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.sync import StartTcpServer
+from pymodbus.server import StartTcpServer
 
 # --------------------------------------------------------------------------- #
 # import the various server implementations
diff --git a/examples/contrib/modbus_mapper.py b/examples/contrib/modbus_mapper.py
@@ -38,7 +38,7 @@
 
     from modbus_mapper import csv_mapping_parser
     from modbus_mapper import modbus_context_decoder
-    from pymodbus.client.ssync import StartTcpServer
+    from pymodbus.server import StartTcpServer
     from pymodbus.datastore.context import ModbusServerContext
 
     template = ["address", "value", "function", "name", "description"]
diff --git a/examples/contrib/modbus_simulator.py b/examples/contrib/modbus_simulator.py
@@ -9,7 +9,7 @@
 import pickle  # nosec
 
 from pymodbus.datastore import ModbusServerContext, ModbusSlaveContext
-from pymodbus.server.async_io import StartTcpServer
+from pymodbus.server import StartTcpServer
 
 
 # -------------------------------------------------------------------------- #
diff --git a/examples/modbus_forwarder.py b/examples/modbus_forwarder.py
@@ -16,7 +16,7 @@
 from pymodbus.client import ModbusTcpClient
 from pymodbus.datastore import ModbusServerContext
 from pymodbus.datastore.remote import RemoteSlaveContext
-from pymodbus.server.sync import StartTcpServer
+from pymodbus.server import StartTcpServer
 
 
 def run_forwarder():
@@ -42,7 +42,7 @@ def run_forwarder():
 
     # start forwarding client and server
     client.connect()
-    StartTcpServer(context, address=("localhost", port_server))
+    StartTcpServer(context=context, address=("localhost", port_server))
     # loop forever
 
 
diff --git a/examples/server_async.py b/examples/server_async.py
@@ -42,11 +42,11 @@
 # --------------------------------------------------------------------------- #
 # import the various client implementations
 # --------------------------------------------------------------------------- #
-from pymodbus.server.async_io import (
-    StartSerialServer,
-    StartTcpServer,
-    StartTlsServer,
-    StartUdpServer,
+from pymodbus.server import (
+    StartAsyncSerialServer,
+    StartAsyncTcpServer,
+    StartAsyncTlsServer,
+    StartAsyncUdpServer,
 )
 from pymodbus.transaction import (
     ModbusAsciiFramer,
@@ -151,7 +151,7 @@ async def run_server(args=None):
 
     _logger.info("### start server")
     if server_id == "tcp":
-        server = await StartTcpServer(
+        server = await StartAsyncTcpServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             # TBD host=
@@ -168,7 +168,7 @@ async def run_server(args=None):
             defer_start=defer_start,  # Only define server do not activate
         )
     elif server_id == "udp":
-        server = await StartUdpServer(
+        server = await StartAsyncUdpServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             address=("127.0.0.1", port),  # listen address
@@ -185,7 +185,7 @@ async def run_server(args=None):
     elif server_id == "serial":
         # socat -d -d PTY,link=/tmp/ptyp0,raw,echo=0,ispeed=9600
         #             PTY,link=/tmp/ttyp0,raw,echo=0,ospeed=9600
-        server = await StartSerialServer(
+        server = await StartAsyncSerialServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             # timeout=0.005,  # waiting time for request to complete
@@ -204,7 +204,7 @@ async def run_server(args=None):
             defer_start=defer_start,  # Only define server do not activate
         )
     elif server_id == "tls":
-        server = await StartTlsServer(
+        server = await StartAsyncTlsServer(
             context=store,  # Data storage
             host="localhost",  # define tcp address where to connect to.
             # port=port,  # on which port
diff --git a/examples/server_sync.py b/examples/server_sync.py
@@ -41,7 +41,7 @@
 # --------------------------------------------------------------------------- #
 # import the various client implementations
 # --------------------------------------------------------------------------- #
-from pymodbus.server.sync import (
+from pymodbus.server import (
     StartSerialServer,
     StartTcpServer,
     StartTlsServer,
diff --git a/pymodbus/client/__init__.py b/pymodbus/client/__init__.py
@@ -1,4 +1,4 @@
-"""Initialize client.
+"""Client.
 
 import external classes, to make them easier to use:
 """
diff --git a/pymodbus/server/__init__.py b/pymodbus/server/__init__.py
@@ -1 +1,29 @@
-"""Nothing special."""
+"""Server.
+
+import external classes, to make them easier to use:
+"""
+from pymodbus.server.async_io import (
+    StartAsyncTcpServer,
+    StartAsyncTlsServer,
+    StartAsyncUdpServer,
+    StartAsyncSerialServer,
+    StartSerialServer,
+    StartTcpServer,
+    StartTlsServer,
+    StartUdpServer,
+)
+
+
+# ---------------------------------------------------------------------------#
+#  Exported symbols
+# ---------------------------------------------------------------------------#
+__all__ = [
+    "StartAsyncTcpServer",
+    "StartAsyncTlsServer",
+    "StartAsyncUdpServer",
+    "StartAsyncSerialServer",
+    "StartSerialServer",
+    "StartTcpServer",
+    "StartTlsServer",
+    "StartUdpServer",
+]
diff --git a/pymodbus/server/async_io.py b/pymodbus/server/async_io.py
diff --git a/pymodbus/server/sync.py b/pymodbus/server/sync.py
diff --git a/pymodbus/server/tls_helper.py b/pymodbus/server/tls_helper.py
diff --git a/test/test_examples.py b/test/test_examples.py
diff --git a/test/test_server_asyncio.py b/test/test_server_asyncio.py
diff --git a/test/test_server_sync.py b/test/test_server_sync.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+`
	`2`	`+`
`1`	`3`	`================`
`2`	`4`	`pymodbus\.client`
`3`	`5`	`================`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`ModbusSparseDataBlock,`
`17`	`17`	`)`
`18`	`18`	`from pymodbus.device import ModbusDeviceIdentification`
`19`		`-from pymodbus.server.async_io import StartTcpServer`
	`19`	`+from pymodbus.server import StartTcpServer`
`20`	`20`
`21`	`21`	`# --------------------------------------------------------------------------- #`
`22`	`22`	`# import the modbus libraries we need`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`ModbusSparseDataBlock,`
`14`	`14`	`)`
`15`	`15`	`from pymodbus.device import ModbusDeviceIdentification`
`16`		`-from pymodbus.server.async_io import StartTcpServer`
	`16`	`+from pymodbus.server import StartTcpServer`
`17`	`17`
`18`	`18`	`# --------------------------------------------------------------------------- #`
`19`	`19`	`# import the modbus libraries we need`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ def decode(self, data):`
`67`	`67`	`ModbusSlaveContext,`
`68`	`68`	`)`
`69`	`69`	`from pymodbus.device import ModbusDeviceIdentification`
`70`		`-from pymodbus.server.sync import StartTcpServer`
	`70`	`+from pymodbus.server import StartTcpServer`
`71`	`71`	`from pymodbus.version import version`
`72`	`72`
`73`	`73`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`)`
`15`	`15`	`from pymodbus.device import ModbusDeviceIdentification`
`16`	`16`	`from pymodbus.payload import BinaryPayloadBuilder`
`17`		`-from pymodbus.server.async_io import StartTcpServer`
	`17`	`+from pymodbus.server import StartAsyncTcpServer`
`18`	`18`
`19`	`19`	`# --------------------------------------------------------------------------- #`
`20`	`20`	`# import the various server implementations`
`@@ -73,7 +73,7 @@ async def run_payload_server():`
`73`	`73`	`"MajorMinorRevision": version.short(),`
`74`	`74`	`}`
`75`	`75`	`)`
`76`		`- server = await StartTcpServer(`
	`76`	`+ server = await StartAsyncTcpServer(`
`77`	`77`	`context,`
`78`	`78`	`identity=identity,`
`79`	`79`	`address=("0.0.0.0", 5020),`