Not yet reviewed

.github/workflows/pyleco_CI.yml

@@ -13,22 +13,24 @@ jobs:
       run:
         shell: bash -l {0}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install pyleco requirements
         uses: mamba-org/setup-micromamba@v1
         with:
           environment-file: environment.yml
+          create-args: python=3.10
           cache-environment-key: pylatest-ubuntu-latest-mamba-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }}
           cache-downloads: false
       - name: Python and Mamba version
         run: |
           python --version
           micromamba info
       - name: Lint with ruff
-        uses: chartboost/ruff-action@v1
+        uses: astral-sh/ruff-action@v1
         with:
+          version: 0.4.10  # ruff-action@v1 is broken in regard to ruff 0.5.0
           args: --extend-select=E9,F63,F7,F82 --show-source
       - uses: ammaraskar/sphinx-problem-matcher@master
       - name: Generate docs
@@ -43,14 +45,15 @@ jobs:
         run: |
           echo "::add-matcher::.github/sphinx.json"
           make doctest SPHINXOPTS="-W --keep-going"
+
   type_checking:
     name: Static Type Checking
     runs-on: "ubuntu-latest"
     defaults:
       run:
         shell: bash -l {0}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install pyleco requirements
@@ -65,14 +68,15 @@ jobs:
         run: pip install mypy
       - name: Run mypy
         run: mypy .
+
   test_coverage:
-    name: Code Coverage
+    name: Code Coverage on codecov
     runs-on: "ubuntu-latest"
     defaults:
       run:
         shell: bash -l {0}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install pyleco requirements
@@ -87,49 +91,17 @@ jobs:
         # If the pytest problem matcher stops working because of bad paths, do an editable install
         run: pip install -e .[dev]  # editable for covtest
       - name: Test for Coverage
-        run: pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=pyleco | tee pytest-coverage.txt
-      - name: Pytest Coverage Comment
-        id: coverageComment
-        uses: MishaKav/pytest-coverage-comment@main
+        run: pytest --cov=pyleco --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
         with:
-          pytest-coverage-path: ./pytest-coverage.txt
-          title: Coverage Report
-          badge-title: PyLECO Coverage
-          hide-badge: false
-          hide-report: false
-          create-new-comment: false
-          hide-comment: false
-          report-only-changed-files: false
-          remove-link-from-badge: false
-          unique-id-for-comment: python3
-          junitxml-path: ./pytest.xml
-          junitxml-title: Coverage Summary
-      - name: Check output coverage
-        run: |
-          echo "Coverage Percantage - ${{ steps.coverageComment.outputs.coverage }}"
-          echo "Coverage Color - ${{ steps.coverageComment.outputs.color }}"
-          echo "Coverage Html - ${{ steps.coverageComment.outputs.coverageHtml }}"
-
-          echo "Coverage Warnings - ${{ steps.coverageComment.outputs.warnings }}"
-
-          echo "Coverage Errors - ${{ steps.coverageComment.outputs.errors }}"
-          echo "Coverage Failures - ${{ steps.coverageComment.outputs.failures }}"
-          echo "Coverage Skipped - ${{ steps.coverageComment.outputs.skipped }}"
-          echo "Coverage Tests - ${{ steps.coverageComment.outputs.tests }}"
-          echo "Coverage Time - ${{ steps.coverageComment.outputs.time }}"
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          files: ./coverage.xml,!./cache
+          flags: unittests
+          name: codecov-umbrella
+          verbose: true
 
-          echo "Not Success Test Info - ${{ steps.coverageComment.outputs.notSuccessTestInfo }}"
-
-      - name: Create the Badge
-        uses: schneegans/[email protected]
-        with:
-          auth: ${{ secrets.pyleco_coverage_gist_secret }}
-          gistID: 7a8a7b874b62ed803eb56ca04830bede
-          filename: pyleco-coverage.json
-          label: Coverage Report
-          message: ${{ steps.coverageComment.outputs.coverage }}
-          color: ${{ steps.coverageComment.outputs.color }}
-          namedLogo: python
   test:
     name: Python ${{ matrix.python-version }}, ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -140,9 +112,9 @@ jobs:
       fail-fast: true
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install pyleco requirements
@@ -159,13 +131,18 @@ jobs:
         run: pip install .[dev]
       - name: Pyleco version
         run: python -c "import pyleco;print(pyleco.__version__)"
-      - name: Run pytest with xvfb
+      - name: Run pytest under Linux with xvfb
         if: runner.os == 'Linux'
         run: |
           echo "::add-matcher::.github/pytest.json"
           xvfb-run -a pytest
-      - name: Run pytest
-        if: runner.os != 'Linux'
+      - name: Run pytest under Windows
+        if: runner.os == 'Windows'
         run: |
           echo "::add-matcher::.github/pytest.json"
           pytest
+      - name: Run pytest under Mac without acceptance tests
+        if: runner.os == 'macOS'
+        run: |
+          echo "::add-matcher::.github/pytest.json"
+          pytest --ignore=tests/acceptance_tests

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Build and Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/[email protected]

.gitignore

@@ -114,6 +114,9 @@ venv.bak/
 .spyderproject
 .spyproject
 
+# VS code project settings
+.vscode/*
+
 # Rope project settings
 .ropeproject
 

CHANGELOG.md

@@ -0,0 +1,180 @@
+# CHANGELOG
+
+## [Unreleased]
+
+### Changed
+
+* Openrpc is optional (available via `openrpc` option) for Python 3.13 onwards.
+
+### Added
+
+* Support for Python 3.13
+
+
+## [0.4.0] 2024-06-19
+
+_Binary data handling facilitated with utility functions._
+
+### Changed
+* Proxy_server stops if binding failed ([#86](https://github.com/pymeasure/pyleco/pull/86))
+
+### Added
+
+* Add convenience functions for using additional frames for binary payload ([#82](https://github.com/pymeasure/pyleco/pull/82))
+* Improve getting_started and readme documentation ([#80](https://github.com/pymeasure/pyleco/pull/80))
+* Add RELEASE.md ([#79](https://github.com/pymeasure/pyleco/pull/79))
+* Add locking actor ([#84](https://github.com/pymeasure/pyleco/pull/84))
+
+### Fixed
+
+* Fix listener documentation ([#88](https://github.com/pymeasure/pyleco/pull/88))
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.3.2...v0.4.0
+
+
+## [0.3.2] 2024-05-07
+
+### Fixed
+
+* Fix dependency on outdated UUIDv7 generating library to `uuid6` package ([#75](https://github.com/pymeasure/pyleco/pull/75))
+* Fix codecov CI ([#73](https://github.com/pymeasure/pyleco/pull/73))
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.3.1...v0.3.2
+
+
+## [0.3.1] 2024-04-12
+
+### Fixed
+
+* Fix `Coordinator` to not use period in hostname as namespace ([#69](https://github.com/pymeasure/pyleco/pull/69))
+* Fix `DataLogger` timer ([#70](https://github.com/pymeasure/pyleco/pull/70))
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.3.0...v0.3.1
+
+
+## [0.3.0] 2024-03-13
+
+_Use self defined objects instead of jsonrpc2-objects and jsonrpc2-pyclient._
+
+### Changed
+
+- Rename `cls` parameter to `device_class` in `Actor` and `TransparentDirector`.
+- Substitute `jsonrpc2-objects` and `jsonrpc2-pyclient` by self written objects ([#65](https://github.com/pymeasure/pyleco/pull/65))
+- Move error definitions from `pyleco.errors` to `pyleco.json_utils.errors` ([#63](https://github.com/pymeasure/pyleco/pull/63))
+- Move `pyleco.errors.CommunicationError` to `pyleco.json_utils.errors` ([#63](https://github.com/pymeasure/pyleco/pull/63))
+- Deprecate `generate_error_with_data` in favor of `DataError.from_error` class method ([#63](https://github.com/pymeasure/pyleco/pull/63))
+- Python requirement lowered to Python 3.8 ([#64](https://github.com/pymeasure/pyleco/pull/64))
+- Rework the message buffer in the base communicator and harmonize with pipe handler's buffer ([#66](https://github.com/pymeasure/pyleco/pull/66))
+- Bump CI actions versions for node.js 20 ([#62](https://github.com/pymeasure/pyleco/pull/62))
+
+### Added
+
+- Add __future__.annotations to all files, which need it for annotations for Python 3.7/3.8.
+- Add self written `RPCServer` as alternative to openrpc package.
+
+### Deprecated
+
+- Deprecate `pyleco.errors` in favor of `json_utils.errors` and `json_utils.json_objects`.
+- Deprecate to use `CommunicatorPipe.buffer`, use `message_buffer` instead.
+
+### Fixed
+
+- Fix Listener's communcator did not know, when listening stopped ([#67](https://github.com/pymeasure/pyleco/pull/67))
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.2.2...v0.3.0
+
+
+## [0.2.2] - 2024-02-14
+
+### Fixed
+
+- Fix Communicator to distinguish correctly different json rpc messages ([#57](https://github.com/pymeasure/pyleco/issues/57))
+- Fix MessageHandler not distinguish correctly batch requests ([#56](https://github.com/pymeasure/pyleco/issues/56))
+- Bump setup-python action version to v5
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.2.1...v.0.2.2
+
+
+## [0.2.1] - 2024-02-13
+
+### Fixed
+
+- Fix BaseCommunciator to hand over message, if it is an error message (#55)
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.2.0...v.0.2.1
+
+
+## [0.2.0] - 2024-02-13
+
+_Several deprecated parts are removed and inner workings are changed._
+
+### Changed
+
+- **Breaking:** change `MessageHandler.handle_commands` to `handle_message` ([#44](https://github.com/pymeasure/pyleco/pull/44))
+- **Breaking:** change PipeHandler inner workings of handling messages ([#44](https://github.com/pymeasure/pyleco/pull/44))
+- Add `BaseCommunicator` as a base class for Communicator and MessageHandler ([#48](https://github.com/pymeasure/pyleco/pull/48))
+- Refactor the Coordinator `handle_commands` ([#50](https://github.com/pymeasure/pyleco/pull/50))
+
+### Added
+
+- Add the `Coordinator`, the `proxy_server`, and the `starter` as scripts to the command line ([#53](https://github.com/pymeasure/pyleco/pull/53))
+
+### Removed
+
+- **Breaking:** remove `Coordinator.ask_raw` (#48)
+- **Breaking:** remove legacy subscription messages from extended message handler (#48)
+
+### Fixed
+
+- Fix DataLogger to start a timer, even if not specified explicitly ([#51](https://github.com/pymeasure/pyleco/pull/51))
+
+**Full Changelog**: https://github.com/pymeasure/pyleco/compare/v0.1.0...v.0.2.0
+
+
+## [0.1.0] - 2024-02-01
+
+### Changed
+
+- Change message and protocols according to LECO change ([`9d74731da`](https://github.com/pymeasure/pyleco/commit/9d74731da06d147b1773f1f411bd943a36b4a83d)) (@BenediktBurger)
+- Change Coordinator's `fname` to `full_name` ([`f3564c0`](https://github.com/pymeasure/pyleco/commit/f3564c08f04ed63bbab5b1100560e7b50239d83c)) (@BenediktBurger)
+
+### Added
+
+- Add compatibility with Python 3.9 ([`18abb87`](https://github.com/pymeasure/pyleco/commit/18abb87fea259f9e87411d88cca92a886bbd62b4)) (@BenediktBurger)
+- Add compatibility with Python 3.12 ([#22](https://github.com/pymeasure/pyleco/pull/22)) (@BenediktBurger)
+- Add more tests.
+- Add more functionality to internal protocol and test suite ([`42e107c5cb90`](https://github.com/pymeasure/pyleco/commit/42e107c5cb90704dbb99ef1c5a50be739f3acf85)) (@BenediktBurger)
+- Add Communicator functionality to the MessageHandler by distinguishing messages. (`9b0cc42`, `45913a5`, `97d902b`) (@BenediktBurger)
+- Add CI for testing ([#22](https://github.com/pymeasure/pyleco/pull/22), [#7](https://github.com/pymeasure/pyleco/pull/7), #34, #29, #26) (@BenediktBurger)
+- Add codecov code coverage calculation to CI ([#32](https://github.com/pymeasure/pyleco/pull/32)) (@BenediktBurger)
+- Add `GETTING_STARTED.md` with a tutorial ([`000245b`](https://github.com/pymeasure/pyleco/commit/000245b7d693336a36b3f8bb5b0d0fe13a1bd6a7)) ([#24](https://github.com/pymeasure/pyleco/pull/24)) (@BenediktBurger, @bklebel)
+
+### Removed
+
+- **Breaking:** remove deprecated `Publisher` (use `DataPublisher` instead); move `Republisher` and `ExtendedPublisher` to pyleco-extras package ([#33](https://github.com/pymeasure/pyleco/pull/33)) (@BenediktBurger)
+- **Breaking:** remove deprecated `call_method_rpc` and `call_method_rpc_async`
+
+### Fixed
+
+- Fix typos, also in variable / method names
+
+
+## [alpha-0.0.1] - 2023-12-12
+
+_Initial alpha version, complies with [LECO protocol alpha-0.0.1](https://github.com/pymeasure/leco-protocol/releases/tag/alpha-0.0.1)_
+
+### New Contributors
+
+@BenediktBurger, @bilderbuchi, @bklebel
+
+
+[unreleased]: https://github.com/pymeasure/pyleco/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/pymeasure/pyleco/releases/tag/v0.4.0
+[0.3.2]: https://github.com/pymeasure/pyleco/releases/tag/v0.3.2
+[0.3.1]: https://github.com/pymeasure/pyleco/releases/tag/v0.3.1
+[0.3.0]: https://github.com/pymeasure/pyleco/releases/tag/v0.3.0
+[0.2.2]: https://github.com/pymeasure/pyleco/releases/tag/v0.2.2
+[0.2.1]: https://github.com/pymeasure/pyleco/releases/tag/v0.2.1
+[0.2.0]: https://github.com/pymeasure/pyleco/releases/tag/v0.2.0
+[0.1.0]: https://github.com/pymeasure/pyleco/releases/tag/v0.1.0
+[alpha-0.0.1]: https://github.com/pymeasure/pyleco/releases/tag/alpha-0.0.1