Merge branch 'dev'

janiversen · janiversen · commit a5509e43f1df · 2025-09-25T12:57:44.000Z
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,6 +7,12 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.11.3
+--------------
+* Coverage 100% (using no cover, when needed). (#2783)
+* Create pypi alias for home-assistant. (#2782)
+* Bump utilities in pyproject.toml. (#2780)
+* Fix pymodbus.simulator. (#2773)
 
 Version 3.11.2
 --------------
diff --git a/MAKE_RELEASE.rst b/MAKE_RELEASE.rst
@@ -21,6 +21,7 @@ Prepare/make release on dev.
         cd doc; ./build_html
    * rm -rf build/* dist/*
    * python3 -m build
+   * pypi-alias pymodbus_ha_core
    * twine check dist/*
    * Commit, push and merge.
    * Wait for CI to complete
diff --git a/README.rst b/README.rst
@@ -35,7 +35,7 @@ as well as the
 `API_changes <https://github.com/pymodbus-dev/pymodbus/blob/dev/API_changes.rst>`_
 files.
 
-Current release is `3.11.2 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.2>`_.
+Current release is `3.11.3 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.3>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
@@ -48,14 +48,31 @@ Source code on `github <https://github.com/pymodbus-dev/pymodbus>`_
 
 Full documentation for newest releases as well as the bleeding edge (dev) `readthedocs <https://pymodbus.readthedocs.io>`_
 
+pymodbus is maintained in 2 versions:
+- pymodbus, the official library
+- pymodbus_ha_core
+
+Pymodbus_ha_core
+----------------
+`Pymodbus_ha_core <https://pypi.org/project/pymodbus-ha-core/>`_ is
+an alias to pymodbus, available on pypi.org.
+
+Being an alias means it is 100% the same as pymodbus, without any extra
+code, just another name.
+
+This allows home-assistant to use a pymodbus version for the modbus integration,
+while custom_components use another version.
+
+We are offering to make other aliases for projects who need this, please
+open an issue in the pymodbus project, with an explanation of why it is
+needed.
 
 Pymodbus in a nutshell
 ----------------------
 Pymodbus consist of 5 parts:
 
 - **client**, connect to your favorite device(s)
 - **server**, simulate your favorite device(s)
-- **repl**, a commandline text based client/server simulator
 - **simulator**, an html based server simulator
 - **examples**, showing both simple and advances usage
 
@@ -99,17 +116,6 @@ Server Features
 `Server documentation <https://pymodbus.readthedocs.io/en/latest/source/server.html>`_
 
 
-REPL Features
-^^^^^^^^^^^^^
-- Server/client commandline emulator
-- Easy test of real device (client)
-- Easy test of client app (server)
-- Simulation of broken requests/responses
-- Simulation of error responses (hard to provoke in real devices)
-
-`REPL documentation <https://github.com/pymodbus-dev/repl>`_
-
-
 Simulator Features
 ^^^^^^^^^^^^^^^^^^
 - Server simulator with WEB interface
@@ -182,7 +188,6 @@ This will install pymodbus with the pyserial dependency.
 
 Pymodbus offers a number of extra options:
 
-- **repl**, needed by pymodbus.repl
 - **serial**, needed for serial communication
 - **simulator**, needed by pymodbus.simulator
 - **documentation**, needed to generate documentation
diff --git a/doc/source/_static/examples.tgz b/doc/source/_static/examples.tgz
diff --git a/doc/source/_static/examples.zip b/doc/source/_static/examples.zip
diff --git a/examples/client_sync.py b/examples/client_sync.py
@@ -119,7 +119,7 @@ def run_sync_client(client, modbus_calls=None):
     """Run sync client."""
     _logger.info("### Client starting")
     client.connect()
-    if modbus_calls:
+    if modbus_calls:  # pragma: no cover
         modbus_calls(client)
     client.close()
     _logger.info("### End of Program")
diff --git a/examples/custom_msg.py b/examples/custom_msg.py
@@ -54,7 +54,7 @@ def encode(self):
         :returns: The encoded packet message
         """
         res = struct.pack(">B", len(self.values) * 2)
-        for register in self.values:
+        for register in self.values:  # pragma: no cover
             res += struct.pack(">H", register)
         return res
 
@@ -65,7 +65,7 @@ def decode(self, data):
         """
         byte_count = int(data[0])
         self.values = []
-        for i in range(1, byte_count + 1, 2):
+        for i in range(1, byte_count + 1, 2):  # pragma: no cover
             self.values.append(struct.unpack(">H", data[i : i + 2])[0])
 
 
@@ -144,7 +144,7 @@ async def main(host="localhost", port=5020):
         request1 = CustomRequest(32, device_id=device_id)
         try:
             result = await client.execute(False, request1)
-        except ModbusIOException:
+        except ModbusIOException:  # pragma: no cover
             print("Server do not support CustomRequest.")
         else:
             print(result)
diff --git a/examples/datastore_simulator_share.py b/examples/datastore_simulator_share.py
@@ -142,9 +142,9 @@ def get_commandline(cmdline=None):
 
 def setup_simulator(setup=None, actions=None, cmdline=None):
     """Run server setup."""
-    if not setup:
+    if not setup:  # pragma: no cover
         setup=demo_config
-    if not actions:
+    if not actions:  # pragma: no cover
         actions=demo_actions
     args = get_commandline(cmdline=cmdline)
     pymodbus_apply_logging_config(args.log.upper())
diff --git a/examples/helper.py b/examples/helper.py
@@ -92,7 +92,7 @@ def get_commandline(server: bool = False, description: str | None = None, extras
             default=10,
             type=float,
         )
-    if extras:
+    if extras:  # pragma: no cover
         for extra in extras:
             parser.add_argument(extra[0], **extra[1])
     args = parser.parse_args(cmdline)
@@ -120,13 +120,13 @@ def get_certificate(suffix: str):
     """Get example certificate."""
     delimiter = "\\" if os.name == "nt" else "/"
     cwd = os.getcwd().split(delimiter)[-1]
-    if cwd == "examples":
+    if cwd == "examples":  # pragma: no cover
         path = "."
-    elif cwd == "sub_examples":
+    elif cwd == "sub_examples":  # pragma: no cover
         path = "../../examples"
-    elif cwd == "test":
+    elif cwd == "test":  # pragma: no cover
         path = "../examples"
-    elif cwd == "pymodbus":
+    elif cwd == "pymodbus":  # pragma: no cover
         path = "examples"
     else:
         raise RuntimeError(f"**Error** Cannot find certificate path={cwd}")
diff --git a/examples/message_parser.py b/examples/message_parser.py
@@ -96,7 +96,7 @@ def report(self, message):
             f"{'name':.15s} = {message.__class__.__name__}"
         )
         for k_dict, v_dict in message.__dict__.items():
-            if isinstance(v_dict, dict):
+            if isinstance(v_dict, dict):  # pragma: no cover
                 print(f"{k_dict:.15s} =")
                 for k_item, v_item in v_dict.items():
                     print(f"  {k_item:.12s} => {v_item}"
@@ -121,7 +121,7 @@ def parse_messages(cmdline=None):
     args = get_commandline(cmdline=cmdline)
     pymodbus_apply_logging_config(args.log.upper())
     _logger.setLevel(args.log.upper())
-    if not args.message:
+    if not args.message:  # pragma: no cover
         _logger.error("Missing --message.")
         return
 
diff --git a/examples/server_async.py b/examples/server_async.py
@@ -79,19 +79,19 @@ def setup_server(description=None, context=None, cmdline=None):
         # If you initialize a DataBlock to addresses of 0x00 to 0xFF, a request to
         # 0x100 will respond with an invalid address exception.
         # This is because many devices exhibit this kind of behavior (but not all)
-        if args.store == "sequential":
+        if args.store == "sequential":  # pragma: no cover
             # Continuing, use a sequential block without gaps.
             datablock = lambda : ModbusSequentialDataBlock(0x00, [17] * 100)  # pylint: disable=unnecessary-lambda-assignment
-        elif args.store == "sparse":
+        elif args.store == "sparse":  # pragma: no cover
             # Continuing, or use a sparse DataBlock which can have gaps
             datablock = lambda : ModbusSparseDataBlock({0x00: 0, 0x05: 1})  # pylint: disable=unnecessary-lambda-assignment
-        elif args.store == "factory":
+        elif args.store == "factory":  # pragma: no cover
             # Alternately, use the factory methods to initialize the DataBlocks
             # or simply do not pass them to have them initialized to 0x00 on the
             # full address range::
             datablock = lambda : ModbusSequentialDataBlock.create()  # pylint: disable=unnecessary-lambda-assignment,unnecessary-lambda
 
-        if args.device_ids > 1:
+        if args.device_ids > 1:  # pragma: no cover
             # The server then makes use of a server context that allows the server
             # to respond with different device contexts for different device ids.
             # By default it will return the same context for every device id supplied
@@ -185,7 +185,7 @@ async def run_async_server(args) -> None:
             # ignore_missing_devices=True,  # ignore request to a missing device
             # broadcast_enable=False,  # treat device_id 0 as broadcast address,
         )
-    elif args.comm == "tls":
+    elif args.comm == "tls":  # pragma: no cover
         address = (args.host if args.host else "", args.port if args.port else None)
         await StartAsyncTlsServer(
             context=args.context,  # Data storage
@@ -208,7 +208,7 @@ async def run_async_server(args) -> None:
         )
 
 
-async def async_helper() -> None:
+async def async_helper() -> None:  # pragma: no cover
     """Combine setup and run."""
     _logger.info("Starting...")
     run_args = setup_server(description="Run asynchronous server.")
diff --git a/examples/server_sync.py b/examples/server_sync.py
@@ -90,7 +90,7 @@ def run_sync_server(args) -> None:
             # broadcast_enable=False,  # treat device_id 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
-    elif args.comm == "serial":
+    elif args.comm == "serial":  # pragma: no cover
         # socat -d -d PTY,link=/tmp/ptyp0,raw,echo=0,ispeed=9600
         #             PTY,link=/tmp/ttyp0,raw,echo=0,ospeed=9600
         StartSerialServer(
@@ -108,7 +108,7 @@ def run_sync_server(args) -> None:
             # ignore_missing_devices=True,  # ignore request to a missing device
             # broadcast_enable=False,  # treat device_id 0 as broadcast address,
         )
-    elif args.comm == "tls":
+    elif args.comm == "tls":  # pragma: no cover
         address = ("", args.port) if args.port else None
         StartTlsServer(
             context=args.context,  # Data storage
@@ -131,7 +131,7 @@ def run_sync_server(args) -> None:
         )
 
 
-def sync_helper() -> None:
+def sync_helper() -> None:  # pragma: no cover
     """Combine setup and run."""
     run_args = server_async.setup_server(description="Run synchronous server.")
     run_sync_server(run_args)
diff --git a/examples/simple_async_client.py b/examples/simple_async_client.py
@@ -44,7 +44,7 @@ async def run_async_simple_client(comm, host, port, framer=FramerType.SOCKET):
             # retries=3,
             # source_address=None,
         )
-    elif comm == "serial":
+    elif comm == "serial":  # pragma: no cover
         client = ModbusClient.AsyncModbusSerialClient(
             port,
             framer=framer,
@@ -56,7 +56,7 @@ async def run_async_simple_client(comm, host, port, framer=FramerType.SOCKET):
             stopbits=1,
             # handle_local_echo=False,
         )
-    else:
+    else:  # pragma: no cover
         print(f"Unknown client {comm} selected")
         return
 
@@ -69,23 +69,23 @@ async def run_async_simple_client(comm, host, port, framer=FramerType.SOCKET):
     try:
         # See all calls in client_calls.py
         rr = await client.read_coils(1, count=1, device_id=1)
-    except ModbusException as exc:
+    except ModbusException as exc:  # pragma: no cover
         print(f"Received ModbusException({exc}) from library")
         client.close()
         return
-    if rr.isError():
+    if rr.isError():  # pragma: no cover
         print(f"Received exception from device ({rr})")
         # THIS IS NOT A PYTHON EXCEPTION, but a valid modbus message
         client.close()
         return
     try:
         # See all calls in client_calls.py
         rr = await client.read_holding_registers(10, count=2, device_id=1)
-    except ModbusException as exc:
+    except ModbusException as exc:  # pragma: no cover
         print(f"Received ModbusException({exc}) from library")
         client.close()
         return
-    if rr.isError():
+    if rr.isError():  # pragma: no cover
         print(f"Received exception from device ({rr})")
         # THIS IS NOT A PYTHON EXCEPTION, but a valid modbus message
         client.close()
diff --git a/examples/simple_sync_client.py b/examples/simple_sync_client.py
@@ -46,7 +46,7 @@ def run_sync_simple_client(comm, host, port, framer=FramerType.SOCKET):
             # retries=3,
             # source_address=None,
         )
-    elif comm == "serial":
+    elif comm == "serial":  # pragma: no cover
         client = ModbusClient.ModbusSerialClient(
             port,
             framer=framer,
@@ -58,7 +58,7 @@ def run_sync_simple_client(comm, host, port, framer=FramerType.SOCKET):
             stopbits=1,
             # handle_local_echo=False,
         )
-    else:
+    else:  # pragma: no cover
         print(f"Unknown client {comm} selected")
         return
 
@@ -68,23 +68,23 @@ def run_sync_simple_client(comm, host, port, framer=FramerType.SOCKET):
     print("get and verify data")
     try:
         rr = client.read_coils(1, count=1, device_id=1)
-    except ModbusException as exc:
+    except ModbusException as exc:  # pragma: no cover
         print(f"Received ModbusException({exc}) from library")
         client.close()
         return
-    if rr.isError():
+    if rr.isError():  # pragma: no cover
         print(f"Received exception from device ({rr})")
         # THIS IS NOT A PYTHON EXCEPTION, but a valid modbus message
         client.close()
         return
     try:
         # See all calls in client_calls.py
         rr = client.read_holding_registers(10, count=2, device_id=1)
-    except ModbusException as exc:
+    except ModbusException as exc:  # pragma: no cover
         print(f"Received ModbusException({exc}) from library")
         client.close()
         return
-    if rr.isError():
+    if rr.isError():  # pragma: no cover
         print(f"Received exception from device ({rr})")
         # THIS IS NOT A PYTHON EXCEPTION, but a valid modbus message
         client.close()
diff --git a/pymodbus/__init__.py b/pymodbus/__init__.py
@@ -20,5 +20,5 @@
 from pymodbus.pdu.device import ModbusDeviceIdentification
 
 
-__version__ = "3.11.2"
+__version__ = "3.11.3"
 __version_full__ = f"[pymodbus, version {__version__}]"
diff --git a/pymodbus/server/simulator/main.py b/pymodbus/server/simulator/main.py
@@ -115,5 +115,9 @@ async def run_main(cmdline=None):
     task = ModbusSimulatorServer(**cmd_args)
     await task.run_forever()
 
+def main():  # pragma: no cover
+    """Run simulator."""
+    asyncio.run(run_main(), debug=True)
+
 if __name__ == "__main__":
     asyncio.run(run_main(), debug=True)
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/test/datastore/test_remote_datastore.py b/test/datastore/test_remote_datastore.py
diff --git a/test/examples/test_client_server_sync.py b/test/examples/test_client_server_sync.py
diff --git a/test/server/test_startstop.py b/test/server/test_startstop.py
diff --git a/test/transport/test_serial.py b/test/transport/test_serial.py
