setuptools3: check for a PEP517 build system selection

Some recipes use setuptools3 but should be using a PEP517-compliant
backend, be it the setuptools itself via python_setuptools_build_meta or
an alternative backend such as flit/hatch/poetry.

As we can't currently assume Python 3.11 on the build host we need to
parse the pyproject.toml manually, but this should be sufficient for the
limited parsing needed.

This task emits a QA error if a build backend is set, and can be ignored
by using INSANE_SKIP if needed.

[ YOCTO #14736 ]

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/meta/classes-recipe/setuptools3.bbclass b/meta/classes-recipe/setuptools3.bbclass
index d71a08953980663298c74ecf149534c42395a2a0..64a78e9a367eb88e98b32e1f77b8824f16bd0f8c 100644 (file)
--- a/meta/classes-recipe/setuptools3.bbclass
+++ b/meta/classes-recipe/setuptools3.bbclass
@@ -12,6 +12,20 @@ SETUPTOOLS_BUILD_ARGS ?= ""
 
 SETUPTOOLS_SETUP_PATH ?= "${S}"
 
+python do_check_backend() {
+    import re
+    filename = d.expand("${SETUPTOOLS_SETUP_PATH}/pyproject.toml")
+    if os.path.exists(filename):
+        for line in open(filename):
+            match = re.match(r"build-backend\s*=\s*\W([\w.]+)\W", line)
+            if not match: continue
+
+            msg = f"inherits setuptools3 but has pyproject.toml with {match[1]}, use the correct class"
+            if "pep517-backend" not in (d.getVar("INSANE_SKIP") or "").split():
+                oe.qa.handle_error("pep517-backend", msg, d)
+}
+addtask check_backend after do_patch before do_configure
+
 setuptools3_do_configure() {
     :
 }