Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -18,14 +18,6 @@ on:
   workflow_dispatch:
 
 jobs:
-  faildraft:
-    name: fail draft
-    if: github.event.pull_request.draft == true
-    runs-on: ubuntu-latest
-    steps:
-      - name: fail draft
-        run: |
-          exit 1
 
   testing:
     name: ${{ matrix.os }} - ${{ matrix.python }}
@@ -36,11 +28,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ['3.10', '3.11', '3.12', "3.13.0"]
+        python: ['3.10', '3.11', '3.12', '3.13', '3.14']
         include:
           - python: '3.10'
             run_lint: true
-          - python: '3.13.0'
+          - python: '3.13'
             run_doc: true
             run_lint: true
           - os: macos-latest
@@ -54,75 +46,54 @@ jobs:
       - name: Checkout repo from github
         uses: actions/checkout@v4.2.2
 
-      - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v5.4.0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
           python-version: ${{ matrix.python }}
+          allow-prereleases: true
+          enable-cache: true
 
-      - name: Set venv path (NON Windows)
-        if: matrix.os != 'windows-latest'
-        run: |
-          echo "VIRTUAL_ENV=${{ github.workspace }}/venv" >> $GITHUB_ENV
-          echo ${{ github.workspace }}/venv/bin >> $GITHUB_PATH
-
-      - name: Set venv path (Windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          echo "VIRTUAL_ENV=${{ github.workspace }}\\venv" >> $Env:GITHUB_ENV
-          echo "${{ github.workspace }}\\venv\\Scripts" >> $Env:GITHUB_PATH
-
-      - name: Restore base Python virtual environment
-        id: cache-venv
-        uses: actions/cache@v4.2.0
-        with:
-          path: ${{ env.VIRTUAL_ENV }}
-          key: >-
-            ${{ runner.os }}-${{ matrix.python }}-venv-${{
-              hashFiles('pyproject.toml') }}
-
-      - name: Create venv (NEW CACHE)
-        if: steps.cache-venv.outputs.cache-hit != 'true'
+      - name: Create virtualenv and sync dependencies
         run: |
-          python -m venv ${{ env.VIRTUAL_ENV }}
-          python -m pip install --upgrade pip
-          pip install -e ".[all]"
+          uv sync --all-extras
 
       - name: codespell
         if: matrix.run_doc == true
         run: |
-          codespell
+          uv run codespell
 
-      - name: dcoumentation
+      - name: documentation
         if: matrix.run_doc == true
         run: |
-          cd doc; ./build_html
+          source .venv/bin/activate
+          cd doc
+          ./build_html
+        # this won't work on Windows, but we run_doc == False on Windows
 
       - name: pylint
         if: matrix.run_lint == true
         run: |
-          pylint --recursive=y examples pymodbus test
+          uv run pylint --recursive=y examples pymodbus test
 
       - name: mypy
         if: matrix.run_lint == true
         run: |
-          mypy pymodbus examples
+          uv run mypy pymodbus examples
 
       - name: ruff
         if: matrix.run_lint == true
         run: |
-          ruff check .
+          uv run ruff check .
 
       - name: pytest
-        if: ${{ (matrix.os != 'ubuntu-latest') || (matrix.python != '3.13') }}
+        if: ${{ (matrix.os != 'ubuntu-latest') || (matrix.python != '3.14.0') }}
         run: |
-          env
-          pytest
+          uv run pytest
 
       - name: pytest coverage
-        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python == '3.13')  }}
+        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python == '3.14.0') }}
         run: |
-          env
-          pytest --cov
+          uv run pytest --cov
 
   analyze:
     name: Analyze Python
@@ -131,13 +102,9 @@ jobs:
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4.2.2
-
       - uses: github/codeql-action/init@v3
         with:
           languages: python
-
-      - uses: github/codeql-action/autobuild@v3
-
       - uses: github/codeql-action/analyze@v3
 
   ci_complete:

.gitignore

@@ -20,3 +20,4 @@ build/html
 venv
 downloaded_files/
 pymodbus.log
+*.lock

AUTHORS.rst

@@ -66,6 +66,7 @@ Thanks to
 - Jonathan Reichelt Gjertsen
 - JorisW
 - julian
+- Julian Lunz
 - Justin Standring
 - Kenny Johansson
 - Kürşat Aktaş

CHANGELOG.rst

@@ -7,6 +7,27 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.11.1
+--------------
+* Auto debug in case of an error. (#2738)
+* Remove duplicate log lines. (#2736)
+* Remove unused callback in ServerRequestHandler (#2737)
+* test on Python 3.14 (#2735)
+* Validate address in all datastores. (#2733)
+* Use asyncio.Event to deterministically ensure simulator start (#2734)
+* Ignore lockfile (#2730)
+* Link api_changes/changelog to README.
+* Add note about semver.org.
+* Datastore, add typing to set/get. (#2729)
+* Move exception codes to constants. (#2728)
+* Move ExceptionResponse to proper file. (#2727)
+* make base frame signature match subclasses (#2726)
+* Switch from venv+pip to uv (#2723)
+* Cleanup CI configuration (#2724)
+* Simplify code flow for broadcast requests (#2720)
+* Fix serial_forwarder.py from examples/contrib (#2715)
+* Remove discord. (#2714)
+
 Version 3.11.0
 --------------
  * Correct bit handling (each byte is LSB->MSB). (#2707)

README.rst

@@ -27,9 +27,15 @@ Upgrade examples:
 - 3.8.0 -> 3.9.0: Smaller changes to the pymodbus calls might be needed
 - 2.5.4 -> 3.0.0: Major changes in the application might be needed
 
-It is always recommended to read the CHANGELOG as well as the API_changes files.
+**REMARK**: As can be seen from the above Pymodbus do NOT follow the semver.org standard.
 
-Current release is `3.11.0 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.0>`_.
+It is always recommended to read the
+`CHANGELOG <https://github.com/pymodbus-dev/pymodbus/blob/dev/CHANGELOG.rst>`_
+as well as the
+`API_changes <https://github.com/pymodbus-dev/pymodbus/blob/dev/API_changes.rst>`_
+files.
+
+Current release is `3.11.1 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.1>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 

doc/source/_static/examples.tgz

@@ -9,6 +9,7 @@
 import signal
 
 from pymodbus.client import ModbusSerialClient
+from pymodbus.framer import FramerType
 from pymodbus.datastore import ModbusServerContext
 from pymodbus.datastore.remote import RemoteDeviceContext
 from pymodbus.server import ModbusTcpServer
@@ -33,13 +34,13 @@ def __init__(self):
     async def run(self):
         """Run the server"""
         port, baudrate, server_port, server_ip, device_ids = get_commandline()
-        client = ModbusSerialClient(method="rtu", port=port, baudrate=baudrate)
+        client = ModbusSerialClient(framer=FramerType.RTU, port=port, baudrate=baudrate)
         message = f"RTU bus on {port} - baudrate {baudrate}"
         _logger.info(message)
         store = {}
         for i in device_ids:
             store[i] = RemoteDeviceContext(client, device_id=i)
-        context = ModbusServerContext(device_ids=store, single=False)
+        context = ModbusServerContext(devices=store, single=False)
         self.server = ModbusTcpServer(
             context,
             address=(server_ip, server_port),
@@ -74,7 +75,7 @@ def get_commandline():
     parser.add_argument("--server_port", help="server port", default=5020, type=int)
     parser.add_argument("--server_ip", help="server IP", default="127.0.0.1", type=str)
     parser.add_argument(
-        "--sdevice_ids", help="list of device_ids to forward", type=int, nargs="+"
+        "--device_ids", help="list of device_ids to forward", type=int, nargs="+"
     )
 
     args = parser.parse_args()

doc/source/_static/examples.zip

@@ -90,7 +90,7 @@ def callback_data(self, data: bytes, addr: tuple | None = None) -> int:
         return len(data)
 
     def callback_connected(self) -> None:
-        """Call when connection is succcesfull."""
+        """Call when connection is successful."""
 
     def callback_disconnected(self, exc: Exception | None) -> None:
         """Call when connection is lost."""

examples/contrib/serial_forwarder.py

@@ -20,5 +20,5 @@
 from pymodbus.pdu.device import ModbusDeviceIdentification
 
 
-__version__ = "3.11.0"
+__version__ = "3.11.1"
 __version_full__ = f"[pymodbus, version {__version__}]"