distutils-r1.eclass: Upgrade to upstream
BUG=chromium:918017
TEST=tryjob
Change-Id: I435b01204c35d8984e9c0681a2a042de14f725f0
Reviewed-on: https://chromium-review.googlesource.com/1412036
Commit-Ready: Chris McDonald <cjmcdonald@chromium.org>
Tested-by: Chris McDonald <cjmcdonald@chromium.org>
Reviewed-by: Mike Frysinger <vapier@chromium.org>
diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass
index 7965e91..fa7a3ab 100644
--- a/eclass/distutils-r1.eclass
+++ b/eclass/distutils-r1.eclass
@@ -1,6 +1,5 @@
-# Copyright 1999-2015 Gentoo Foundation
+# Copyright 1999-2018 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Id$
# @ECLASS: distutils-r1.eclass
# @MAINTAINER:
@@ -8,6 +7,7 @@
# @AUTHOR:
# Author: Michał Górny <mgorny@gentoo.org>
# Based on the work of: Krzysztof Pawlik <nelchael@gentoo.org>
+# @SUPPORTED_EAPIS: 5 6 7
# @BLURB: A simple eclass to build Python packages using distutils.
# @DESCRIPTION:
# A simple eclass providing functions to build Python packages using
@@ -44,10 +44,10 @@
# https://wiki.gentoo.org/wiki/Project:Python/distutils-r1
case "${EAPI:-0}" in
- 0|1|2|3)
+ 0|1|2|3|4)
die "Unsupported EAPI=${EAPI:-0} (too old) for ${ECLASS}"
;;
- 4|5|6)
+ 5|6|7)
;;
*)
die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}"
@@ -80,10 +80,11 @@
if [[ ! ${_DISTUTILS_R1} ]]; then
[[ ${EAPI} == [45] ]] && inherit eutils
-inherit toolchain-funcs
+[[ ${EAPI} == [56] ]] && inherit xdg-utils
+inherit multiprocessing toolchain-funcs
if [[ ! ${DISTUTILS_SINGLE_IMPL} ]]; then
- inherit multiprocessing python-r1
+ inherit python-r1
else
inherit python-single-r1
fi
@@ -98,7 +99,11 @@
if [[ ! ${DISTUTILS_OPTIONAL} ]]; then
RDEPEND=${PYTHON_DEPS}
- DEPEND=${PYTHON_DEPS}
+ if [[ ${EAPI} != [56] ]]; then
+ BDEPEND=${PYTHON_DEPS}
+ else
+ DEPEND=${PYTHON_DEPS}
+ fi
REQUIRED_USE=${PYTHON_REQUIRED_USE}
fi
@@ -192,6 +197,12 @@
# (allowing any implementation). If multiple values are specified,
# implementations matching any of the patterns will be accepted.
#
+# The patterns can be either fnmatch-style patterns (matched via bash
+# == operator against PYTHON_COMPAT values) or '-2' / '-3' to indicate
+# appropriately all enabled Python 2/3 implementations (alike
+# python_is_python3). Remember to escape or quote the fnmatch patterns
+# to prevent accidental shell filename expansion.
+#
# If the restriction needs to apply conditionally to a USE flag,
# the variable should be set conditionally as well (e.g. in an early
# phase function or other convenient location).
@@ -225,13 +236,13 @@
# @USAGE: [<args>...]
# @DESCRIPTION:
# Run setup.py using currently selected Python interpreter
-# (if ${PYTHON} is set; fallback 'python' otherwise).
+# (if ${EPYTHON} is set; fallback 'python' otherwise).
#
# setup.py will be passed the following, in order:
# 1. ${mydistutilsargs[@]}
# 2. additional arguments passed to the esetup.py function.
#
-# Please note that setup.py will respect defaults (unless overriden
+# Please note that setup.py will respect defaults (unless overridden
# via command-line options) from setup.cfg that is created
# in distutils-r1_python_compile and in distutils-r1_python_install.
#
@@ -242,10 +253,19 @@
local die_args=()
[[ ${EAPI} != [45] ]] && die_args+=( -n )
- set -- "${PYTHON:-python}" setup.py "${mydistutilsargs[@]}" "${@}"
+ [[ ${BUILD_DIR} ]] && _distutils-r1_create_setup_cfg
+
+ set -- "${EPYTHON:-python}" setup.py "${mydistutilsargs[@]}" "${@}"
echo "${@}" >&2
- "${@}" || die "${die_args[@]}" || return ${?}
+ "${@}" || die "${die_args[@]}"
+ local ret=${?}
+
+ if [[ ${BUILD_DIR} ]]; then
+ rm "${HOME}"/.pydistutils.cfg || die "${die_args[@]}"
+ fi
+
+ return ${ret}
}
# @FUNCTION: distutils_install_for_testing
@@ -315,11 +335,13 @@
distutils-r1_python_prepare_all() {
debug-print-function ${FUNCNAME} "${@}"
- if [[ ${EAPI} != [45] ]]; then
- default
- else
- [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
- epatch_user
+ if [[ ! ${DISTUTILS_OPTIONAL} ]]; then
+ if [[ ${EAPI} != [45] ]]; then
+ default
+ else
+ [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
+ epatch_user
+ fi
fi
# by default, use in-source build if python_prepare() is used
@@ -374,16 +396,13 @@
#
# note: due to some packages (wxpython) relying on separate
# platlib & purelib dirs, we do not set --build-lib (which
- # can not be overriden with --build-*lib)
+ # can not be overridden with --build-*lib)
build-platlib = %(build-base)s/lib
build-purelib = %(build-base)s/lib
# make the ebuild writer lives easier
build-scripts = %(build-base)s/scripts
- [egg_info]
- egg-base = ${BUILD_DIR}
-
# this is needed by distutils_install_for_testing since
# setuptools like to create .egg files for install --home.
[bdist_egg]
@@ -399,7 +418,7 @@
[install]
compile = True
optimize = 2
- root = ${D}
+ root = ${D%/}
_EOF_
if [[ ! ${DISTUTILS_SINGLE_IMPL} ]]; then
@@ -434,10 +453,25 @@
distutils-r1_python_compile() {
debug-print-function ${FUNCNAME} "${@}"
- _distutils-r1_create_setup_cfg
_distutils-r1_copy_egg_info
- esetup.py build "${@}"
+ local build_args=()
+ # distutils is parallel-capable since py3.5
+ # to avoid breaking stable ebuilds, enable it only if either:
+ # a. we're dealing with EAPI 7
+ # b. we're dealing with Python 3.7 or PyPy3
+ if python_is_python3 && [[ ${EPYTHON} != python3.4 ]]; then
+ if [[ ${EAPI} != [56] || ${EPYTHON} != python3.[56] ]]; then
+ local jobs=$(makeopts_jobs "${MAKEOPTS}" INF)
+ if [[ ${jobs} == INF ]]; then
+ local nproc=$(get_nproc)
+ jobs=$(( nproc + 1 ))
+ fi
+ build_args+=( -j "${jobs}" )
+ fi
+ fi
+
+ esetup.py build "${build_args[@]}" "${@}"
}
# @FUNCTION: _distutils-r1_wrap_scripts
@@ -509,11 +543,9 @@
# enable compilation for the install phase.
local -x PYTHONDONTWRITEBYTECODE=
- # re-create setup.cfg with install paths
- _distutils-r1_create_setup_cfg
-
# python likes to compile any module it sees, which triggers sandbox
# failures if some packages haven't compiled their modules yet.
+ addpredict "${EPREFIX}/usr/lib/${EPYTHON}"
addpredict "${EPREFIX}/usr/$(get_libdir)/${EPYTHON}"
addpredict /usr/lib/portage/pym
addpredict /usr/local # bug 498232
@@ -553,8 +585,8 @@
done
fi
- local root=${D}/_${EPYTHON}
- [[ ${DISTUTILS_SINGLE_IMPL} ]] && root=${D}
+ local root=${D%/}/_${EPYTHON}
+ [[ ${DISTUTILS_SINGLE_IMPL} ]] && root=${D%/}
esetup.py install --root="${root}" "${args[@]}"
@@ -573,7 +605,7 @@
if [[ ! ${DISTUTILS_SINGLE_IMPL} ]]; then
_distutils-r1_wrap_scripts "${root}" "${scriptdir}"
- multibuild_merge_root "${root}" "${D}"
+ multibuild_merge_root "${root}" "${D%/}"
fi
}
@@ -588,9 +620,11 @@
if declare -p EXAMPLES &>/dev/null; then
[[ ${EAPI} != [45] ]] && die "EXAMPLES are banned in EAPI ${EAPI}"
- local INSDESTTREE=/usr/share/doc/${PF}/examples
- doins -r "${EXAMPLES[@]}"
- docompress -x "${INSDESTTREE}"
+ (
+ docinto examples
+ dodoc -r "${EXAMPLES[@]}"
+ )
+ docompress -x "/usr/share/doc/${PF}/examples"
fi
_DISTUTILS_DEFAULT_CALLED=1
@@ -628,12 +662,6 @@
# in the sys.path_importer_cache)
mkdir -p "${BUILD_DIR}/lib" || die
- # We need separate home for each implementation, for .pydistutils.cfg.
- if [[ ! ${DISTUTILS_SINGLE_IMPL} ]]; then
- local -x HOME=${HOME}/${EPYTHON}
- mkdir -p "${HOME}" || die
- fi
-
# Set up build environment, bug #513664.
local -x AR=${AR} CC=${CC} CPP=${CPP} CXX=${CXX}
tc-export AR CC CPP CXX
@@ -667,23 +695,20 @@
_distutils-r1_run_common_phase() {
local DISTUTILS_ORIG_BUILD_DIR=${BUILD_DIR}
- if [[ ! ${DISTUTILS_SINGLE_IMPL} ]]; then
- local best_impl patterns=( "${DISTUTILS_ALL_SUBPHASE_IMPLS[@]-*}" )
- _distutils_try_impl() {
- local pattern
- for pattern in "${patterns[@]}"; do
- if [[ ${EPYTHON} == ${pattern} ]]; then
- best_impl=${MULTIBUILD_VARIANT}
- fi
- done
- }
- python_foreach_impl _distutils_try_impl
- unset -f _distutils_try_impl
+ if [[ ${DISTUTILS_SINGLE_IMPL} ]]; then
+ # reuse the dedicated code branch
+ _distutils-r1_run_foreach_impl "${@}"
+ else
+ local -x EPYTHON PYTHON
+ local -x PATH=${PATH} PKG_CONFIG_PATH=${PKG_CONFIG_PATH}
+ python_setup "${DISTUTILS_ALL_SUBPHASE_IMPLS[@]}"
- local PYTHON_COMPAT=( "${best_impl}" )
+ local MULTIBUILD_VARIANTS=( "${EPYTHON/./_}" )
+ # store for restoring after distutils-r1_run_phase.
+ local _DISTUTILS_INITIAL_CWD=${PWD}
+ multibuild_foreach_variant \
+ distutils-r1_run_phase "${@}"
fi
-
- _distutils-r1_run_foreach_impl "${@}"
}
# @FUNCTION: _distutils-r1_run_foreach_impl
@@ -694,15 +719,6 @@
_distutils-r1_run_foreach_impl() {
debug-print-function ${FUNCNAME} "${@}"
- if [[ ${DISTUTILS_NO_PARALLEL_BUILD} ]]; then
- [[ ${EAPI} == [45] ]] || die "DISTUTILS_NO_PARALLEL_BUILD is banned in EAPI ${EAPI}"
-
- eqawarn "DISTUTILS_NO_PARALLEL_BUILD is no longer meaningful. Now all builds"
- eqawarn "are non-parallel. Please remove it from the ebuild."
-
- unset DISTUTILS_NO_PARALLEL_BUILD # avoid repeated warnings
- fi
-
# store for restoring after distutils-r1_run_phase.
local _DISTUTILS_INITIAL_CWD=${PWD}
set -- distutils-r1_run_phase "${@}"
@@ -746,6 +762,7 @@
distutils-r1_src_configure() {
python_export_utf8_locale
+ [[ ${EAPI} == [56] ]] && xdg_environment_reset # Bug 577704
if declare -f python_configure >/dev/null; then
_distutils-r1_run_foreach_impl python_configure
@@ -770,10 +787,14 @@
fi
}
-_clean_egg_info() {
- # Work around for setuptools test behavior (bug 534058).
- # https://bitbucket.org/pypa/setuptools/issue/292
- rm -rf "${BUILD_DIR}"/lib/*.egg-info
+# @FUNCTION: _distutils-r1_clean_egg_info
+# @INTERNAL
+# @DESCRIPTION:
+# Clean up potential stray egg-info files left by setuptools test phase.
+# Those files ended up being unversioned, and caused issues:
+# https://bugs.gentoo.org/534058
+_distutils-r1_clean_egg_info() {
+ rm -rf "${BUILD_DIR}"/lib/*.egg-info || die
}
distutils-r1_src_test() {
@@ -781,7 +802,7 @@
if declare -f python_test >/dev/null; then
_distutils-r1_run_foreach_impl python_test
- _distutils-r1_run_foreach_impl _clean_egg_info
+ _distutils-r1_run_foreach_impl _distutils-r1_clean_egg_info
fi
if declare -f python_test_all >/dev/null; then
@@ -789,6 +810,33 @@
fi
}
+# @FUNCTION: _distutils-r1_check_namespace_pth
+# @INTERNAL
+# @DESCRIPTION:
+# Check if any *-nspkg.pth files were installed (by setuptools)
+# and warn about the policy non-conformance if they were.
+_distutils-r1_check_namespace_pth() {
+ local f pth=()
+
+ while IFS= read -r -d '' f; do
+ pth+=( "${f}" )
+ done < <(find "${ED%/}" -name '*-nspkg.pth' -print0)
+
+ if [[ ${pth[@]} ]]; then
+ ewarn "The following *-nspkg.pth files were found installed:"
+ ewarn
+ for f in "${pth[@]}"; do
+ ewarn " ${f#${ED%/}}"
+ done
+ ewarn
+ ewarn "The presence of those files may break namespaces in Python 3.5+. Please"
+ ewarn "read our documentation on reliable handling of namespaces and update"
+ ewarn "the ebuild accordingly:"
+ ewarn
+ ewarn " https://wiki.gentoo.org/wiki/Project:Python/Namespace_packages"
+ fi
+}
+
distutils-r1_src_install() {
debug-print-function ${FUNCNAME} "${@}"
@@ -812,6 +860,8 @@
"${cmd}" "QA: python_install_all() didn't call distutils-r1_python_install_all"
fi
+
+ _distutils-r1_check_namespace_pth
}
# -- distutils.eclass functions --
