From: "Michał Górny" <mgorny@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Cc: "Michał Górny" <mgorny@gentoo.org>
Subject: [gentoo-dev] [PATCH 2/9] install-qa-check.d/60python-site: Add invalid site-packages check
Date: Sat, 6 Jan 2024 14:44:39 +0100 [thread overview]
Message-ID: <20240106134446.26153-2-mgorny@gentoo.org> (raw)
In-Reply-To: <20240106134446.26153-1-mgorny@gentoo.org>
Signed-off-by: Michał Górny <mgorny@gentoo.org>
---
metadata/install-qa-check.d/60python-site | 45 ++++++++++++++++++++++-
1 file changed, 44 insertions(+), 1 deletion(-)
diff --git a/metadata/install-qa-check.d/60python-site b/metadata/install-qa-check.d/60python-site
index 5f812ecd01e1..459509f8a136 100644
--- a/metadata/install-qa-check.d/60python-site
+++ b/metadata/install-qa-check.d/60python-site
@@ -11,12 +11,21 @@ python_site_check() {
local progs=( "${EPREFIX}"/usr/lib/python-exec/*/gpep517 )
${save}
+ local forbidden_package_names=(
+ # NB: setuptools/discovery.py is a good source of ideas
+ benchmark benchmarks dist doc docs examples scripts tasks
+ test tests tools util utils
+ .pytest_cache .hypothesis _trial_temp
+ )
+
local invalid=()
local mismatched_timestamp=()
local mismatched_data=()
local missing=()
local stray=()
+ local stray_packages=()
+
# Avoid running the check if sufficiently new gpep517 is not installed
# yet. It's valid to schedule (for merge order) >=gpep517-8 after
# packages which have this check run if they don't use distutils-r1.
@@ -24,12 +33,33 @@ python_site_check() {
return
fi
+ local f prog
for prog in "${progs[@]}"; do
local impl=${prog%/*}
impl=${impl##*/}
# NB: using ${impl}* to catch pypy3.* for pypy3
- [[ -d "${ED}"/usr/lib/${impl}*/site-packages ]] || continue
+ local sitedir=( "${ED}"/usr/lib/${impl}*/site-packages )
+ [[ -d ${sitedir} ]] || continue
+
+ # check for stray files in site-packages
+ while IFS= read -d $'\0' -r f; do
+ stray_packages+=( "${f#${ED}}" )
+ done < <(
+ find "${sitedir}" -maxdepth 1 -type f '!' '(' \
+ -name '*.egg-info' -o \
+ -name '*.pth' -o \
+ -name '*.py' -o \
+ -name '*.pyi' -o \
+ -name "*$(get_modname)" \
+ ')' -print0
+ )
+ # check for forbidden packages
+ for f in "${forbidden_package_names[@]}"; do
+ [[ -d ${sitedir}/${f} ]] && stray_packages+=(
+ "${sitedir#${ED}}/${f}"
+ )
+ done
einfo "Verifying compiled files for ${impl}"
local kind pyc py
@@ -117,6 +147,19 @@ python_site_check() {
eqawarn "For more information on bytecode files and related issues, please see:"
eqawarn " https://projects.gentoo.org/python/guide/qawarn.html#compiled-bytecode-related-warnings"
fi
+
+ if [[ ${stray_packages[@]} ]]; then
+ eqawarn
+ eqawarn "QA Notice: The following unexpected files/directories were found"
+ eqawarn "top-level in the site-packages directory:"
+ eqawarn
+ eqatag -v python-site.stray "${stray_packages[@]}"
+ eqawarn
+ eqawarn "This is most likely a bug in the build system. More information"
+ eqawarn "can be found in the Python Guide:"
+ eqawarn "https://projects.gentoo.org/python/guide/qawarn.html#stray-top-level-files-in-site-packages"
+ die "Failing install because of stray top-level files in site-packages"
+ fi
}
python_site_check
--
2.43.0
next prev parent reply other threads:[~2024-01-06 13:45 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-06 13:44 [gentoo-dev] [PATCH 1/9] install-qa-check.d: Generalize 60python-{pyc → site} Michał Górny
2024-01-06 13:44 ` Michał Górny [this message]
2024-01-06 13:44 ` [gentoo-dev] [PATCH 3/9] distutils-r1.eclass: Stray file check moved to install-qa-check.d Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 4/9] install-qa-check.d/60python-site: Add bad version check Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 5/9] install-qa-check.d/60python-site: Forbid lib & usr package names Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 6/9] install-qa-check.d/60python-site: Add check for wrong libdir Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 7/9] install-qa-check.d/60python-site: Check for UNKNOWN package name Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 8/9] install-qa-check.d/60python-site: Check for out-of-sitepkg install Michał Górny
2024-01-06 13:44 ` [gentoo-dev] [PATCH 9/9] install-qa-check.d/60python-site: allow site-packages/README.txt Michał Górny
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240106134446.26153-2-mgorny@gentoo.org \
--to=mgorny@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox