modsim 0.5.2__tar.gz → 1.0.0__tar.gz

{modsim-0.5.2 → modsim-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modsim
-Version: 0.5.2
+Version: 1.0.0
 Summary: A Simple Modbus TCP Device Simulator used for modpoll tool
 Home-page: https://github.com/gavinying/modsim
 Author: Ying Shaodong
@@ -11,7 +11,6 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: pymodbus (>=3.6.9,<3.7.0)
 Project-URL: Documentation, https://gavinying.github.io/modsim/
 Project-URL: Repository, https://github.com/gavinying/modsim
@@ -89,8 +88,12 @@ To verify it, you can test by [modpoll](https://github.com/gavinying/modpoll) to
 modpoll \
   --tcp localhost \
   --tcp-port 5020 \
-  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  --config https://raw.githubusercontent.com/gavinying/modpoll/main/examples/modsim.csv
 ```
 
 > **_Note_**: add `sudo` before `docker run` command if you want to use the Modbus TCP standard port `502`.
 
+## Local server behavior
+
+Run the simulator without Docker with `python -m modsim --comm tcp --port 5020`. The default server exposes the four Modbus tables with the sample data shown above. Coil and holding-register writes are supported; discrete inputs and input registers are read-only. Requests outside an initialized address range return a Modbus exception. The server handles SIGINT and SIGTERM by stopping its listener so the port can be reused after shutdown.
+

{modsim-0.5.2 → modsim-1.0.0}/README.md

@@ -70,7 +70,11 @@ To verify it, you can test by [modpoll](https://github.com/gavinying/modpoll) to
 modpoll \
   --tcp localhost \
   --tcp-port 5020 \
-  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  --config https://raw.githubusercontent.com/gavinying/modpoll/main/examples/modsim.csv
 ```
 
 > **_Note_**: add `sudo` before `docker run` command if you want to use the Modbus TCP standard port `502`.
+
+## Local server behavior
+
+Run the simulator without Docker with `python -m modsim --comm tcp --port 5020`. The default server exposes the four Modbus tables with the sample data shown above. Coil and holding-register writes are supported; discrete inputs and input registers are read-only. Requests outside an initialized address range return a Modbus exception. The server handles SIGINT and SIGTERM by stopping its listener so the port can be reused after shutdown.

modsim-1.0.0/modsim/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

{modsim-0.5.2 → modsim-1.0.0}/modsim/main.py

@@ -25,6 +25,8 @@ The corresponding client can be started as:
 
 import os
 import asyncio
+import signal
+from contextlib import suppress
 from typing import Any
 
 from pymodbus.constants import Endian
@@ -40,6 +42,7 @@ from pymodbus.server import (
     StartAsyncTcpServer,
     StartAsyncTlsServer,
     StartAsyncUdpServer,
+    ServerAsyncStop,
 )
 
 from . import __version__
@@ -225,10 +228,51 @@ def app() -> None:
     )
 
     run_args = setup_server(get_commandline())
-    asyncio.run(run_async_server(run_args), debug=True)
+    asyncio.run(_run_server_with_signals(run_args), debug=True)
 
     _logger.info("exiting.")
 
 
+async def _run_server_with_signals(args: Any) -> None:
+    """Run the server and close its listener when the process is signaled."""
+    loop = asyncio.get_running_loop()
+    server_task = asyncio.create_task(run_async_server(args))
+    stop_requested = False
+
+    async def stop_server() -> None:
+        for _ in range(100):
+            if server_task.done():
+                return
+            try:
+                await ServerAsyncStop()
+                return
+            except (AttributeError, RuntimeError):
+                await asyncio.sleep(0.01)
+
+    def request_stop() -> None:
+        nonlocal stop_requested
+        if not stop_requested:
+            stop_requested = True
+            loop.create_task(stop_server())
+
+    installed_signals = []
+    for signum in (signal.SIGINT, signal.SIGTERM):
+        try:
+            loop.add_signal_handler(signum, request_stop)
+            installed_signals.append(signum)
+        except (NotImplementedError, RuntimeError):
+            pass
+
+    try:
+        await server_task
+    finally:
+        for signum in installed_signals:
+            loop.remove_signal_handler(signum)
+        if not server_task.done():
+            server_task.cancel()
+            with suppress(asyncio.CancelledError):
+                await server_task
+
+
 if __name__ == "__main__":
     app()

{modsim-0.5.2 → modsim-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "modsim"
-version = "v0.5.2"
+version = "v1.0.0"
 description = "A Simple Modbus TCP Device Simulator used for modpoll tool"
 authors = ["Ying Shaodong <helloysd@gmail.com>"]
 repository = "https://github.com/gavinying/modsim"
@@ -40,6 +40,7 @@ show_error_codes = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+markers = ["integration: local protocol integration test"]
 
 [tool.poetry.scripts]
 modsim = "modsim.main:app"

modsim-0.5.2/modsim/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.5.2"