Add support for Python 3.12 (#947)

The CI now runs the tests against Python 3.12 as well.

The Dockerfile for arm64 was added to the repository to run the tests
for python 3.12 in arm64.

Author: daniel-zullo-frequenz

.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile renamed to .github/containers/nox-cross-arch/arm64-ubuntu-20.04-python.Dockerfile

@@ -5,9 +5,11 @@
 
 FROM docker.io/library/ubuntu:20.04
 
+ARG PYTHON_VERSION="3.11"
+
 ENV DEBIAN_FRONTEND=noninteractive
 
-# Install Python 3.11 and curl to install pip later
+# Install Python and curl to install pip later
 RUN apt-get update -y && \
     apt-get install --no-install-recommends -y \
         software-properties-common && \
@@ -16,16 +18,16 @@ RUN apt-get update -y && \
         ca-certificates \
         curl \
         git \
-        python3.11 \
-        python3.11-distutils && \
+        python${PYTHON_VERSION} \
+        python${PYTHON_VERSION}-distutils && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
 # Install pip
-RUN curl -sS https://bootstrap.pypa.io/get-pip.py | python3.11
+RUN curl -sS https://bootstrap.pypa.io/get-pip.py | python${PYTHON_VERSION}
 
 RUN update-alternatives --install \
-        /usr/local/bin/python python /usr/bin/python3.11 1 && \
+        /usr/local/bin/python python /usr/bin/python${PYTHON_VERSION} 1 && \
     python -m pip install --upgrade --no-cache-dir pip
 
 COPY entrypoint.bash /usr/bin/entrypoint.bash

.github/containers/test-installation/Dockerfile

@@ -3,7 +3,9 @@
 # This Dockerfile is used to test the installation of the python package in
 # multiple platforms in the CI. It is not used to build the package itself.
 
-FROM --platform=${TARGETPLATFORM} python:3.11-slim
+ARG PYTHON_VERSION="3.11"
+
+FROM --platform=${TARGETPLATFORM} python:${PYTHON_VERSION}-slim
 
 RUN apt-get update -y && \
     apt-get install --no-install-recommends -y \

.github/workflows/ci.yaml

@@ -33,6 +33,7 @@ jobs:
           - ubuntu-20.04
         python:
           - "3.11"
+          - "3.12"
         nox-session:
           # To speed things up a bit we use the special ci_checks_max session
           # that uses the same venv to run multiple linting sessions
@@ -88,10 +89,14 @@ jobs:
     # The job name should match the name of the `nox` job.
     name: Test with nox
     needs: ["nox"]
+    # We skip this job only if nox was also skipped
+    if: always() && needs.nox.result != 'skipped'
     runs-on: ubuntu-20.04
+    env:
+      DEPS_RESULT: ${{ needs.nox.result }}
     steps:
-      - name: Return true
-        run: "true"
+      - name: Check matrix job result
+        run: test "$DEPS_RESULT" = "success"
 
   nox-cross-arch:
     name: Cross-arch tests with nox
@@ -109,6 +114,7 @@ jobs:
           - ubuntu-20.04
         python:
           - "3.11"
+          - "3.12"
         nox-session:
           - "pytest_min"
           - "pytest_max"
@@ -140,8 +146,10 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .github/containers/nox-cross-arch
-          file: .github/containers/nox-cross-arch/${{ matrix.arch }}-${{ matrix.os }}-python-${{ matrix.python }}.Dockerfile
+          file: .github/containers/nox-cross-arch/${{ matrix.arch }}-${{ matrix.os }}-python.Dockerfile
           platforms: linux/${{ matrix.arch }}
+          build-args: |
+            PYTHON_VERSION=${{ matrix.python }}
           tags: localhost/nox-cross-arch:latest
           push: false
           load: true
@@ -200,10 +208,14 @@ jobs:
     # The job name should match the name of the `nox-cross-arch` job.
     name: Cross-arch tests with nox
     needs: ["nox-cross-arch"]
+    # We skip this job only if nox-cross-arch was also skipped
+    if: always() && needs.nox-cross-arch.result != 'skipped'
     runs-on: ubuntu-20.04
+    env:
+      DEPS_RESULT: ${{ needs.nox-cross-arch.result }}
     steps:
-      - name: Return true
-        run: "true"
+      - name: Check matrix job result
+        run: test "$DEPS_RESULT" = "success"
 
   build:
     name: Build distribution packages
@@ -239,7 +251,15 @@ jobs:
   test-installation:
     name: Test package installation in different architectures
     needs: ["build"]
-    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-20.04
+        python:
+          - "3.11"
+          - "3.12"
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Fetch sources
         uses: actions/checkout@v4
@@ -258,9 +278,28 @@ jobs:
           context: .
           file: .github/containers/test-installation/Dockerfile
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            PYTHON_VERSION=${{ matrix.python }}
           tags: localhost/test-installation
           push: false
 
+  # This job runs if all the `test-installation` matrix jobs ran and succeeded.
+  # It is only used to have a single job that we can require in branch
+  # protection rules, so we don't have to update the protection rules each time
+  # we add or remove a job from the matrix.
+  test-installation-all:
+    # The job name should match the name of the `test-installation` job.
+    name: Test package installation in different architectures
+    needs: ["test-installation"]
+    # We skip this job only if test-installation was also skipped
+    if: always() && needs.test-installation.result != 'skipped'
+    runs-on: ubuntu-20.04
+    env:
+      DEPS_RESULT: ${{ needs.test-installation.result }}
+    steps:
+      - name: Check matrix job result
+        run: test "$DEPS_RESULT" = "success"
+
   test-docs:
     name: Test documentation website generation
     if: github.event_name != 'push'

README.md

@@ -12,7 +12,7 @@ A development kit to interact with the Frequenz development platform.
 
 The following platforms are officially supported (test):
 
-- **Python:** 3.11
+- **Python:** 3.11, 3.12
 - **Operating System:** Ubuntu Linux 20.04
 - **Architectures:** amd64, arm64
 

pyproject.toml

@@ -33,10 +33,10 @@ dependencies = [
   "frequenz-channels >= 1.0.0-rc1, < 2.0.0",
   "frequenz-client-microgrid >= 0.3.0, < 0.4.0",
   "google-api-python-client >= 2.71, < 3",
-  "grpcio >= 1.54.2, < 2",
-  "grpcio-tools >= 1.54.2, < 2",
+  "grpcio >= 1.60.1, < 2",
+  "grpcio-tools >= 1.60.1, < 2",
   "networkx >= 2.8, < 4",
-  "numpy >= 1.24.2, < 2",
+  "numpy >= 1.26.4, < 2",
   "protobuf >= 4.21.6, < 6",
   "pydantic >= 2.3, < 3",
   "timezonefinder >= 6.2.0, < 7",