From cadad76f21ceb96670ada9298bf9d6492e519fdd Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:36 -0400 Subject: [PATCH 01/16] tests: update vm tests to prefer locally-built QEMU MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In 05e4982, we updated our QMP tests to prefer `-object monitor-qmp`, but this requires a sufficiently recent and modern version of QEMU to run correctly. Update the "make vm-build-xxx" targets to use the runscript that will naturally prefer the locally built version of QEMU so that these tests launch successfully once more. Fixes: 05e4982 ("tests: switch from -mon to -object monitor-qmp") Signed-off-by: John Snow Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-2-jsnow@redhat.com> Signed-off-by: John Snow --- tests/vm/Makefile.include | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/vm/Makefile.include b/tests/vm/Makefile.include index 0a53dc9fdd..0ec1b47e63 100644 --- a/tests/vm/Makefile.include +++ b/tests/vm/Makefile.include @@ -5,7 +5,7 @@ ifeq ($(realpath $(SRC_PATH)),$(realpath .)) VM_PYTHON = $(SRC_PATH)/vm-venv/bin/python3 VM_VENV = vm-venv else -VM_PYTHON = $(PYTHON) +VM_PYTHON = $(BUILD_DIR)/run $(PYTHON) VM_VENV = endif From 6f55b7149f421d54c638966dda8c09d992763580 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:37 -0400 Subject: [PATCH 02/16] tests: update libvirt-ci, lcitool MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update libvirt-ci to current origin/master for the primary sake of grabbing new mappings for FreeBSD, which has upgraded from Python 3.11 to 3.12 and along with it changed the name of their python ecosystem packages. Refresh the lcitool generated files to fix our FreeBSD tests. Signed-off-by: John Snow Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-3-jsnow@redhat.com> Signed-off-by: John Snow --- scripts/ci/setup/debian/debian-13-ppc64le.yaml | 2 +- scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml | 2 +- scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml | 2 +- tests/docker/dockerfiles/debian-amd64-cross.docker | 2 +- tests/docker/dockerfiles/debian-arm64-cross.docker | 2 +- tests/docker/dockerfiles/debian-armhf-cross.docker | 2 +- tests/docker/dockerfiles/debian-i686-cross.docker | 2 +- tests/docker/dockerfiles/debian-ppc64el-cross.docker | 2 +- tests/docker/dockerfiles/debian-riscv64-cross.docker | 2 +- tests/docker/dockerfiles/debian-s390x-cross.docker | 2 +- tests/docker/dockerfiles/debian.docker | 2 +- tests/docker/dockerfiles/opensuse-leap.docker | 2 +- tests/docker/dockerfiles/ubuntu2404.docker | 2 +- tests/lcitool/libvirt-ci | 2 +- tests/vm/generated/freebsd.json | 12 ++++++------ 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/scripts/ci/setup/debian/debian-13-ppc64le.yaml b/scripts/ci/setup/debian/debian-13-ppc64le.yaml index 9acd99a743..c4d229830b 100644 --- a/scripts/ci/setup/debian/debian-13-ppc64le.yaml +++ b/scripts/ci/setup/debian/debian-13-ppc64le.yaml @@ -75,7 +75,7 @@ packages: - libsdl2-dev - libsdl2-image-dev - libseccomp-dev - - libselinux1-dev + - libselinux-dev - libslirp-dev - libsnappy-dev - libsndio-dev diff --git a/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml b/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml index 5c948109df..f6fa68d476 100644 --- a/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml +++ b/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml @@ -75,7 +75,7 @@ packages: - libsdl2-dev - libsdl2-image-dev - libseccomp-dev - - libselinux1-dev + - libselinux-dev - libslirp-dev - libsnappy-dev - libsndio-dev diff --git a/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml b/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml index 010b7f86aa..6c4cefe97e 100644 --- a/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml +++ b/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml @@ -75,7 +75,7 @@ packages: - libsdl2-dev - libsdl2-image-dev - libseccomp-dev - - libselinux1-dev + - libselinux-dev - libslirp-dev - libsnappy-dev - libsndio-dev diff --git a/tests/docker/dockerfiles/debian-amd64-cross.docker b/tests/docker/dockerfiles/debian-amd64-cross.docker index 9e30457ca7..e945e641e2 100644 --- a/tests/docker/dockerfiles/debian-amd64-cross.docker +++ b/tests/docker/dockerfiles/debian-amd64-cross.docker @@ -130,7 +130,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:amd64 \ libsdl2-image-dev:amd64 \ libseccomp-dev:amd64 \ - libselinux1-dev:amd64 \ + libselinux-dev:amd64 \ libslirp-dev:amd64 \ libsnappy-dev:amd64 \ libsndio-dev:amd64 \ diff --git a/tests/docker/dockerfiles/debian-arm64-cross.docker b/tests/docker/dockerfiles/debian-arm64-cross.docker index b9b94e5e6f..0ee3a3f61c 100644 --- a/tests/docker/dockerfiles/debian-arm64-cross.docker +++ b/tests/docker/dockerfiles/debian-arm64-cross.docker @@ -129,7 +129,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:arm64 \ libsdl2-image-dev:arm64 \ libseccomp-dev:arm64 \ - libselinux1-dev:arm64 \ + libselinux-dev:arm64 \ libslirp-dev:arm64 \ libsnappy-dev:arm64 \ libsndio-dev:arm64 \ diff --git a/tests/docker/dockerfiles/debian-armhf-cross.docker b/tests/docker/dockerfiles/debian-armhf-cross.docker index aa412ff66f..aacc184680 100644 --- a/tests/docker/dockerfiles/debian-armhf-cross.docker +++ b/tests/docker/dockerfiles/debian-armhf-cross.docker @@ -128,7 +128,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:armhf \ libsdl2-image-dev:armhf \ libseccomp-dev:armhf \ - libselinux1-dev:armhf \ + libselinux-dev:armhf \ libslirp-dev:armhf \ libsnappy-dev:armhf \ libsndio-dev:armhf \ diff --git a/tests/docker/dockerfiles/debian-i686-cross.docker b/tests/docker/dockerfiles/debian-i686-cross.docker index d07eac84fe..476031bd4d 100644 --- a/tests/docker/dockerfiles/debian-i686-cross.docker +++ b/tests/docker/dockerfiles/debian-i686-cross.docker @@ -128,7 +128,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:i386 \ libsdl2-image-dev:i386 \ libseccomp-dev:i386 \ - libselinux1-dev:i386 \ + libselinux-dev:i386 \ libslirp-dev:i386 \ libsnappy-dev:i386 \ libsndio-dev:i386 \ diff --git a/tests/docker/dockerfiles/debian-ppc64el-cross.docker b/tests/docker/dockerfiles/debian-ppc64el-cross.docker index 7302c8236e..87e24d4dc0 100644 --- a/tests/docker/dockerfiles/debian-ppc64el-cross.docker +++ b/tests/docker/dockerfiles/debian-ppc64el-cross.docker @@ -129,7 +129,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:ppc64el \ libsdl2-image-dev:ppc64el \ libseccomp-dev:ppc64el \ - libselinux1-dev:ppc64el \ + libselinux-dev:ppc64el \ libslirp-dev:ppc64el \ libsnappy-dev:ppc64el \ libsndio-dev:ppc64el \ diff --git a/tests/docker/dockerfiles/debian-riscv64-cross.docker b/tests/docker/dockerfiles/debian-riscv64-cross.docker index aa5a881cab..d0a9805f86 100644 --- a/tests/docker/dockerfiles/debian-riscv64-cross.docker +++ b/tests/docker/dockerfiles/debian-riscv64-cross.docker @@ -129,7 +129,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:riscv64 \ libsdl2-image-dev:riscv64 \ libseccomp-dev:riscv64 \ - libselinux1-dev:riscv64 \ + libselinux-dev:riscv64 \ libslirp-dev:riscv64 \ libsnappy-dev:riscv64 \ libsndio-dev:riscv64 \ diff --git a/tests/docker/dockerfiles/debian-s390x-cross.docker b/tests/docker/dockerfiles/debian-s390x-cross.docker index 82eae4fc2c..179be9573d 100644 --- a/tests/docker/dockerfiles/debian-s390x-cross.docker +++ b/tests/docker/dockerfiles/debian-s390x-cross.docker @@ -129,7 +129,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev:s390x \ libsdl2-image-dev:s390x \ libseccomp-dev:s390x \ - libselinux1-dev:s390x \ + libselinux-dev:s390x \ libslirp-dev:s390x \ libsnappy-dev:s390x \ libsndio-dev:s390x \ diff --git a/tests/docker/dockerfiles/debian.docker b/tests/docker/dockerfiles/debian.docker index 3a4f208ccf..56605a42a2 100644 --- a/tests/docker/dockerfiles/debian.docker +++ b/tests/docker/dockerfiles/debian.docker @@ -82,7 +82,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev \ libsdl2-image-dev \ libseccomp-dev \ - libselinux1-dev \ + libselinux-dev \ libslirp-dev \ libsnappy-dev \ libsndio-dev \ diff --git a/tests/docker/dockerfiles/opensuse-leap.docker b/tests/docker/dockerfiles/opensuse-leap.docker index 8d8631bbcf..a634f39c1e 100644 --- a/tests/docker/dockerfiles/opensuse-leap.docker +++ b/tests/docker/dockerfiles/opensuse-leap.docker @@ -7,7 +7,7 @@ FROM registry.opensuse.org/opensuse/leap:16.0 RUN zypper update -y && \ - zypper install -y \ + zypper install -y --allow-downgrade \ Mesa-devel \ alsa-lib-devel \ bash \ diff --git a/tests/docker/dockerfiles/ubuntu2404.docker b/tests/docker/dockerfiles/ubuntu2404.docker index a5c22231f9..d80f3a33d3 100644 --- a/tests/docker/dockerfiles/ubuntu2404.docker +++ b/tests/docker/dockerfiles/ubuntu2404.docker @@ -82,7 +82,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ libsdl2-dev \ libsdl2-image-dev \ libseccomp-dev \ - libselinux1-dev \ + libselinux-dev \ libslirp-dev \ libsnappy-dev \ libsndio-dev \ diff --git a/tests/lcitool/libvirt-ci b/tests/lcitool/libvirt-ci index 5176e136ab..76b5dd5b5c 160000 --- a/tests/lcitool/libvirt-ci +++ b/tests/lcitool/libvirt-ci @@ -1 +1 @@ -Subproject commit 5176e136ab11e275eb9f57c3d5c80e77af6507cb +Subproject commit 76b5dd5b5c84511e2e799c2b3d6a2a9b9f6a081d diff --git a/tests/vm/generated/freebsd.json b/tests/vm/generated/freebsd.json index dfa8b41a52..ee3402f0d2 100644 --- a/tests/vm/generated/freebsd.json +++ b/tests/vm/generated/freebsd.json @@ -52,12 +52,12 @@ "pixman", "pkgconf", "png", - "py311-pip", - "py311-setuptools", - "py311-sphinx", - "py311-sphinx_rtd_theme", - "py311-tomli", - "py311-wheel", + "py312-pip", + "py312-setuptools", + "py312-sphinx", + "py312-sphinx_rtd_theme", + "py312-tomli", + "py312-wheel", "python3", "rpm2cpio", "rust", From 388c576960f01d79f7abeafbad14feeac34f5513 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:38 -0400 Subject: [PATCH 03/16] tests: update netbsd dependencies MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit NetBSD appears to need 'bison' explicitly installed now. I am still seeing some intermittant failures in the tests for ide-test and qos-test, but those are mysteries for another day. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-4-jsnow@redhat.com> Signed-off-by: John Snow --- tests/vm/netbsd | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/vm/netbsd b/tests/vm/netbsd index b365045066..45afe675e1 100755 --- a/tests/vm/netbsd +++ b/tests/vm/netbsd @@ -39,6 +39,7 @@ class NetBSDVM(basevm.BaseVM): "gmake", "gsed", "gettext-tools", + "bison", # libs: basic "dtc", From 579a5915b8f6e18996dd5db1c1cef76ef8b114f2 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:39 -0400 Subject: [PATCH 04/16] tests: drop python3-devel mapping MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is not being used, so drop it. Signed-off-by: John Snow Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-5-jsnow@redhat.com> Signed-off-by: John Snow --- tests/lcitool/mappings.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/tests/lcitool/mappings.yml b/tests/lcitool/mappings.yml index 1816556dde..d2d4061316 100644 --- a/tests/lcitool/mappings.yml +++ b/tests/lcitool/mappings.yml @@ -6,9 +6,6 @@ mappings: python3: CentOSStream9: python3.11 - python3-devel: - CentOSStream9: python3.11-devel - python3-pip: CentOSStream9: python3.11-pip From 0ba1e0737612ecdf6ae505ea0a30c4d75cb0caba Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:40 -0400 Subject: [PATCH 05/16] tests: re-add opencv2 and numpy dependencies MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes: 2a428c8541ec5e9be54aad5f0a446ec8172226c9 Some of the dependencies identified as avocado dependencies were in fact still being used, and should be re-added to our lcitool configuration to ensure that these tests are being executed in the CI environment. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Reviewed-by: Philippe Mathieu-Daudé Message-ID: <20260825215851.1780608-6-jsnow@redhat.com> Signed-off-by: John Snow --- .gitlab-ci.d/macos-14.vars | 2 +- scripts/ci/setup/debian/debian-13-ppc64le.yaml | 2 ++ scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml | 2 ++ scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml | 2 ++ tests/docker/dockerfiles/alpine.docker | 1 + tests/docker/dockerfiles/centos9.docker | 2 ++ tests/docker/dockerfiles/debian-amd64-cross.docker | 2 ++ tests/docker/dockerfiles/debian-arm64-cross.docker | 2 ++ tests/docker/dockerfiles/debian-armhf-cross.docker | 2 ++ tests/docker/dockerfiles/debian-i686-cross.docker | 2 ++ tests/docker/dockerfiles/debian-ppc64el-cross.docker | 2 ++ tests/docker/dockerfiles/debian-riscv64-cross.docker | 2 ++ tests/docker/dockerfiles/debian-s390x-cross.docker | 2 ++ tests/docker/dockerfiles/debian.docker | 2 ++ tests/docker/dockerfiles/fedora-rust-nightly.docker | 2 ++ tests/docker/dockerfiles/fedora-win64-cross.docker | 2 ++ tests/docker/dockerfiles/fedora.docker | 2 ++ tests/docker/dockerfiles/opensuse-leap.docker | 2 ++ tests/docker/dockerfiles/ubuntu2404.docker | 2 ++ tests/lcitool/mappings.yml | 12 ++++++++++++ tests/lcitool/projects/qemu.yml | 2 ++ tests/vm/generated/freebsd.json | 2 ++ 22 files changed, 52 insertions(+), 1 deletion(-) diff --git a/.gitlab-ci.d/macos-14.vars b/.gitlab-ci.d/macos-14.vars index 0c187624dd..f96e173f66 100644 --- a/.gitlab-ci.d/macos-14.vars +++ b/.gitlab-ci.d/macos-14.vars @@ -12,5 +12,5 @@ NINJA='/opt/homebrew/bin/ninja' PACKAGING_COMMAND='brew' PIP3='/opt/homebrew/bin/pip3' PKGS='bash bc bindgen bison bzip2 capstone ccache cmocka coreutils ctags curl dbus diffutils dtc flex gcovr gettext git glib gnu-sed gnutls gtk+3 gtk-vnc jemalloc jpeg-turbo json-c libcbor libepoxy libffi libgcrypt libiscsi libnfs libpng libslirp libssh libtasn1 libusb llvm lzo make meson mtools ncurses nettle ninja pixman pkg-config python-setuptools python3 rpm2cpio rust sdl2 sdl2_image snappy socat sparse spice-protocol swtpm tesseract usbredir vde vte3 vulkan-tools xorriso zlib zstd' -PYPI_PKGS='sphinx sphinx-rtd-theme tomli' +PYPI_PKGS='numpy sphinx sphinx-rtd-theme tomli' PYTHON='/opt/homebrew/bin/python3' diff --git a/scripts/ci/setup/debian/debian-13-ppc64le.yaml b/scripts/ci/setup/debian/debian-13-ppc64le.yaml index c4d229830b..86c6d8bac0 100644 --- a/scripts/ci/setup/debian/debian-13-ppc64le.yaml +++ b/scripts/ci/setup/debian/debian-13-ppc64le.yaml @@ -105,6 +105,8 @@ packages: - openssh-client - pkgconf - python3 + - python3-numpy + - python3-opencv - python3-pip - python3-setuptools - python3-sphinx diff --git a/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml b/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml index f6fa68d476..cbdc56369f 100644 --- a/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml +++ b/scripts/ci/setup/ubuntu/ubuntu-2404-aarch64.yaml @@ -106,6 +106,8 @@ packages: - openssh-client - pkgconf - python3 + - python3-numpy + - python3-opencv - python3-pip - python3-setuptools - python3-sphinx diff --git a/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml b/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml index 6c4cefe97e..2ce5653720 100644 --- a/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml +++ b/scripts/ci/setup/ubuntu/ubuntu-2404-s390x.yaml @@ -104,6 +104,8 @@ packages: - openssh-client - pkgconf - python3 + - python3-numpy + - python3-opencv - python3-pip - python3-setuptools - python3-sphinx diff --git a/tests/docker/dockerfiles/alpine.docker b/tests/docker/dockerfiles/alpine.docker index 8a5a355e89..7c342e801c 100644 --- a/tests/docker/dockerfiles/alpine.docker +++ b/tests/docker/dockerfiles/alpine.docker @@ -83,6 +83,7 @@ RUN apk update && \ pixman-dev \ pkgconf \ pulseaudio-dev \ + py3-numpy \ py3-pip \ py3-setuptools \ py3-sphinx \ diff --git a/tests/docker/dockerfiles/centos9.docker b/tests/docker/dockerfiles/centos9.docker index 8101370a2d..6f5c400c2d 100644 --- a/tests/docker/dockerfiles/centos9.docker +++ b/tests/docker/dockerfiles/centos9.docker @@ -130,6 +130,8 @@ RUN dnf --quiet distro-sync -y && \ ln -s /usr/bin/ccache /usr/libexec/ccache-wrappers/gcc RUN /usr/bin/pip3.11 install \ + numpy \ + opencv-python \ sphinx \ sphinx-rtd-theme diff --git a/tests/docker/dockerfiles/debian-amd64-cross.docker b/tests/docker/dockerfiles/debian-amd64-cross.docker index e945e641e2..975b9f346e 100644 --- a/tests/docker/dockerfiles/debian-amd64-cross.docker +++ b/tests/docker/dockerfiles/debian-amd64-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-arm64-cross.docker b/tests/docker/dockerfiles/debian-arm64-cross.docker index 0ee3a3f61c..3efce40482 100644 --- a/tests/docker/dockerfiles/debian-arm64-cross.docker +++ b/tests/docker/dockerfiles/debian-arm64-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-armhf-cross.docker b/tests/docker/dockerfiles/debian-armhf-cross.docker index aacc184680..91e8587b5d 100644 --- a/tests/docker/dockerfiles/debian-armhf-cross.docker +++ b/tests/docker/dockerfiles/debian-armhf-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-i686-cross.docker b/tests/docker/dockerfiles/debian-i686-cross.docker index 476031bd4d..a60b72e05b 100644 --- a/tests/docker/dockerfiles/debian-i686-cross.docker +++ b/tests/docker/dockerfiles/debian-i686-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-ppc64el-cross.docker b/tests/docker/dockerfiles/debian-ppc64el-cross.docker index 87e24d4dc0..a7599b4f61 100644 --- a/tests/docker/dockerfiles/debian-ppc64el-cross.docker +++ b/tests/docker/dockerfiles/debian-ppc64el-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-riscv64-cross.docker b/tests/docker/dockerfiles/debian-riscv64-cross.docker index d0a9805f86..52661d4d9e 100644 --- a/tests/docker/dockerfiles/debian-riscv64-cross.docker +++ b/tests/docker/dockerfiles/debian-riscv64-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian-s390x-cross.docker b/tests/docker/dockerfiles/debian-s390x-cross.docker index 179be9573d..0a04777b36 100644 --- a/tests/docker/dockerfiles/debian-s390x-cross.docker +++ b/tests/docker/dockerfiles/debian-s390x-cross.docker @@ -41,6 +41,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/debian.docker b/tests/docker/dockerfiles/debian.docker index 56605a42a2..77869f7154 100644 --- a/tests/docker/dockerfiles/debian.docker +++ b/tests/docker/dockerfiles/debian.docker @@ -113,6 +113,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/fedora-rust-nightly.docker b/tests/docker/dockerfiles/fedora-rust-nightly.docker index 0f3dc370a4..0f7b4c1338 100644 --- a/tests/docker/dockerfiles/fedora-rust-nightly.docker +++ b/tests/docker/dockerfiles/fedora-rust-nightly.docker @@ -104,6 +104,8 @@ exec "$@"\n' > /usr/bin/nosync && \ pkgconfig \ pulseaudio-libs-devel \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/fedora-win64-cross.docker b/tests/docker/dockerfiles/fedora-win64-cross.docker index 6f972f6173..3ed3e15df3 100644 --- a/tests/docker/dockerfiles/fedora-win64-cross.docker +++ b/tests/docker/dockerfiles/fedora-win64-cross.docker @@ -44,6 +44,8 @@ exec "$@"\n' > /usr/bin/nosync && \ ninja-build \ openssh-clients \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/fedora.docker b/tests/docker/dockerfiles/fedora.docker index 99bb38a366..8fa8bea1ab 100644 --- a/tests/docker/dockerfiles/fedora.docker +++ b/tests/docker/dockerfiles/fedora.docker @@ -104,6 +104,8 @@ exec "$@"\n' > /usr/bin/nosync && \ pkgconfig \ pulseaudio-libs-devel \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/docker/dockerfiles/opensuse-leap.docker b/tests/docker/dockerfiles/opensuse-leap.docker index a634f39c1e..3a3d6f73c8 100644 --- a/tests/docker/dockerfiles/opensuse-leap.docker +++ b/tests/docker/dockerfiles/opensuse-leap.docker @@ -95,6 +95,8 @@ RUN zypper update -y && \ pkgconfig \ python3-Sphinx \ python3-base \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx_rtd_theme \ diff --git a/tests/docker/dockerfiles/ubuntu2404.docker b/tests/docker/dockerfiles/ubuntu2404.docker index d80f3a33d3..bb8f4e4e53 100644 --- a/tests/docker/dockerfiles/ubuntu2404.docker +++ b/tests/docker/dockerfiles/ubuntu2404.docker @@ -113,6 +113,8 @@ RUN export DEBIAN_FRONTEND=noninteractive && \ openssh-client \ pkgconf \ python3 \ + python3-numpy \ + python3-opencv \ python3-pip \ python3-setuptools \ python3-sphinx \ diff --git a/tests/lcitool/mappings.yml b/tests/lcitool/mappings.yml index d2d4061316..cb56cdb3da 100644 --- a/tests/lcitool/mappings.yml +++ b/tests/lcitool/mappings.yml @@ -18,12 +18,18 @@ mappings: python3-sphinx-rtd-theme: CentOSStream9: + python3-opencv: + CentOSStream9: + python3-venv: CentOSStream9: python3.11 python3-wheel: CentOSStream9: python3.11-wheel + python3-numpy: + CentOSStream9: + meson: # Use Meson from PyPI wherever Rust is enabled Debian: @@ -51,3 +57,9 @@ pypi_mappings: apk: Fedora: Debian12: + + python3-numpy: + CentOSStream9: numpy + + python3-opencv: + CentOSStream9: opencv-python diff --git a/tests/lcitool/projects/qemu.yml b/tests/lcitool/projects/qemu.yml index b3c9993672..abbd3e3f0b 100644 --- a/tests/lcitool/projects/qemu.yml +++ b/tests/lcitool/projects/qemu.yml @@ -91,6 +91,8 @@ packages: - pkg-config - pulseaudio - python3 + - python3-numpy + - python3-opencv - python3-pip - python3-setuptools - python3-sphinx diff --git a/tests/vm/generated/freebsd.json b/tests/vm/generated/freebsd.json index ee3402f0d2..c35591b39d 100644 --- a/tests/vm/generated/freebsd.json +++ b/tests/vm/generated/freebsd.json @@ -49,9 +49,11 @@ "ncurses", "nettle", "ninja", + "opencv", "pixman", "pkgconf", "png", + "py312-numpy", "py312-pip", "py312-setuptools", "py312-sphinx", From a924cfa28af7a3660f229fbd54b1a1b93232fb1a Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:41 -0400 Subject: [PATCH 06/16] tests: add Python3.12 to centos9.docker MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit While we recently upgraded to Python 3.11 for the CentOS 9 container, upgrade it EVEN FURTHER BEYOND... to Python 3.12. Signed-off-by: John Snow Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-7-jsnow@redhat.com> Signed-off-by: John Snow --- tests/docker/dockerfiles/centos9.docker | 12 ++++++------ tests/lcitool/mappings.yml | 10 +++++----- tests/lcitool/targets/centos-stream-9.yml | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/tests/docker/dockerfiles/centos9.docker b/tests/docker/dockerfiles/centos9.docker index 6f5c400c2d..8bfce395f9 100644 --- a/tests/docker/dockerfiles/centos9.docker +++ b/tests/docker/dockerfiles/centos9.docker @@ -96,10 +96,10 @@ RUN dnf --quiet distro-sync -y && \ pkgconfig \ pulseaudio-libs-devel \ python3-tomli \ - python3.11 \ - python3.11-pip \ - python3.11-setuptools \ - python3.11-wheel \ + python3.12 \ + python3.12-pip \ + python3.12-setuptools \ + python3.12-wheel \ rdma-core-devel \ rust \ rust-std-static \ @@ -129,7 +129,7 @@ RUN dnf --quiet distro-sync -y && \ ln -s /usr/bin/ccache /usr/libexec/ccache-wrappers/clang && \ ln -s /usr/bin/ccache /usr/libexec/ccache-wrappers/gcc -RUN /usr/bin/pip3.11 install \ +RUN /usr/bin/pip3.12 install \ numpy \ opencv-python \ sphinx \ @@ -139,7 +139,7 @@ ENV CCACHE_WRAPPERSDIR="/usr/libexec/ccache-wrappers" ENV LANG="en_US.UTF-8" ENV MAKE="/usr/bin/make" ENV NINJA="/usr/bin/ninja" -ENV PYTHON="/usr/bin/python3.11" +ENV PYTHON="/usr/bin/python3.12" # As a final step configure the user (if env is defined) ARG USER ARG UID diff --git a/tests/lcitool/mappings.yml b/tests/lcitool/mappings.yml index cb56cdb3da..c99f007798 100644 --- a/tests/lcitool/mappings.yml +++ b/tests/lcitool/mappings.yml @@ -4,13 +4,13 @@ mappings: Ubuntu2204: python3: - CentOSStream9: python3.11 + CentOSStream9: python3.12 python3-pip: - CentOSStream9: python3.11-pip + CentOSStream9: python3.12-pip python3-setuptools: - CentOSStream9: python3.11-setuptools + CentOSStream9: python3.12-setuptools python3-sphinx: CentOSStream9: @@ -22,10 +22,10 @@ mappings: CentOSStream9: python3-venv: - CentOSStream9: python3.11 + CentOSStream9: python3.12 python3-wheel: - CentOSStream9: python3.11-wheel + CentOSStream9: python3.12-wheel python3-numpy: CentOSStream9: diff --git a/tests/lcitool/targets/centos-stream-9.yml b/tests/lcitool/targets/centos-stream-9.yml index c2d87f6cb4..0d6801fd9a 100644 --- a/tests/lcitool/targets/centos-stream-9.yml +++ b/tests/lcitool/targets/centos-stream-9.yml @@ -1,3 +1,3 @@ paths: - pip3: /usr/bin/pip3.11 - python: /usr/bin/python3.11 + pip3: /usr/bin/pip3.12 + python: /usr/bin/python3.12 From 9e74604ec042323c2016cfa1628d0cf7db25379a Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:42 -0400 Subject: [PATCH 07/16] tests: update emsdk-wasm64-cross MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This container currently uses Ubuntu 22.04 as a base, which is no longer supported by QEMU as a build platform. Upgrade to a newer version of the image which will provide Python3.12+. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Reviewed-by: Kohei Tokunaga Message-ID: <20260825215851.1780608-8-jsnow@redhat.com> Signed-off-by: John Snow --- tests/docker/dockerfiles/emsdk-wasm64-cross.docker | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/docker/dockerfiles/emsdk-wasm64-cross.docker b/tests/docker/dockerfiles/emsdk-wasm64-cross.docker index c04a741b0e..f11a9f3424 100644 --- a/tests/docker/dockerfiles/emsdk-wasm64-cross.docker +++ b/tests/docker/dockerfiles/emsdk-wasm64-cross.docker @@ -1,6 +1,6 @@ # syntax = docker/dockerfile:1.5 -ARG EMSDK_VERSION_QEMU=4.0.10 +ARG EMSDK_VERSION_QEMU=5.0.2 ARG ZLIB_VERSION=1.3.2 ARG GLIB_MINOR_VERSION=2.84 ARG GLIB_VERSION=${GLIB_MINOR_VERSION}.0 @@ -27,7 +27,7 @@ RUN apt-get update && apt-get install -y \ pkgconf \ ninja-build \ python3-pip -RUN pip3 install meson==${MESON_VERSION} tomli +RUN pip3 install --break-system-packages meson==${MESON_VERSION} tomli RUN mkdir /build WORKDIR /build RUN mkdir -p $TARGET From ab2de86588690291009b063938abf10d4faed420 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:43 -0400 Subject: [PATCH 08/16] qapi: update type hint for objects_seen MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In preparation for upgrading Python to 3.12+, adjust the type hint on objects_seen to prevent mypy from chirping about an unknown type for this variable. Why didn't this trigger earlier? A mystery for the ages. Signed-off-by: John Snow Reviewed-by: Markus Armbruster Reviewed-by: Marc-André Lureau Reviewed-by: Philippe Mathieu-Daudé Message-ID: <20260825215851.1780608-9-jsnow@redhat.com> Signed-off-by: John Snow --- scripts/qapi/types.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py index 2bf7533828..b87377c647 100644 --- a/scripts/qapi/types.py +++ b/scripts/qapi/types.py @@ -34,7 +34,7 @@ from .source import QAPISourceInfo # variants must be emitted before their container; track what has already # been output -objects_seen = set() +objects_seen: set[str] = set() def gen_enum_lookup(name: str, From bc5d8b4bc044555b5598604dd400204e1854feaa Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:44 -0400 Subject: [PATCH 09/16] python: upgrade to Python3.12+ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit With Python3.9 EOL and Python3.10 soon to be EOL (October 2026), and with ... no other supported build platform actually using Python 3.11, require the use of Python3.12 or later. Additionally, as part of this upgrade, remove the use of tomllib from mkvenv as it is now standard in the Python stdlib: leaving this transitional code in causes a regression with mypy which becomes confused about the overloaded use of 'tomllib'. Our current minimum requirements as determined by standard repository packages on supported distributions is as follows: distro EOS python3 pip setuptools sphinx wheel Reviewed-by: Daniel P. Berrangé ------------------------------------------------------------------------- centos_stream_9 2026-12-12 3.9.25 21.3.1 53.0.0 3.4.3 0.36.2 centos_stream_9+ 2026-12-12 3.12.13 23.2.1 68.2.2 --- 0.41.2 freebsd -- 3.12.14 23.3.2 63.1.0 9.0.4 0.48.0 ubuntu_24_04 2028-04-23 3.12.3 24.0 68.1.2 7.2.6 0.42.0 centos_stream_10 2030-01-01 3.12.13 23.3.2 69.0.3 7.2.6 0.41.2 alpine_3_21 2026-11-01 3.12.14 24.3.1 70.3.0 8.1.3 0.43.0 debian_13 2028-08-09 3.13.5 25.1.1 78.1.1 8.1.3 0.46.1 fedora_43 2026-12-09 3.14.7 25.1.1 78.1.1 8.2.3 0.45.1 ubuntu_26_04 2031-05-29 3.14.4 25.1.1 78.1.1 8.2.3 0.46.3 fedora_44 2027-06-02 3.14.7 26.0.1 80.10.2 8.2.3 0.45.1 macports -- 3.14.7 26.0.1 80.10.2 9.1.0 0.48.0 alpine_3_22 2027-05-01 3.12.14 25.1.1 80.9.0 8.2.3 0.46.3 alpine_3_23 2027-11-01 3.12.14 25.1.1 80.9.0 8.2.3 0.46.3 openbsd -- 3.14.6 26.2.1 80.9.0 9.1.0 0.48.0 alpine_3_24 2028-06-01 3.14.7 26.1.2 82.0.1 9.1.0 0.47.0 pkgsrc_current -- 3.13.15 26.2.1 84.0.0 9.1.0 0.48.0 CentOS stream 9 note: python3.12, python3.12-pip, python3.12-setuptools and python3.12-wheel are available as optional packages in the standard repository. Sphinx is not available, but can be side-loaded from PyPI using pip3.12. Signed-off-by: John Snow Reviewed-by: Daniel P. Berrangé Message-ID: <20260825215851.1780608-10-jsnow@redhat.com> Signed-off-by: John Snow --- configure | 11 ++++--- python/Makefile | 10 +++---- python/scripts/mkvenv.py | 63 ++++------------------------------------ python/setup.cfg | 17 ++++------- python/tests/minreqs.txt | 41 ++++++++++++-------------- pythondeps.toml | 9 ++---- 6 files changed, 43 insertions(+), 108 deletions(-) diff --git a/configure b/configure index 56158cd95f..46cbcc085b 100755 --- a/configure +++ b/configure @@ -503,17 +503,16 @@ if test -n "$linux_arch" && ! test -d "$source_path/linux-headers/asm-$linux_arc fi check_py_version() { - # We require python >= 3.9. + # We require python >= 3.12. # NB: a True python conditional creates a non-zero return code (Failure) - "$1" -c 'import sys; sys.exit(sys.version_info < (3,9))' + "$1" -c 'import sys; sys.exit(sys.version_info < (3,12))' } first_python= if test -z "${PYTHON}"; then # A bare 'python' is traditionally python 2.x, but some distros # have it as python 3.x, so check in both places. - for binary in python3 python python3.14 python3.13 python3.12 \ - python3.11 python3.10 python3.9 ; do + for binary in python3 python python3.14 python3.13 python3.12; do if has "$binary"; then python=$(command -v "$binary") if check_py_version "$python"; then @@ -902,7 +901,7 @@ then # If first_python is set, there was a binary somewhere even though # it was not suitable. Use it for the error message. if test -n "$first_python"; then - error_exit "Cannot use '$first_python', Python >= 3.9 is required." \ + error_exit "Cannot use '$first_python', Python >= 3.12 is required." \ "Use --python=/path/to/python to specify a supported Python." else error_exit "Python not found. Use --python=/path/to/python" @@ -910,7 +909,7 @@ then fi if ! check_py_version "$python"; then - error_exit "Cannot use '$python', Python >= 3.9 is required." \ + error_exit "Cannot use '$python', Python >= 3.12 is required." \ "Use --python=/path/to/python to specify a supported Python." \ "Maybe try:" \ " CentOS: dnf install python3.12" diff --git a/python/Makefile b/python/Makefile index 42994d3961..7868a48a23 100644 --- a/python/Makefile +++ b/python/Makefile @@ -9,14 +9,14 @@ help: @echo "make check-minreqs:" @echo " Run tests in the minreqs virtual environment." @echo " These tests use the oldest dependencies." - @echo " Requires: Python 3.9" - @echo " Hint (Fedora): 'sudo dnf install python3.9'" + @echo " Requires: Python 3.12" + @echo " Hint (Fedora): 'sudo dnf install python3.12'" @echo "" @echo "make check-tox:" @echo " Run tests against multiple python versions." @echo " These tests use the newest dependencies." - @echo " Requires: Python 3.9 - 3.11, and tox." - @echo " Hint (Fedora): 'sudo dnf install python3-tox python3.11'" + @echo " Requires: Python 3.12 - 3.14, and tox." + @echo " Hint (Fedora): 'sudo dnf install python3-tox python3.14'" @echo " The variable QEMU_TOX_EXTRA_ARGS can be use to pass extra" @echo " arguments to tox". @echo "" @@ -59,7 +59,7 @@ PIP_INSTALL = pip install --disable-pip-version-check min-venv: $(QEMU_MINVENV_DIR) $(QEMU_MINVENV_DIR)/bin/activate $(QEMU_MINVENV_DIR) $(QEMU_MINVENV_DIR)/bin/activate: setup.cfg tests/minreqs.txt @echo "VENV $(QEMU_MINVENV_DIR)" - @python3.9 -m venv $(QEMU_MINVENV_DIR) + @python3.12 -m venv $(QEMU_MINVENV_DIR) @( \ echo "ACTIVATE $(QEMU_MINVENV_DIR)"; \ . $(QEMU_MINVENV_DIR)/bin/activate; \ diff --git a/python/scripts/mkvenv.py b/python/scripts/mkvenv.py index 8ed6a35450..e3954bb6d6 100644 --- a/python/scripts/mkvenv.py +++ b/python/scripts/mkvenv.py @@ -75,6 +75,7 @@ import site import subprocess import sys import sysconfig +import tomllib from types import SimpleNamespace from typing import ( Any, @@ -134,20 +135,6 @@ except ImportError: HAVE_PACKAGING_VERSION = _import_ok -# Try to load tomllib, with a fallback to tomli. -# HAVE_TOMLLIB is checked below, just-in-time, so that mkvenv does not fail -# outside the venv or before a potential call to ensurepip in checkpip(). -_import_ok = True -try: - import tomllib -except ImportError: - try: - import tomli as tomllib - except ImportError: - _import_ok = False - -HAVE_TOMLLIB = _import_ok - # Do not add any mandatory dependencies from outside the stdlib: # This script *must* be usable standalone! @@ -261,36 +248,6 @@ class QemuEnvBuilder(venv.EnvBuilder): return sysconfig.get_path("purelib") return None - @staticmethod - def compute_venv_libpath(context: SimpleNamespace) -> str: - """ - Compatibility wrapper for context.lib_path for Python < 3.12 - """ - # Python 3.12+, not strictly necessary because it's documented - # to be the same as 3.10 code below: - if sys.version_info >= (3, 12): - return context.lib_path - - # Python 3.10+ - if "venv" in sysconfig.get_scheme_names(): - lib_path = sysconfig.get_path( - "purelib", scheme="venv", vars={"base": context.env_dir} - ) - assert lib_path is not None - return lib_path - - # For Python <= 3.9 we need to hardcode this. Fortunately the - # code below was the same in Python 3.6-3.10, so there is only - # one case. - if sys.platform == "win32": - return os.path.join(context.env_dir, "Lib", "site-packages") - return os.path.join( - context.env_dir, - "lib", - "python%d.%d" % sys.version_info[:2], - "site-packages", - ) - def ensure_directories(self, env_dir: DirType) -> SimpleNamespace: logger.debug("ensure_directories(env_dir=%s)", env_dir) self._context = super().ensure_directories(env_dir) @@ -313,7 +270,8 @@ class QemuEnvBuilder(venv.EnvBuilder): assert parent_libpath is not None logger.debug("parent_libpath: %s", parent_libpath) - our_libpath = self.compute_venv_libpath(context) + assert isinstance(context.lib_path, str) + our_libpath = context.lib_path logger.debug("our_libpath: %s", our_libpath) pth_file = os.path.join(our_libpath, "nested.pth") @@ -810,19 +768,8 @@ def _do_ensure( def _parse_groups(file: str) -> Dict[str, Dict[str, Any]]: - if not HAVE_TOMLLIB: - if sys.version_info < (3, 11): - raise Ouch("found no usable tomli, please install it") - - raise Ouch( - "Python >=3.11 does not have tomllib... what have you done!?" - ) - - # Use loads() to support both tomli v1.2.x (Ubuntu 22.04, - # Debian bullseye-backports) and v2.0.x - with open(file, "r", encoding="ascii") as depfile: - contents = depfile.read() - return tomllib.loads(contents) # type: ignore + with open(file, "rb") as depfile: + return tomllib.load(depfile) def ensure_group( diff --git a/python/setup.cfg b/python/setup.cfg index ad4121a58d..8f62b7c1cd 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -14,16 +14,13 @@ classifiers = Natural Language :: English Operating System :: OS Independent Programming Language :: Python :: 3 :: Only - Programming Language :: Python :: 3.9 - Programming Language :: Python :: 3.10 - Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.13 Programming Language :: Python :: 3.14 Typing :: Typed [options] -python_requires = >= 3.9 +python_requires = >= 3.12 packages = qemu.machine qemu.utils @@ -39,12 +36,10 @@ devel = distlib >= 0.3.6 flake8 >= 5.0.4 fusepy >= 2.0.4 - isort >= 5.6.0 - # Max ver is temporary until we drop 3.9 - mypy >= 1.4.0, <2.0.0 + isort >= 5.11.3 + mypy >= 1.4.0 pylint >= 2.17.3 - pylint != 3.2.4; python_version<"3.9" - pytest >= 6.0.2 + pytest >= 6.2.4 tox >= 3.18.0 sphinx >= 3.4.3 @@ -69,7 +64,7 @@ exclude = __pycache__, [mypy] strict = True -python_version = 3.9 +python_version = 3.12 namespace_packages = True warn_unused_ignores = False @@ -164,7 +159,7 @@ multi_line_output=3 # of python available on your system to run this test. [tox:tox] -envlist = py39, py310, py311, py312, py313, py314 +envlist = py312, py313, py314 skip_missing_interpreters = true [testenv] diff --git a/python/tests/minreqs.txt b/python/tests/minreqs.txt index 05c3bdb89f..85cfa08cf7 100644 --- a/python/tests/minreqs.txt +++ b/python/tests/minreqs.txt @@ -1,5 +1,5 @@ # This file lists the ***oldest possible dependencies*** needed to run -# "make check" successfully under ***Python 3.9***. It is used primarily +# "make check" successfully under ***Python 3.12***. It is used primarily # by GitLab CI to ensure that our stated minimum versions in setup.cfg # are truthful and regularly validated. # @@ -11,18 +11,11 @@ # When adding new dependencies, pin the very oldest non-yanked version # on PyPI that allows the test suite to pass. -# For some reason, the presence of packaging==14.0 below requires us to -# also pin setuptools to version 70 or below. Otherwise, the -# installation of the QEMU package itself fails, failing to find -# setuptools. -setuptools<=70 -wheel==0.34.2 - # Dependencies for qapidoc/qapi_domain et al sphinx==3.4.3 # Dependencies for qemu.machine -qemu.qmp==0.0.5 +qemu.qmp==0.0.6 # Dependencies for mkvenv distlib==0.3.6 @@ -31,32 +24,28 @@ distlib==0.3.6 fusepy==2.0.4 # Test-runners, utilities, etc. -pytest==6.0.2 +pytest==6.2.4 # Linters -flake8==5.0.4 -isort==5.6.0 +flake8==6.1.0 +isort==5.11.3 mypy==1.4.0 -pylint==2.17.3 +pylint==3.0.0 # Transitive flake8 dependencies mccabe==0.7.0 -pycodestyle==2.9.1 -pyflakes==2.5.0 +pycodestyle==2.11.0 +pyflakes==3.1.0 # Transitive mypy dependencies mypy-extensions==1.0.0 -tomli==1.1.0 typing-extensions==4.7.1 # Transitive pylint dependencies -astroid==2.15.4 -dill==0.2 -lazy-object-proxy==1.4.0 +astroid==3.0.0 +dill==0.3.7 platformdirs==2.2.0 -toml==0.10.0 tomlkit==0.10.1 -wrapt==1.14.0 # Transitive sphinx dependencies Jinja2==2.7 @@ -66,7 +55,8 @@ babel==1.3 docutils==0.12 imagesize==0.5.0 packaging==14.0 -pytz==2011b0 +Pygments==2.0 +pytz==2014.9 requests==2.5.0 snowballstemmer==1.1 sphinxcontrib-applehelp==1.0.0 @@ -75,3 +65,10 @@ sphinxcontrib-htmlhelp==1.0.0 sphinxcontrib-jsmath==1.0.0 sphinxcontrib-qthelp==1.0.0 sphinxcontrib-serializinghtml==1.0.0 + +# Transitive pytest dependencies +attrs==19.2.0 +iniconfig==1.0.0 +pluggy==0.13 +py==1.11.0 +toml==0.10.0 diff --git a/pythondeps.toml b/pythondeps.toml index 061f0cff0c..b1879c1a4d 100644 --- a/pythondeps.toml +++ b/pythondeps.toml @@ -38,14 +38,11 @@ sphinx_rtd_theme = { accepted = ">=0.5", installed = "1.2.2" } [tooling] "qemu.qmp" = { accepted = ">=0.0.5", installed = "0.0.6" } "qemu" = { path = "python/" } -# NB: The following dependencies should be a little bit more modern than -# the versions listed here, but we are still using Debian 11 for several -# GitLab CI tests, so we are further restricted. -"setuptools" = { accepted = ">=44.1.1" } -"wheel" = { accepted = ">=0.34.2" } +"setuptools" = { accepted = ">=63.1.0" } +"wheel" = { accepted = ">=0.41.2" } # pip should be guaranteed by mkvenv, this is merely a sanity check for # which version we are counting on being present. -"pip" = { accepted = ">=20.3.4" } +"pip" = { accepted = ">=23.2.1" } # This test group is for functional tests, and can include dependencies # fetched from PyPI. From 1e5e440e96529fef059b02ac466c23a97a50a9bf Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:45 -0400 Subject: [PATCH 10/16] python: fix license configuration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit License trove identifiers were deprecated in favor of SPDX identifiers, correct this to stop some whining from various python tooling. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Message-ID: <20260825215851.1780608-11-jsnow@redhat.com> Signed-off-by: John Snow --- python/setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/setup.cfg b/python/setup.cfg index 8f62b7c1cd..a22abba6c3 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -8,9 +8,9 @@ download_url = https://www.qemu.org/download/ description = QEMU Python Build, Debug and SDK tooling. long_description = file:PACKAGE.rst long_description_content_type = text/x-rst +license = GPL-2.0-or-later classifiers = Development Status :: 3 - Alpha - License :: OSI Approved :: GNU General Public License v2 (GPLv2) Natural Language :: English Operating System :: OS Independent Programming Language :: Python :: 3 :: Only From 151a86b2a60d4f8212347b00b5b3aec1a3cc6d03 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:46 -0400 Subject: [PATCH 11/16] python: allow mypy to run as the current python version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Currently, we instruct mypy to run assuming a specific version of python. Lift this restriction so that under tox tests, it will always run assuming the current running version. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Reviewed-by: Philippe Mathieu-Daudé Message-ID: <20260825215851.1780608-12-jsnow@redhat.com> Signed-off-by: John Snow --- python/setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/python/setup.cfg b/python/setup.cfg index a22abba6c3..f866f65957 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -64,7 +64,6 @@ exclude = __pycache__, [mypy] strict = True -python_version = 3.12 namespace_packages = True warn_unused_ignores = False From 37826ad1db4d57a5240dfec551da348979302188 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:47 -0400 Subject: [PATCH 12/16] python: remove distutils workarounds MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit These are no longer necessary now that we are using Python3.12+. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Message-ID: <20260825215851.1780608-13-jsnow@redhat.com> Signed-off-by: John Snow --- python/tests/linters.py | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/python/tests/linters.py b/python/tests/linters.py index 82b88aebb2..dd89fb00ba 100644 --- a/python/tests/linters.py +++ b/python/tests/linters.py @@ -83,23 +83,13 @@ class TestLinters: cwd="../tests/qemu-iotests/", ) - # Setuptools v60 introduced the SETUPTOOLS_USE_DISTUTILS=stdlib - # workaround; stdlib distutils was fully removed in Python - # 3.12+. Once we are on >=3.12+ exclusively, this workaround can be - # dropped safely. Until then, it is needed for some versions on - # Fedora/Debian distributions which relied upon distro-patched - # setuptools present in CPython, but not within setuptools itself. - def test_pylint_pkg(self): - os.environ["SETUPTOOLS_USE_DISTUTILS"] = "stdlib" check_call([sys.executable, "-m", "pylint", "qemu/"]) def test_pylint_scripts(self): - os.environ["SETUPTOOLS_USE_DISTUTILS"] = "stdlib" check_call([sys.executable, "-m", "pylint", "scripts/"]) def test_pylint_qapi(self): - os.environ["SETUPTOOLS_USE_DISTUTILS"] = "stdlib" check_call( [ sys.executable, @@ -113,7 +103,6 @@ class TestLinters: ) def test_pylint_iotests(self): - os.environ["SETUPTOOLS_USE_DISTUTILS"] = "stdlib" check_call( [sys.executable, "-m", "linters", "--pylint"], cwd="../tests/qemu-iotests/", From 4a7132fa17a41248189aa5d8cfa16779f795bb23 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:48 -0400 Subject: [PATCH 13/16] python: remove stale setup.cfg options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit With the recent version bumps, we no longer need these directives. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Message-ID: <20260825215851.1780608-14-jsnow@redhat.com> Signed-off-by: John Snow --- python/setup.cfg | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/python/setup.cfg b/python/setup.cfg index f866f65957..ebb4230899 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -65,7 +65,6 @@ exclude = __pycache__, [mypy] strict = True namespace_packages = True -warn_unused_ignores = False [mypy-qemu.utils.qom_fuse] # fusepy has no type stubs: @@ -76,12 +75,6 @@ allow_subclassing_any = True [mypy-fuse] ignore_missing_imports = True -[mypy-tomli] -ignore_missing_imports = True - -[mypy-tomllib] -ignore_missing_imports = True - [mypy-distlib] ignore_missing_imports = True @@ -91,12 +84,6 @@ ignore_missing_imports = True [mypy-distlib.version] ignore_missing_imports = True -[mypy-pip._vendor.distlib] -ignore_missing_imports = True - -[mypy-pip._vendor.distlib.scripts] -ignore_missing_imports = True - [mypy-pip._vendor.distlib.version] ignore_missing_imports = True From f6ebad194c57b81e4e951e93237c5c70e771ec49 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:49 -0400 Subject: [PATCH 14/16] sphinx: require sphinx 7.2.6 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Make the extraordinary leap from Sphinx 3.4.3 to Sphinx 7.2.6. Simplifications and cleanup will follow in subsequent patches. Note that CentOS Stream 9 only ships a version of Sphinx that runs on Python 3.9, so regardless of the version of Sphinx we require, if we require Python 3.10+, CentOS Stream 9 will be unable to build QEMU documentation in an isolated offline build environment. CentOS Stream 9 continues to be able to build documentation so long as PyPI access is permitted during configure, or if the requisite PyPI packages are installed prior to configure time. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Message-ID: <20260825215851.1780608-15-jsnow@redhat.com> Signed-off-by: John Snow --- docs/conf.py | 4 ++-- docs/requirements.txt | 2 +- python/setup.cfg | 2 +- python/tests/minreqs.txt | 29 ++++++++++++++++------------- pythondeps.toml | 4 ++-- 5 files changed, 22 insertions(+), 19 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 7e35d2158d..cded047b53 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,9 +51,9 @@ sys.path.insert(0, os.path.join(qemu_docdir, "../scripts")) # If your documentation needs a minimal Sphinx version, state it here. # -# 3.4.3 is the oldest version of Sphinx that ships on a platform we +# 7.2.6 is the oldest version of Sphinx that ships on a platform we # pledge build support for. -needs_sphinx = '3.4.3' +needs_sphinx = '7.2.6' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/docs/requirements.txt b/docs/requirements.txt index 87f7afcb2e..c10c4cf7c9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ # Used by readthedocs.io # Should be in sync with the "installed" key of pythondeps.toml -sphinx==6.2.1 +sphinx==7.2.6 sphinx_rtd_theme==1.2.2 diff --git a/python/setup.cfg b/python/setup.cfg index ebb4230899..927f72a46f 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -41,7 +41,7 @@ devel = pylint >= 2.17.3 pytest >= 6.2.4 tox >= 3.18.0 - sphinx >= 3.4.3 + sphinx >= 7.2.6 # Provides qom-fuse functionality fuse = diff --git a/python/tests/minreqs.txt b/python/tests/minreqs.txt index 85cfa08cf7..7154ad4004 100644 --- a/python/tests/minreqs.txt +++ b/python/tests/minreqs.txt @@ -12,7 +12,7 @@ # on PyPI that allows the test suite to pass. # Dependencies for qapidoc/qapi_domain et al -sphinx==3.4.3 +sphinx==7.2.6 # Dependencies for qemu.machine qemu.qmp==0.0.6 @@ -48,23 +48,26 @@ platformdirs==2.2.0 tomlkit==0.10.1 # Transitive sphinx dependencies -Jinja2==2.7 -MarkupSafe==1.1.0 alabaster==0.7.1 -babel==1.3 -docutils==0.12 -imagesize==0.5.0 -packaging==14.0 -Pygments==2.0 -pytz==2014.9 -requests==2.5.0 -snowballstemmer==1.1 +babel==2.9 +certifi==2023.5.7 +charset-normalizer==2.0.0 +docutils==0.18.1 +idna==2.5 +imagesize==1.3 +Jinja2==3.0.0 +MarkupSafe==2.0 +packaging==21.0 +Pygments==2.14 +requests==2.25.0 +snowballstemmer==2.0 sphinxcontrib-applehelp==1.0.0 sphinxcontrib-devhelp==1.0.0 -sphinxcontrib-htmlhelp==1.0.0 +sphinxcontrib-htmlhelp==2.0.0 sphinxcontrib-jsmath==1.0.0 sphinxcontrib-qthelp==1.0.0 -sphinxcontrib-serializinghtml==1.0.0 +sphinxcontrib-serializinghtml==1.1.9 +urllib3==1.26 # Transitive pytest dependencies attrs==19.2.0 diff --git a/pythondeps.toml b/pythondeps.toml index b1879c1a4d..f0f3af915a 100644 --- a/pythondeps.toml +++ b/pythondeps.toml @@ -28,8 +28,8 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" } [docs] # Please keep the installed versions in sync with docs/requirements.txt -sphinx = { accepted = ">=3.4.3", installed = "6.2.1", canary = "sphinx-build" } -sphinx_rtd_theme = { accepted = ">=0.5", installed = "1.2.2" } +sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" } +sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" } # This test group is for dependencies required to run various tooling # and tests that should always be installed at configure time. It should From 01657b6932909baef99202efa54815777d16a5b8 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:50 -0400 Subject: [PATCH 15/16] sphinx: drop fakedbusdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Now that we rely on a sufficiently modern Sphinx, we no longer need a stub doc for dbus. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Message-ID: <20260825215851.1780608-16-jsnow@redhat.com> Signed-off-by: John Snow --- docs/conf.py | 7 +------ docs/interop/dbus-display.rst | 14 +------------- docs/interop/dbus-vmstate.rst | 14 +------------- docs/interop/dbus-vnc.rst | 14 +------------- docs/sphinx/fakedbusdoc.py | 30 ------------------------------ 5 files changed, 4 insertions(+), 75 deletions(-) delete mode 100644 docs/sphinx/fakedbusdoc.py diff --git a/docs/conf.py b/docs/conf.py index cded047b53..914bae67d9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,6 +59,7 @@ needs_sphinx = '7.2.6' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'dbusdoc', 'depfile', 'hxtool', 'kerneldoc', @@ -67,12 +68,6 @@ extensions = [ 'qmp_lexer', ] -if sphinx.version_info[:3] > (4, 0, 0): - tags.add('sphinx4') - extensions += ['dbusdoc'] -else: - extensions += ['fakedbusdoc'] - # Add any paths that contain templates here, relative to this directory. templates_path = [os.path.join(qemu_docdir, '_templates')] diff --git a/docs/interop/dbus-display.rst b/docs/interop/dbus-display.rst index 87648e91dc..c87a04c969 100644 --- a/docs/interop/dbus-display.rst +++ b/docs/interop/dbus-display.rst @@ -18,16 +18,4 @@ QEMU also implements the standard interfaces, such as :local: :depth: 1 -.. only:: sphinx4 - - .. dbus-doc:: ui/dbus-display1.xml - -.. only:: not sphinx4 - - .. warning:: - Sphinx 4 is required to build D-Bus documentation. - - This is the content of ``ui/dbus-display1.xml``: - - .. literalinclude:: ../../ui/dbus-display1.xml - :language: xml +.. dbus-doc:: ui/dbus-display1.xml diff --git a/docs/interop/dbus-vmstate.rst b/docs/interop/dbus-vmstate.rst index 5fb3f279e2..5f8c6d125d 100644 --- a/docs/interop/dbus-vmstate.rst +++ b/docs/interop/dbus-vmstate.rst @@ -23,16 +23,4 @@ dbus-vmstate object can be configured with the expected list of helpers by setting its ``id-list`` property, with a comma-separated ``Id`` list. -.. only:: sphinx4 - - .. dbus-doc:: backends/dbus-vmstate1.xml - -.. only:: not sphinx4 - - .. warning:: - Sphinx 4 is required to build D-Bus documentation. - - This is the content of ``backends/dbus-vmstate1.xml``: - - .. literalinclude:: ../../backends/dbus-vmstate1.xml - :language: xml +.. dbus-doc:: backends/dbus-vmstate1.xml diff --git a/docs/interop/dbus-vnc.rst b/docs/interop/dbus-vnc.rst index d2b77978f6..5ea4fd5718 100644 --- a/docs/interop/dbus-vnc.rst +++ b/docs/interop/dbus-vnc.rst @@ -11,16 +11,4 @@ Objects are exported under ``/org/qemu/Vnc1/``. :local: :depth: 1 -.. only:: sphinx4 - - .. dbus-doc:: tools/qemu-vnc/qemu-vnc1.xml - -.. only:: not sphinx4 - - .. warning:: - Sphinx 4 is required to build D-Bus documentation. - - This is the content of ``tools/qemu-vnc/qemu-vnc1.xml``: - - .. literalinclude:: ../../tools/qemu-vnc/qemu-vnc1.xml - :language: xml +.. dbus-doc:: tools/qemu-vnc/qemu-vnc1.xml diff --git a/docs/sphinx/fakedbusdoc.py b/docs/sphinx/fakedbusdoc.py deleted file mode 100644 index 2d2e6ef640..0000000000 --- a/docs/sphinx/fakedbusdoc.py +++ /dev/null @@ -1,30 +0,0 @@ -# D-Bus XML documentation extension, compatibility gunk for -"""dbus-doc is a Sphinx extension that provides documentation from D-Bus XML.""" - -from docutils.parsers.rst import Directive -from sphinx.application import Sphinx -from typing import Any, Dict - - -class FakeDBusDocDirective(Directive): - has_content = True - required_arguments = 1 - - def run(self): - return [] - - -def setup(app: Sphinx) -> Dict[str, Any]: - """Register a fake dbus-doc directive with Sphinx""" - app.add_directive("dbus-doc", FakeDBusDocDirective) - - return dict( - parallel_read_safe = True, - parallel_write_safe = True - ) From 4061c0e95c6e2736926ab8723606cddf582f58e6 Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 25 Aug 2026 17:58:51 -0400 Subject: [PATCH 16/16] sphinx: drop qapidoc back-compat overboiled spaghetti dinner MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Drop the disgusting amount of hacks required to keep qapidoc working on older Sphinx versions, enjoying the cutting edge technology of 2023. This felt like an achievement to have written, and equally feels an achievement to have deleted. A note on the content_node parameter: Sphinx has been gradually implementing typing support and renaming parameters to be consistent. As a result of losing our intermediate compatibility shim, mypy and pylint now check directly against the Sphinx version. So, alongside removing compat gunk, we need to fix up some parameter naming for the Sphinx upgrade, too. Signed-off-by: John Snow Reviewed-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-ID: <20260825215851.1780608-17-jsnow@redhat.com> Signed-off-by: John Snow --- docs/sphinx/compat.py | 230 ------------------------------------- docs/sphinx/qapi_domain.py | 53 +++++---- 2 files changed, 28 insertions(+), 255 deletions(-) delete mode 100644 docs/sphinx/compat.py diff --git a/docs/sphinx/compat.py b/docs/sphinx/compat.py deleted file mode 100644 index 9cf7fe006e..0000000000 --- a/docs/sphinx/compat.py +++ /dev/null @@ -1,230 +0,0 @@ -""" -Sphinx cross-version compatibility goop -""" - -import re -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Optional, - Type, -) - -from docutils import nodes -from docutils.nodes import Element, Node, Text -from docutils.statemachine import StringList - -import sphinx -from sphinx import addnodes, util -from sphinx.directives import ObjectDescription -from sphinx.environment import BuildEnvironment -from sphinx.roles import XRefRole -from sphinx.util import docfields -from sphinx.util.docutils import ( - ReferenceRole, - SphinxDirective, - switch_source_input, -) -from sphinx.util.typing import TextlikeNode - - -MAKE_XREF_WORKAROUND = sphinx.version_info[:3] < (4, 1, 0) - - -SpaceNode: Callable[[str], Node] -KeywordNode: Callable[[str, str], Node] - -if sphinx.version_info[:3] >= (4, 0, 0): - SpaceNode = addnodes.desc_sig_space - KeywordNode = addnodes.desc_sig_keyword -else: - SpaceNode = Text - KeywordNode = addnodes.desc_annotation - - -def nested_parse_with_titles( - directive: SphinxDirective, content_node: Element -) -> None: - """ - This helper preserves error parsing context across sphinx versions. - """ - - # necessary so that the child nodes get the right source/line set - content_node.document = directive.state.document - - try: - # Modern sphinx (6.2.0+) supports proper offsetting for - # nested parse error context management - util.nodes.nested_parse_with_titles( - directive.state, - directive.content, - content_node, - content_offset=directive.content_offset, - ) - except TypeError: - # No content_offset argument. Fall back to SSI method. - with switch_source_input(directive.state, directive.content): - util.nodes.nested_parse_with_titles( - directive.state, directive.content, content_node - ) - - -# ########################################### -# xref compatibility hacks for Sphinx < 4.1 # -# ########################################### - -# When we require >= Sphinx 4.1, the following function and the -# subsequent 3 compatibility classes can be removed. Anywhere in -# qapi_domain that uses one of these Compat* types can be switched to -# using the garden-variety lib-provided classes with no trickery. - - -def _compat_make_xref( # pylint: disable=unused-argument - self: sphinx.util.docfields.Field, - rolename: str, - domain: str, - target: str, - innernode: Type[TextlikeNode] = addnodes.literal_emphasis, - contnode: Optional[Node] = None, - env: Optional[BuildEnvironment] = None, - inliner: Any = None, - location: Any = None, -) -> Node: - """ - Compatibility workaround for Sphinx versions prior to 4.1.0. - - Older sphinx versions do not use the domain's XRefRole for parsing - and formatting cross-references, so we need to perform this magick - ourselves to avoid needing to write the parser/formatter in two - separate places. - - This workaround isn't brick-for-brick compatible with modern Sphinx - versions, because we do not have access to the parent directive's - state during this parsing like we do in more modern versions. - - It's no worse than what pre-Sphinx 4.1.0 does, so... oh well! - """ - - # Yes, this function is gross. Pre-4.1 support is a miracle. - # pylint: disable=too-many-locals - - assert env - # Note: Sphinx's own code ignores the type warning here, too. - if not rolename: - return contnode or innernode(target, target) # type: ignore[call-arg] - - # Get the role instance, but don't *execute it* - we lack the - # correct state to do so. Instead, we'll just use its public - # methods to do our reference formatting, and emulate the rest. - role = env.get_domain(domain).roles[rolename] - assert isinstance(role, XRefRole) - - # XRefRole features not supported by this compatibility shim; - # these were not supported in Sphinx 3.x either, so nothing of - # value is really lost. - assert not target.startswith("!") - assert not re.match(ReferenceRole.explicit_title_re, target) - assert not role.lowercase - assert not role.fix_parens - - # Code below based mostly on sphinx.roles.XRefRole; run() and - # create_xref_node() - options = { - "refdoc": env.docname, - "refdomain": domain, - "reftype": rolename, - "refexplicit": False, - "refwarn": role.warn_dangling, - } - refnode = role.nodeclass(target, **options) - title, target = role.process_link(env, refnode, False, target, target) - refnode["reftarget"] = target - classes = ["xref", domain, f"{domain}-{rolename}"] - refnode += role.innernodeclass(target, title, classes=classes) - - # This is the very gross part of the hack. Normally, - # result_nodes takes a document object to which we would pass - # self.inliner.document. Prior to Sphinx 4.1, we don't *have* an - # inliner to pass, so we have nothing to pass here. However, the - # actual implementation of role.result_nodes in this case - # doesn't actually use that argument, so this winds up being - # ... fine. Rest easy at night knowing this code only runs under - # old versions of Sphinx, so at least it won't change in the - # future on us and lead to surprising new failures. - # Gross, I know. - result_nodes, _messages = role.result_nodes( - None, # type: ignore - env, - refnode, - is_ref=True, - ) - return nodes.inline(target, "", *result_nodes) - - -class CompatField(docfields.Field): - if MAKE_XREF_WORKAROUND: - make_xref = _compat_make_xref - - -class CompatGroupedField(docfields.GroupedField): - if MAKE_XREF_WORKAROUND: - make_xref = _compat_make_xref - - -class CompatTypedField(docfields.TypedField): - if MAKE_XREF_WORKAROUND: - make_xref = _compat_make_xref - - -# ################################################################ -# Nested parsing error location fix for Sphinx 5.3.0 < x < 6.2.0 # -# ################################################################ - -# When we require Sphinx 4.x, the TYPE_CHECKING hack where we avoid -# subscripting ObjectDescription at runtime can be removed in favor of -# just always subscripting the class. - -# When we require Sphinx > 6.2.0, the rest of this compatibility hack -# can be dropped and QAPIObject can just inherit directly from -# ObjectDescription[Signature]. - -SOURCE_LOCATION_FIX = (5, 3, 0) <= sphinx.version_info[:3] < (6, 2, 0) - -Signature = str - - -if TYPE_CHECKING: - _BaseClass = ObjectDescription[Signature] -else: - _BaseClass = ObjectDescription - - -class ParserFix(_BaseClass): - - _temp_content: StringList - _temp_offset: int - _temp_node: Optional[addnodes.desc_content] - - def before_content(self) -> None: - # Work around a sphinx bug and parse the content ourselves. - self._temp_content = self.content - self._temp_offset = self.content_offset - self._temp_node = None - - if SOURCE_LOCATION_FIX: - self._temp_node = addnodes.desc_content() - self.state.nested_parse( - self.content, self.content_offset, self._temp_node - ) - # Sphinx will try to parse the content block itself, - # Give it nothingness to parse instead. - self.content = StringList() - self.content_offset = 0 - - def transform_content(self, content_node: addnodes.desc_content) -> None: - # Sphinx workaround: Inject our parsed content and restore state. - if self._temp_node: - content_node += self._temp_node.children - self.content = self._temp_content - self.content_offset = self._temp_offset diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py index f561dc465f..159857113a 100644 --- a/docs/sphinx/qapi_domain.py +++ b/docs/sphinx/qapi_domain.py @@ -30,20 +30,10 @@ from sphinx.domains import ( ) from sphinx.locale import _, __ from sphinx.roles import XRefRole -from sphinx.util import logging +from sphinx.util import docfields, logging from sphinx.util.docutils import SphinxDirective from sphinx.util.nodes import make_id, make_refnode -from compat import ( - CompatField, - CompatGroupedField, - CompatTypedField, - KeywordNode, - ParserFix, - Signature, - SpaceNode, -) - if TYPE_CHECKING: from typing import ( @@ -157,7 +147,10 @@ class QAPIXRefRole(XRefRole): return results, [] -class QAPIDescription(ParserFix): +Signature = str + + +class QAPIDescription(ObjectDescription[Signature]): """ Generic QAPI description. @@ -315,7 +308,7 @@ class QAPIObject(QAPIDescription): doc_field_types = [ # :feat name: descr - CompatGroupedField( + docfields.GroupedField( "feature", label=_("Features"), names=("feat",), @@ -327,8 +320,8 @@ class QAPIObject(QAPIDescription): """Return a prefix to put before the object name in the signature.""" assert self.objtype return [ - KeywordNode("", self.objtype.title()), - SpaceNode(" "), + addnodes.desc_sig_keyword("", self.objtype.title()), + addnodes.desc_sig_space(" "), ] def get_signature_suffix(self) -> List[nodes.Node]: @@ -337,7 +330,7 @@ class QAPIObject(QAPIDescription): if "since" in self.options: ret += [ - SpaceNode(" "), + addnodes.desc_sig_space(" "), addnodes.desc_sig_element( "", f"(Since: {self.options['since']})" ), @@ -376,7 +369,7 @@ class QAPIObject(QAPIDescription): return sig - def _add_infopips(self, contentnode: addnodes.desc_content) -> None: + def _add_infopips(self, content_node: addnodes.desc_content) -> None: # Add various eye-catches and things that go below the signature # bar, but precede the user-defined content. infopips = nodes.container() @@ -420,7 +413,7 @@ class QAPIObject(QAPIDescription): ) if infopips.children: - contentnode.insert(0, infopips) + content_node.insert(0, infopips) def _validate_field(self, field: nodes.field) -> None: """Validate field lists in this QAPI Object Description.""" @@ -470,7 +463,17 @@ class QAPIObject(QAPIDescription): ) logger.warning(msg, location=field) - def transform_content(self, content_node: addnodes.desc_content) -> None: + def transform_content( + self, + # Sphinx changed the name of the content_node parameter + # sometime after Sphinx 7.2.6, so no matter which name we + # choose, either our minimum tests or our bleeding edge tests + # will complain about the parameter rename. Use the eventual + # name and silence the error for our minreq tests. + # + # pylint: disable=arguments-renamed + content_node: addnodes.desc_content + ) -> None: # This hook runs after before_content and the nested parse, but # before the DocFieldTransformer is executed. super().transform_content(content_node) @@ -485,7 +488,7 @@ class QAPIObject(QAPIDescription): self._validate_field(field) -class SpecialTypedField(CompatTypedField): +class SpecialTypedField(docfields.TypedField): def make_field(self, *args: Any, **kwargs: Any) -> nodes.field: ret = super().make_field(*args, **kwargs) @@ -518,14 +521,14 @@ class QAPICommand(QAPIObject): can_collapse=False, ), # :error: descr - CompatField( + docfields.Field( "error", label=_("Errors"), names=("error", "errors"), has_arg=False, ), # :return TypeName: descr - CompatGroupedField( + docfields.GroupedField( "returnvalue", label=_("Return"), rolename="type", @@ -533,7 +536,7 @@ class QAPICommand(QAPIObject): can_collapse=True, ), # :return-nodesc: TypeName - CompatField( + docfields.Field( "returnvalue", label=_("Return"), names=("return-nodesc",), @@ -551,7 +554,7 @@ class QAPIEnum(QAPIObject): doc_field_types.extend( [ # :value name: descr - CompatGroupedField( + docfields.GroupedField( "value", label=_("Values"), names=("value",), @@ -568,7 +571,7 @@ class QAPIAlternate(QAPIObject): doc_field_types.extend( [ # :alt type name: descr - CompatTypedField( + docfields.TypedField( "alternative", label=_("Alternatives"), names=("alt",),