Merge branch 'dev'

Author: janiversen

.github/ISSUE_TEMPLATE.md

@@ -30,5 +30,5 @@ Before opening a new issue, make sure you do the following:
 # please use the following to format logs when posting them here
 import pymodbus
 
-pymodbus.pymodbus_apply_logging_config()
+pymodbus.pymodbus_apply_logging_config("DEBUG")
 ```

.github/workflows/ci.yml

@@ -1,10 +1,10 @@
 name: CI
-
 on:
   push:
     branches:
       - dev
       - master
+      - dev_*
     tags:
       - v*
   pull_request:
@@ -15,83 +15,117 @@ on:
     - cron: '10 2 * * 0'
   workflow_dispatch:
 
-
 jobs:
-  linters:
-    name: Linters - ${{ matrix.os.on }} - ${{ matrix.python.version }}
-    runs-on: ${{ matrix.os.on }}
-    timeout-minutes: 10
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - on: ubuntu-latest
-          # - on: macos-latest
-          # - on: windows-latest
-        python:
-          - version: '3.8'
-          - version: '3.9'
-          - version: '3.10'
-          - version: '3.11'
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python.version }}
-          cache: 'pip'
-      - run: pip install -e ".[all]"
-      - run: codespell
-      - run: pylint --recursive=y examples pymodbus test
-      - run: pre-commit run --all-files
-      - run: cd doc; ./build_html
-      - run: mypy pymodbus
-
-  integreation_test:
-    name: pytest - ${{ matrix.os.on }} - ${{ matrix.python.version }}
-    runs-on: ${{ matrix.os.on }}
+  testing:
+    name: ${{ matrix.os }} - ${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
     timeout-minutes: 20
     strategy:
       fail-fast: false
       matrix:
-        os:
-          - on: ubuntu-latest
-          - on: macos-latest
-          - on: windows-latest
-        python:
-          - version: '3.8'
-          - version: '3.9'
-          - version: '3.10'
-          - version: '3.11'
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        include:
+          - python: '3.8'
+            run_lint: true
+          - python: '3.12'
+            run_doc: true
+            run_lint: true
+          - os: macos-latest
+            run_doc: false
+            run_lint: false
+          - os: windows-latest
+            run_doc: false
+            run_lint: false
+
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - name: Checkout repo from github
+        uses: actions/[email protected]
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/[email protected]
         with:
-          python-version: ${{ matrix.python.version }}
-          cache: 'pip'
-      - run: pip install -e ".[all]"
+          python-version: ${{ matrix.python }}
+
+      - 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
 
-      - run: pytest -n0  -v --full-trace --timeout=1200
+      - 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/[email protected]
+        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'
+        run: |
+          python -m venv ${{ env.VIRTUAL_ENV }}
+          python -m pip install --upgrade pip
+          pip install -e ".[all]"
+
+      - name: codespell
+        if: matrix.run_doc == true
+        run: |
+          codespell
+
+      - name: dcoumentation
+        if: matrix.run_doc == true
+        run: |
+          cd doc; ./build_html
+
+      - name: pylint
+        if: matrix.run_lint == true
+        run: |
+          pylint --recursive=y examples pymodbus test
+
+      - name: mypy
+        if: matrix.run_lint == true
+        run: |
+          mypy pymodbus
+
+      - name: ruff
+        if: matrix.run_lint == true
+        run: |
+          ruff .
+
+      - name: pytest
+        run: |
+          env
+          pytest -v --full-trace --timeout=1200
 
   analyze:
     name: Analyze Python
     runs-on: ubuntu-22.04
-
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v3
+
       - uses: github/codeql-action/init@v2
         with:
           languages: python
+
       - uses: github/codeql-action/autobuild@v2
+
       - uses: github/codeql-action/analyze@v2
 
   ci_complete:
     name: ci_complete
     runs-on: ubuntu-latest
     needs:
-      - linters
       - analyze
-      - integreation_test
+      - testing
     timeout-minutes: 1
     steps:
-      - name: Dummy
-        run: ls
+      - run: echo 'finish job'

.github/workflows/clean_workflow_runs.yml

@@ -14,7 +14,7 @@ jobs:
         with:
           token: ${{ github.token }}
           repository: ${{ github.repository }}
-          retain_days: 7
+          retain_days: 3
           keep_minimum_runs: 0
 
 

.github/workflows/stale_lock.yml

@@ -16,7 +16,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/stale@v3
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'

.gitignore

@@ -16,3 +16,4 @@ build/
 /dist/
 /pymodbus.egg-info/
 venv
+downloaded_files/

.pre-commit-config.yaml

@@ -2,8 +2,10 @@ API changes
 ===========
 Versions (X.Y.Z) where Z > 0 e.g. 3.0.1 do NOT have API changes!
 
+
 API changes 3.6.0 (future)
 --------------------------
+- framer= is an enum: pymodbus.Framer, but still accept a framer class
 
 
 API changes 3.5.0

API_changes.rst

@@ -1,9 +1,10 @@
 Authors
 =======
-All these version were not possible without volunteers!
+All these versions would not be possible without volunteers!
 
 This is a complete list for each major version.
 
+A big "thank you" to everybody who helped out.
 
 Pymodbus version 3 family
 -------------------------
@@ -14,30 +15,39 @@ Thanks to
 - Alex Ruddick
 - Alexandre CUER
 - Alois Hockenschlohe
+- Arjan
 - banana-sun
 - Blaise Thompson
 - cgernert
 - corollaries
+- Chandler Riehm
 - Chris Hung
 - Christian Krause
 - dhoomakethu
+- DominicDataP
 - Dries
 - duc996
+- Farzad Panahi
 - Fredo70
 - Gao Fang
 - Ghostkeeper
 - Hangyu Fan
 - Hayden Roche
 - Iktek
 - Jakob Ruhe
+- Jakob Schlyter
 - James Braza
 - jan iversen
+- Jerome Velociter
 - Joe Burmeister
 - Kenny Johansson
 - Matthias Straka
 - Logan Gunthorpe
 - Marko Luther
+- Logan Gunthorpe
+- Marko Luther
 - Matthias Straka
+- Mickaël Schoentgen
 - Pavel Kostromitinov
 - peufeu2
 - Philip Couling

AUTHORS.rst

@@ -1,12 +1,80 @@
 Changelog
 =========
-All these version would not possible without a lot of work from volunteers!
+All these version would not be possible without a lot of work from volunteers!
 
-We, the maintainers, are greatful for all the pull requests small or big, that
+We, the maintainers, are greatful for each pull requests small or big, that
 helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.6.0
+-------------
+* doc: Fix a code mismatch in client.rst
+* Update README.
+* truncated duration to milliseconds
+* Update examples for current dev.
+* Ignore all remaining implicit optional (#1888)
+* docstring
+* Remove unnecessary abort() call
+* Enable RUF013 (implicit optional) (#1882)
+* Support aiohttp 3.9.0b1 (#1886)
+* Actually perform aiohttp runner teardown
+* Pin to working aiohttp (#1884)
+* Docstring typo cleanup (#1879)
+* Clean client API imports. (#1819)
+* Update issue template.
+* Eliminiate implicit optional in reconnect_delay* (#1874)
+* Split client base in sync/async version (#1878)
+* Rework host/port and listener setup (#1866)
+* use baudrate directly (#1872)
+* Eliminate more implicit optional (#1871)
+* Fix serial server args order (#1870)
+* Relax test task/thread checker. (#1867)
+* Make doc link references version dependent. (#1864)
+* Remove pre-commit (#1860)
+* Ruff reduce ignores. (#1862)
+* Bump ruff to 0.1.3 and remove ruff.toml (#1861)
+* More elegant noop. (#1859)
+* Cache (#1829)
+* Eliminate more implicit optional (#1858)
+* Ignore files downloaded by pytest (#1857)
+* Avoid malicious user path input (#1855)
+* Add more return types to transport (#1852)
+* Do not attempt to close an already-closed serial connection (#1853)
+* Fix stopbits docstring typo (#1850)
+* Convert type hints to PEP585 (#1846)
+* Eliminate even more implicit optional (#1845)
+* Eliminate more implicit optionals in client (#1844)
+* Eliminate implicit optional in transport_serial (#1843)
+* Make client type annotations compatible with async client usage (#1842)
+* Merge pull request #1838 from pymodbus-dev/ruff
+* Eliminate implicit optional in simulator (#1841)
+* eliminate implicit optional for callback_disconnected (#1840)
+* pre-commit run --all-files
+* Update exclude paths
+* Replace black with ruff
+* Use other dependency groups for 'all' (#1834)
+* Cleanup author/maintainer fields (#1833)
+* Consistent messages if imports fail (#1831)
+* Client/Server framer as enum. (#1822)
+* Solve relative path in examples. (#1828)
+* Eliminate implicit optional for CommParams types (#1825)
+* Add 3.12 classifier (#1826)
+* Bump actions/stale to 8.0.0 (#1824)
+* Cleanup paths included in mypy/pylint (#1823)
+* Client documentation amended and updated. (#1820)
+* Import aiohttp in way pleasing mypy. (#1818)
+* Update doc, remove md files. (#1814)
+* Bump dependencies. (#1816)
+* Solve pylint / pytest.
+* fix pylint.
+* Examples are without parent module.
+* Wrong zip of examples.
+* Serial delay (#1810)
+* Add python 3.12. (#1800)
+* Release errors (pyproject.toml changes). (#1811)
+
+
 Version 3.5.4
 -------------
 * Release errors (pyproject.toml changes). (#1811)