ci: test on Python 3.10/3.12 and QGIS 3.44 LTR/4.2, use one line length, guard the pin bump (#147)

* ci: test on Python 3.12, use one line length, guard the pin bump

- Set PYTHON_VERSION to 3.12 in tester.yml. LoopStructural uses
  'str | None' annotations (loop_common/base.py), which fail on 3.9.
- Use a line length of 100 in setup.cfg (isort), pylintrc and
  blackdoc, to agree with black, ruff and the pyproject isort config.
- In bump-loopstructural-pin.yml, stop the workflow when the release
  manifest does not give a valid version. Before, the workflow wrote
  'LoopStructural~=null'.

* ci: test on Python 3.10 and 3.12, and on QGIS 3.44 LTR and 4.2

- Run the unit tests on Python 3.10 (QGIS 3.44 LTR on Ubuntu 22.04)
  and on 3.12 (QGIS on Windows).
- Run the QGIS tests on qgis/qgis:3.44-jammy and qgis/qgis:4.2, not on
  release-3_28.
- Set PIP_BREAK_SYSTEM_PACKAGES, because newer images mark the system
  Python as externally managed. Do not upgrade the system pip.
- Give each matrix job its own coverage artifact name.

* ci: install the QGIS test requirements in a venv

Use a venv with --system-site-packages, so that QGIS stays importable
and pip can upgrade packages without uninstalling Debian packages.
This fixes two failures:
- 4.2: pip could not uninstall the Debian 'packaging' (no RECORD file).
- 3.44-jammy: the old system pip and setuptools read the loopprojectfile
  sdist metadata as 'unknown'. The venv upgrades pip and setuptools.

Author: lachlangrose

.github/workflows/bump-loopstructural-pin.yml

@@ -23,7 +23,11 @@ jobs:
           # can return whichever component's release was published last, not
           # necessarily the LoopStructural package. Read the manifest instead —
           # it maps package name to version unambiguously.
-          latest=$(curl -s https://raw.githubusercontent.com/Loop3D/LoopStructural/master/.release-please-manifest.json | jq -r '.["LoopStructural"]')
+          latest=$(curl -fsS https://raw.githubusercontent.com/Loop3D/LoopStructural/master/.release-please-manifest.json | jq -r '.["LoopStructural"] // empty')
+          if ! [[ "$latest" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "::error::Could not read a valid LoopStructural version from the release manifest (got '${latest}')."
+            exit 1
+          fi
           echo "version=$latest" >> "$GITHUB_OUTPUT"
 
       - name: Bump pins if minor version changed

.github/workflows/tester.yml

@@ -20,13 +20,19 @@ on:
 
 env:
   PROJECT_FOLDER: "loopstructural"
-  PYTHON_VERSION: 3.9
 
 
 jobs:
   tests-unit:
     runs-on: ubuntu-latest
 
+    # 3.10 is the oldest Python of a supported QGIS build (3.44 LTR on Ubuntu 22.04).
+    # 3.12 is the Python of the QGIS Windows (OSGeo4W) installers.
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12"]
+
     steps:
       - name: Get source code
         uses: actions/checkout@v7
@@ -36,7 +42,7 @@ jobs:
         with:
           cache: "pip"
           cache-dependency-path: "requirements/testing.txt"
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: ${{ matrix.python-version }}
 
       - name: Install Python requirements
         run: |
@@ -54,7 +60,7 @@ jobs:
         if: always()
         uses: actions/upload-artifact@v7
         with:
-          name: coverage-unit
+          name: coverage-unit-py${{ matrix.python-version }}
           path: |
             coverage.xml
             htmlcov/
@@ -64,8 +70,14 @@ jobs:
   test-qgis:
     runs-on: ubuntu-latest
 
+    # 3.44-jammy: the current LTR, with Python 3.10. 4.2: the latest release, with Qt6.
+    strategy:
+      fail-fast: false
+      matrix:
+        qgis-image: ["3.44-jammy", "4.2"]
+
     container:
-      image: qgis/qgis:release-3_28
+      image: qgis/qgis:${{ matrix.qgis-image }}
       env:
         CI: true
         DISPLAY: ":1"
@@ -88,13 +100,20 @@ jobs:
           set -e
           apt-get update
           DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
-            build-essential gdal-bin libgdal-dev proj-bin libproj-dev libgeos-dev python3-dev xvfb
+            build-essential gdal-bin libgdal-dev proj-bin libproj-dev libgeos-dev python3-dev python3-venv xvfb
           rm -rf /var/lib/apt/lists/*
 
       - name: Setup plugin
         run: bash /tests_directory/scripts/qgis_setup.sh loopstructural
 
 
+      # Install into a venv that can see the system packages (QGIS). Then pip and setuptools
+      # can be upgraded without changes to the Debian packages (PEP 668, no RECORD files).
+      - name: Create virtual environment
+        run: |
+          python3 -m venv --system-site-packages /opt/venv
+          echo "/opt/venv/bin" >> "$GITHUB_PATH"
+
       - name: Install Python requirements
         run: |
           python3 -m pip install -U pip setuptools wheel
@@ -114,7 +133,7 @@ jobs:
         if: always()
         uses: actions/upload-artifact@v7
         with:
-          name: coverage-qgis
+          name: coverage-qgis-${{ matrix.qgis-image }}
           path: |
             coverage.xml
             htmlcov/

linters/pylintrc

@@ -128,7 +128,7 @@ additional-builtins=
 [FORMAT]
 
 # Maximum number of characters on a single line.
-max-line-length=88
+max-line-length=100
 
 # Regexp for a line that is allowed to be longer than the limit.
 ignore-long-lines=^\s*(# )?<?https?://\S+>?$

pyproject.toml

@@ -13,11 +13,8 @@ target-version = ['py39']
 exclude = '\.eggs|\.git|\.mypy_cache|\.tox|\.venv|_build|buck-out|build|dist|node_modules'
 
 [tool.blackdoc]
-# From https://numpydoc.readthedocs.io/en/latest/format.html
-# Extended discussion: https://github.com/pyvista/pyvista/pull/4129
-# The length of docstring lines should be kept to 75 characters to facilitate
-# reading the docstrings in text terminals.
-line-length = 75
+line-length = 100
+
 [tool.ruff]
 exclude = ['.git', 'pycache__', 'build', 'dist', 'doc/examples', 'doc/_build']
 line-length = 100

setup.cfg

@@ -16,7 +16,7 @@ github_organization_slug = Loop3D
 ensure_newline_before_comments = True
 force_grid_wrap = 0
 include_trailing_comma = True
-line_length = 88
+line_length = 100
 multi_line_output = 3
 profile = black
 use_parentheses = True