Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
         run: |
           python -m venv ${{ env.VIRTUAL_ENV }}
           python -m pip install --upgrade pip
-          pip install -e ".[all]"
+          pip install ".[all]"
 
       - name: codespell
         if: matrix.run_doc == true
@@ -101,9 +101,16 @@ jobs:
           ruff .
 
       - name: pytest
+        if: ${{ (matrix.os != 'ubuntu-latest') || (matrix.python != '3.12') }}
         run: |
           env
-          pytest -v --cov --full-trace --timeout=1200
+          pytest
+
+      - name: pytest coverage
+        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python == '3.12')  }}
+        run: |
+          env
+          pytest --cov
 
   analyze:
     name: Analyze Python

.gitignore

@@ -13,8 +13,8 @@ __pycache__/
 .vscode
 .vscode/
 build/
+prof/
 /dist/
 /pymodbus.egg-info/
 venv
 downloaded_files/
-htmlcov/

AUTHORS.rst

@@ -26,6 +26,7 @@ Thanks to
 - Chris Hung
 - Christian Krause
 - dhoomakethu
+- doelki
 - DominicDataP
 - Dries
 - duc996
@@ -43,9 +44,11 @@ Thanks to
 - jan iversen
 - Jerome Velociter
 - Joe Burmeister
+- Jonathan Reichelt Gjertsen
 - julian
 - Kenny Johansson
 - Matthias Straka
+- laund
 - Logan Gunthorpe
 - Marko Luther
 - Logan Gunthorpe

CHANGELOG.rst

@@ -7,6 +7,66 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.6.5
+-------------
+* Update framers to ease message integration (only decode/encode) (#2064)
+* Add negtive acknowledge to modbus exceptions (#2065)
+* add Message Socket/TLS and amend tests. (#2061)
+* Improve factory types (#2060)
+* ASCII. (#2054)
+* Improve datastore documentation (#2056)
+* Improve types for messages (#2058)
+* Improve payload types (#2057)
+* Reorganize datastore inheritance (#2055)
+* Added new message (framer) raw + 100%coverage. (#2053)
+* message classes, first step (#1932)
+* Use AbstractMethod in transport. (#2051)
+* A datastore for each slave. (#2050)
+* Only run coverage in ubuntu / python 3.12 (#2049)
+* Replace lambda with functools.partial in transport. (#2047)
+* Move self.loop in transport to init() (#2046)
+* Fix decoder bug (#2045)
+* Add support for server testing in package_test_tool. (#2044)
+* DictTransactionManager -> ModbusTransactionManager (#2042)
+* eliminate redundant server_close() (#2041)
+* Remove reactive server (REPL server). (#2038)
+* Improve types for client (#2032)
+* Improve HTTP server type hints (#2035)
+* eliminate asyncio.sleep() and replace time.sleep() with a timeout (#2034)
+* Use "new" inter_byte_timeout and is_open for pyserial (#2031)
+* Add more type hints to datastore (#2028)
+* Add more framer tests, solve a couple of framer problems. (#2024)
+* Rework slow tests (use NULL_MODEM) (#1995)
+* Allow slave=0 in serial communication. (#2023)
+* Client package test tool. (#2022)
+* Add REPL documentation back with links to REPL repo (#2017)
+* Move repl to a seperate repo (#2009)
+* solve more mypy issues with client (#2013)
+* solve more mypy issues with datastore (#2010)
+* Remove useless. (#2011)
+* streamline transport tests. (#2004)
+* Improve types for REPL (#2007)
+* Specify more types in base framer (#2005)
+* Move htmlcov -> build/cov (#2003)
+* Avoid pylint complain about lambda. (#1999)
+* Improve client types (#1997)
+* Fix setblocking call (#1996)
+* Actívate warnings in pytest. (#1994)
+* Add profile option to pytest. (#1991)
+* Simplify message tests (#1990)
+* Upgrade pylint and ruff (#1989)
+* Add first architecture document. (#1988)
+* Update CONTRIBUTING.rst.
+* Return None for broadcast. (#1987)
+* Make ModbusClientMixin Generic to fix type issues for sync and async (#1980)
+* remove strange None default (#1984)
+* Fix incorrect bytearray type hint in diagnostics query (#1983)
+* Fix URL to CHANGELOG (#1979)
+* move server_hostname to be local in tls client. (#1978)
+* Parameter "strict" is and was only used for serial server/client. (#1975)
+* Removed unused parameter close_comm_on_error. (#1974)
+
+
 Version 3.6.4
 -------------
 * Update datastore_simulator example with client (#1967)

CONTRIBUTING.rst

@@ -1,3 +1,5 @@
 Just fork the repo and raise your PR against `dev` branch.
 
 We always have more work than time, so feel free to open a discussion / issue on a theme you want to solve.
+
+For instructions please refer to README.rst, which details how to install a development environment etc.

MAKE_RELEASE.rst

@@ -14,7 +14,7 @@ Prepare/make release on dev.
    * Control / Update API_changes.rst
    * Update CHANGELOG.rst
       * Add commits from last release, but selectively !
-        git log --oneline v3.6.1..HEAD > commit.log
+        git log --oneline v3.6.5..HEAD > commit.log
         git log --pretty="%an" v3.6.1..HEAD | sort -uf > authors.log
         update AUTHORS
         cd doc; ./build_html
@@ -51,3 +51,10 @@ Prepare release on dev for new commits.
 ------------------------------------------------------------
 * Make pull request "prepare dev", with the following:
    * Update pymodbus/__init__.py with version number (__version__ X.Y.Zpre)
+
+
+------------------------------------------------------------
+Architecture documentation.
+------------------------------------------------------------
+* install graphviz
+* pyreverse -k -o jpg pymodbus

README.rst

@@ -11,11 +11,11 @@ PyModbus - A Python Modbus Stack
 
 Pymodbus is a full Modbus protocol implementation offering client/server with synchronous/asynchronous API a well as simulators.
 
-Current release is `3.6.4 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.6.4>`_.
+Current release is `3.6.5 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.6.5>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
-All changes are described in `release notes <https://pymodbus.readthedocs.io/en/latest/source/channgelog.html>`_
+All changes are described in `release notes <https://pymodbus.readthedocs.io/en/latest/source/changelog.html>`_
 and all API changes are `documented <https://pymodbus.readthedocs.io/en/latest/source/api_changes.html>`_
 
 A big thanks to all the `volunteers <https://pymodbus.readthedocs.io/en/latest/source/authors.html>`_ that helps make pymodbus a great project.
@@ -80,7 +80,7 @@ REPL Features
 - simulation of broken requests/responses
 - simulation of error responses (hard to provoke in real devices)
 
-`REPL documentation <https://https://pymodbus.readthedocs.io/en/dev/source/REPL.html>`_
+`REPL documentation <https://github.com/pymodbus-dev/repl>`_
 
 
 Simulator Features
@@ -274,7 +274,7 @@ There are 2 bigger projects ongoing:
    * Add features to and simulator, and enhance the web design
 
 
-Development Instructions
+Development instructions
 ------------------------
 The current code base is compatible with python >= 3.8.
 
@@ -295,15 +295,18 @@ Make a pull request::
 
    on github open a pull request, check that CI turns green and then wait for review comments.
 
-
 Test your changes::
 
    cd test
    pytest
 
+you can also do extended testing::
+
+   pytest --cov         <-- Coverage html report in build/html
+   pytest --profile     <-- Call profile report in prof
 
-Architecture
-^^^^^^^^^^^^
+Internals
+^^^^^^^^^
 
 There are no documentation of the architecture (help is welcome), but most classes and
 methods are documented:

build/README

@@ -0,0 +1,5 @@
+This is the place, where temp files are kept
+- html (documention)
+- cov (coverage)
+- prof (profiling)
+

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 --numprocesses auto
+pytest --cov --numprocesses auto
 echo "Ready to push"

doc/index.rst

@@ -11,7 +11,7 @@ Please select a topic in the left hand column.
    source/readme
    source/client
    source/server
-   source/REPL
+   source/repl
    source/simulator
    source/examples
    source/authors