Use Poetry for Python dependencies management

Previously, pip and venv were used for dependencies management. Since the time this project was set up, the Arduino
Tooling Team has settled on Poetry as the standard tool for this task.

.github/workflows/lint-python.yml

@@ -1,17 +1,25 @@
 name: Lint Python code
 
+env:
+  # See: https://pypi.org/project/poetry/#history
+  POETRY_VERSION: 1.4.0
+
 on:
   pull_request:
     paths:
       - '.github/workflows/lint-python.yml'
       - 'compilesketches/**.py'
       - '.python-version'
+      - '**/poetry.lock'
+      - '**/pyproject.toml'
 
   push:
     paths:
       - '.github/workflows/lint-python.yml'
       - 'compilesketches/**.py'
       - '.python-version'
+      - '**/poetry.lock'
+      - '**/pyproject.toml'
 
   # Scheduled trigger checks for workflow failures resulting from updates to the linting tools
   schedule:
@@ -39,23 +47,20 @@ jobs:
         with:
           python-version-file: .python-version
 
-      - name: Run the set up script
-        id: setup
+      - name: Install Poetry
         run: |
-          "${{ github.workspace }}/action-setup.sh"
+          pipx \
+            install \
+              poetry==${{ env.POETRY_VERSION }}
 
-      - name: Install flake8
+      - name: Install Python Dependencies
         run: |
-          source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
-          python \
-            -m \
-              pip install \
-                flake8 \
-                pep8-naming
+          poetry \
+            install \
+            --only dev
 
       - name: Lint with flake8
         env:
           PYTHON_PROJECT_PATH: ${GITHUB_WORKSPACE}/compilesketches
         run: |
-          source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
-          flake8 --config "${{ env.PYTHON_PROJECT_PATH }}/.flake8" --show-source "${{ env.PYTHON_PROJECT_PATH }}"
+          poetry run flake8 --config "${{ env.PYTHON_PROJECT_PATH }}/.flake8" --show-source "${{ env.PYTHON_PROJECT_PATH }}"

.github/workflows/test-python.yml

@@ -1,18 +1,24 @@
 name: Test Python code
 
+env:
+  # See: https://pypi.org/project/poetry/#history
+  POETRY_VERSION: 1.4.0
+
 on:
   pull_request:
     paths:
       - '.github/workflows/test-python.yml'
       - '.python-version'
-      - 'action-setup.sh'
+      - '**/poetry.lock'
+      - '**/pyproject.toml'
       - 'compilesketches/**'
 
   push:
     paths:
       - '.github/workflows/test-python.yml'
       - '.python-version'
-      - 'action-setup.sh'
+      - '**/poetry.lock'
+      - '**/pyproject.toml'
       - 'compilesketches/**'
 
   # Catch issues resulting from new patch releases of Python in the APT repository
@@ -46,43 +52,40 @@ jobs:
         with:
           python-version-file: .python-version
 
-      - name: Run the set up script
-        id: setup
+      - name: Install Poetry
         run: |
-          "${{ github.workspace }}/action-setup.sh"
+          pipx \
+            install \
+              poetry==${{ env.POETRY_VERSION }}
 
-      - name: Install test dependencies
+      - name: Install Python Dependencies
         run: |
-          source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
-          python \
-            -m \
-              pip install \
-                --requirement "${{ env.PYTHON_PROJECT_TESTS_PATH }}/requirements.txt"
+          poetry install
 
       - name: Run Python unit tests and record code coverage data
         run: |
-          source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
           export PYTHONPATH="${{ env.PYTHON_PROJECT_PATH }}"
-          python \
-            -m \
-              coverage run \
-                --rcfile="${{ env.PYTHON_PROJECT_TESTS_PATH }}/.coveragerc" \
-                --source="${{ env.PYTHON_PROJECT_PATH }}" \
-                --module \
-                  pytest "${{ env.PYTHON_PROJECT_TESTS_PATH }}"
+          poetry run \
+            python \
+              -m \
+                coverage run \
+                  --source="${{ env.PYTHON_PROJECT_PATH }}" \
+                  --module \
+                    pytest "${{ env.PYTHON_PROJECT_TESTS_PATH }}"
           # Generate coverage data file for consumption by `codecov/codecov-action`.
           # Otherwise that action generates the file using the system Python environment, which doesn't work.
-          python \
-            -m \
-              coverage xml \
-                -o "${{ github.workspace }}/${{ env.COVERAGE_DATA_FILENAME }}"
+          poetry run \
+            python \
+              -m \
+                coverage xml \
+                  -o "${{ github.workspace }}/${{ env.COVERAGE_DATA_FILENAME }}"
 
       - name: Display code coverage report
         run: |
-          source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
-          python \
-            -m \
-              coverage report
+          poetry run \
+            python \
+              -m \
+                coverage report
 
       - name: Upload coverage report to Codecov
         uses: codecov/codecov-action@v3

action.yml

@@ -54,14 +54,18 @@ runs:
       with:
         python-version-file: ${{ github.action_path }}/.python-version
 
-    - name: Run the set up script
-      id: setup
+    - name: Install Poetry
       shell: bash
       run: |
-        # Group action setup log output
-        echo "::group::Action set up"
-        "${{ github.action_path }}/action-setup.sh"
-        echo "::endgroup::"
+        pipx install \
+          poetry==1.4.0
+
+    - name: Install Python Dependencies
+      shell: bash
+      working-directory: ${{ github.action_path }}
+      run: |
+        poetry install \
+          --only main
 
     - name: Run script
       shell: bash
@@ -77,6 +81,7 @@ runs:
         INPUT_ENABLE-DELTAS-REPORT: ${{ inputs.enable-deltas-report }}
         INPUT_ENABLE-WARNINGS-REPORT: ${{ inputs.enable-warnings-report }}
         INPUT_SKETCHES-REPORT-PATH: ${{ inputs.sketches-report-path }}
+      working-directory: ${{ github.action_path }}
       run: |
-        source "${{ steps.setup.outputs.python-venv-activate-script-path }}"
-        python "${{ github.action_path }}/compilesketches/compilesketches.py"
+        poetry run \
+          python "${{ github.action_path }}/compilesketches/compilesketches.py"

compilesketches/.flake8

@@ -1,6 +1,5 @@
 [flake8]
 doctests = True
-extend-exclude = .venv
 # W503 and W504 are mutually exclusive. PEP 8 recommends line break before.
 ignore = W503
 max-complexity = 10