chore: sync templated files to newest template version (#27)

feeph · web-flow · commit da05b129c76a · 2024-08-13T21:31:08.000Z
diff --git a/.copier/answers_pypackage.yaml b/.copier/answers_pypackage.yaml
@@ -5,7 +5,7 @@
 # files using the answers stored in this file.
 # (see https://copier.readthedocs.io/en/stable/updating/ for details)
 
-_commit: v0.2.1
+_commit: v0.3.2
 _src_path: https://github.com/feeph/pypackage-template
 author_email: 55798703+feeph@users.noreply.github.com
 author_name: Feeph Aifeimei
diff --git a/.github/workflows/coveralls.yaml b/.github/workflows/coveralls.yaml
@@ -0,0 +1,36 @@
+---
+#
+# https://coveralls.io/
+#
+
+name: update coverage report (coveralls)
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  coverage:
+    name: generate coverage report
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+      - name: configure Python (using PDM)
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version-file: pyproject.toml
+      - name: install dependencies
+        run: |
+          pdm install
+      - name: generate coverage report
+        run: |
+          pdm run coverage run --source=feeph.i2cmux -m pytest tests/
+          # coveralls recognizes the presence of .coverage but claims there
+          # is nothing to report; creating a report in lcov format fixes that
+          mkdir -p coverage
+          pdm run coverage-lcov --output_file_path=coverage/lcov.info
+      - name: coveralls action
+        uses: coverallsapp/github-action@v2
diff --git a/.github/workflows/validate-code.yaml b/.github/workflows/validate-code.yaml
@@ -7,7 +7,7 @@
 name: verify pull request
 
 on:
-  push:
+  pull_request:
 
 # our tox configuration leverages pyenv to test on multiple Python versions.
 # It is unclear if we can leverage actions/setup-python@v4 to do the same.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Coverage Status](https://coveralls.io/repos/github/feeph/libi2cmux-python/badge.svg)](https://coveralls.io/github/feeph/libi2cmux-python)
 [![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
 [![tox](https://img.shields.io/badge/tox-ab79d2)](https://tox.wiki/)
 
diff --git a/feeph/i2cmux/generic.py b/feeph/i2cmux/generic.py
@@ -91,7 +91,7 @@ def __exit__(self, exc_type, exc_value, exc_tb):
         LH.debug("[%d] I²C I/O burst completed after %d ms.", id(self), elapsed_ns / (1000 * 1000))
         # -----------------------------------------------------------------
         # send I²C command to reset the TCA9548A?
-        self._i2c_bus.writeto(self._tca_adr, b"\x00")
+        self._i2c_bus.writeto(self._tca_adr, bytearray([0x00]))
         # -----------------------------------------------------------------
         LH.debug("[%d] Releasing the lock on the I²C bus.", id(self))
         self._i2c_bus.unlock()
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -94,13 +94,14 @@ dev = [
     "types-PyYAML>=6.0.12.20240311",
 ]
 tools = [
-    "autopep8     ~= 2.2",
-    "copier       ~= 9.3",
-    "flake8       ~= 7.0",
-    "mypy         ~= 1.10",
-    "pylint       ~= 3.2",
-    "pytest-cov   ~= 5.0",
-    "pytest-sugar ~= 1.0",
+    "autopep8      ~= 2.2",
+    "copier        ~= 9.3",
+    "coverage-lcov ~= 0.3",
+    "flake8        ~= 7.0",
+    "mypy          ~= 1.10",
+    "pylint        ~= 3.2",
+    "pytest-cov    ~= 5.0",
+    "pytest-sugar  ~= 1.0",
 ]
 
 # during development: fetch all packages in our namespace from TestPyPI
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -10,6 +10,9 @@ astroid==3.2.4 \
 autopep8==2.3.1 \
     --hash=sha256:8d6c87eba648fdcfc83e29b788910b8643171c395d9c4bcf115ece035b9c9dda \
     --hash=sha256:a203fe0fcad7939987422140ab17a930f684763bf7335bdb6709991dd7ef6c2d
+click==8.1.7 \
+    --hash=sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28 \
+    --hash=sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de
 colorama==0.4.6 \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
@@ -49,6 +52,9 @@ coverage==7.6.1 \
     --hash=sha256:f5796e664fe802da4f57a168c85359a8fbf3eab5e55cd4e4569fbacecc903959 \
     --hash=sha256:fc5a77d0c516700ebad189b587de289a20a78324bc54baee03dd486f0855d234 \
     --hash=sha256:fd21f6ae3f08b41004dfb433fa895d858f3f5979e7762d052b12aef444e29afc
+coverage-lcov==0.3.0 \
+    --hash=sha256:0b352da0c72eacd555de2e10fa75ec165b8849ab6827218abc3ef6be2ec861f6 \
+    --hash=sha256:23ae34a535f1ed3fa4cdf9682f6c1fe1a40aa98c94aa05614512dbf2da82e749
 coverage[toml]==7.6.1 \
     --hash=sha256:07e2ca0ad381b91350c0ed49d52699b625aab2b44b65e1b4e02fa9df0e92ad2d \
     --hash=sha256:0c0420b573964c760df9e9e86d1a9a622d0d27f417e1a949a8a66dd7bcee7bc6 \
diff --git a/requirements.txt b/requirements.txt
@@ -28,9 +28,9 @@ adafruit-pureio==1.1.11 \
 binho-host-adapter==0.1.6 \
     --hash=sha256:1e6da7a84e208c13b5f489066f05774bff1d593d0f5bf1ca149c2b8e83eae856 \
     --hash=sha256:f71ca176c1e2fc1a5dce128beb286da217555c6c7c805f2ed282a6f3507ec277
-feeph-i2c==0.7.3 \
-    --hash=sha256:5a1937c4fcc4a7820e64b4195077d8a36e99430382b0e5dc291ed79ac053e53c \
-    --hash=sha256:f5cf7c7090861fe9cc6c385bb41e22f7fb97f5e6896c013ce4ab7115939246ef
+feeph-i2c==0.7.4 \
+    --hash=sha256:57e64801d6f6f1eeca8313da0299ad59bd04b3d1d007470f1c9912377aef6669 \
+    --hash=sha256:cc6963d746bed5500ee9d7f43f979a51c9f10bede3e273276df1dee8dcae8b34
 gpiod==2.2.1 \
     --hash=sha256:51ba8e0e92e9b986b1d7aa4071617b3948d4fc69bfdef68e7d8b94aec8e56e54 \
     --hash=sha256:5fd077dc8933eeb1be2da78980aa4c53812119a6773d73060c7b5a1e30886373 \
diff --git a/scripts/run_tests b/scripts/run_tests
@@ -23,6 +23,25 @@ if [[ -n $FILES ]] ; then
     pdm run mypy $FILES
 fi
 
+# Generate a coverage report in lcov format even if pytest fails due to
+# lacking coverage. The report can then be used by an IDE to indicate
+# coverage directly in your editor window. Special care must be taken
+# when working on code that isn't covered by unit tests.
+#
+# recommended extension for VS Code:
+# https://marketplace.visualstudio.com/items?itemName=markis.code-coverage
+generate_lcov() {
+    mkdir -p coverage
+    # generate coverage report in lcov and HTML format
+    pdm run coverage-lcov --output_file_path=coverage/lcov.info
+    pdm run coverage html
+}
+
+trap generate_lcov EXIT
+pdm run pytest --cov=feeph.i2cmux --cov-report=term-missing --no-header --quiet tests/
+
+tox
+
 echo "----------------------------------------------------------------------"
 echo "If you reached this far you passed. Congratulations!"
 echo "----------------------------------------------------------------------"
diff --git a/scripts/update_copier-templates b/scripts/update_copier-templates
@@ -4,5 +4,5 @@
 #
 
 for answer_file in .copier/answers_*.yaml ; do
-    pdm run copier update -a $answer_file
+    pdm run copier update -a $answer_file --skip-answered
 done
diff --git a/tox.ini b/tox.ini
@@ -28,9 +28,7 @@ requires =
 env_list =
     lint
     type
-    coverage_clean
     py{310,311,312}
-    coverage_report
 
 ; pytest & coverage
 ; https://pytest-cov.readthedocs.io/en/latest/tox.html
@@ -70,28 +68,14 @@ commands =
 
 [testenv]
 description = install pytest in a virtual environment and invoke it on the tests folder
-depends =
-    {py310,py311,312}: coverage_clean
-    coverage_report: py310,py311,312
 set_env =
   VIRTUALENV_DISCOVERY = pyenv
 deps =
     --global-option="$(python-config --includes)" -r requirements.txt
     --global-option="$(python-config --includes)" -r requirements-dev.txt
-# generate a coverage report but do not mesurements and do not fail
-# (we will combine all measurements into a single report later on)
+# do not generate a coverage report from tox
+#   if we would the files would be relative to the tox virtual environments
+#   and prefixed with '.tox/py*/lib/python*/site-packages/' - which makes
+#   them interesting to look at but useless for consumption by other tools
 commands =
-    pytest --cov=feeph.i2cmux --cov-append --cov-report= --cov-fail-under=0 {posargs: tests/}
-
-[testenv:coverage_clean]
-deps = coverage
-skip_install = true
-commands =
-    coverage erase
-
-[testenv:coverage_report]
-deps = coverage
-skip_install = true
-commands =
-    coverage report --show-missing
-    coverage html
+    pytest --no-cov {posargs: tests/}
