/[gentoo-x86]/eclass/python.eclass
Gentoo

Diff of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.39 Revision 1.151
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.39 2008/05/29 21:19:19 hawking Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.151 2012/02/27 03:57:35 floppym Exp $
4 4
5# @ECLASS: python.eclass 5# @ECLASS: python.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# python@gentoo.org 7# Gentoo Python Project <python@gentoo.org>
8# 8# @BLURB: Eclass for Python packages
9# original author: Alastair Tse <liquidx@gentoo.org>
10# @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules.
11# @DESCRIPTION: 9# @DESCRIPTION:
12# Some useful functions for dealing with python. 10# The python eclass contains miscellaneous, useful functions for Python packages.
13inherit alternatives multilib
14 11
15 12# Must call inherit before EXPORT_FUNCTIONS to avoid QA warning.
16if [[ -n "${NEED_PYTHON}" ]] ; then 13if [[ -z "${_PYTHON_ECLASS_INHERITED}" ]]; then
17 DEPEND=">=dev-lang/python-${NEED_PYTHON}" 14 inherit multilib
18 RDEPEND="${DEPEND}"
19fi 15fi
20 16
21__python_eclass_test() { 17# Export pkg_setup every time to avoid issues with eclass inheritance order.
22 __python_version_extract 2.3 18if ! has "${EAPI:-0}" 0 1 2 3 || { has "${EAPI:-0}" 2 3 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; }; then
23 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 19 EXPORT_FUNCTIONS pkg_setup
24 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
25 __python_version_extract 2.3.4
26 echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
27 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
28 __python_version_extract 2.3.5
29 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
30 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
31 __python_version_extract 2.4
32 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
33 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
34 __python_version_extract 2.5b3
35 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37}
38
39# @FUNCTION: python_disable_pyc
40# @DESCRIPTION:
41# Tells python not to automatically recompile modules to .pyc/.pyo
42# even if the timestamps/version stamps don't match. This is done
43# to protect sandbox.
44#
45# note: supported by >=dev-lang/python-2.2.3-r3 only.
46#
47python_disable_pyc() {
48 export PYTHON_DONTCOMPILE=1
49}
50
51# @FUNCTION: python_enable_pyc
52# @DESCRIPTION:
53# Tells python to automatically recompile modules to .pyc/.pyo if the
54# timestamps/version stamps change
55python_enable_pyc() {
56 unset PYTHON_DONTCOMPILE
57}
58
59python_disable_pyc
60
61# @FUNCTION: python_version
62# @DESCRIPTION:
63# Run without arguments and it will export the version of python
64# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65__python_version_extract() {
66 verstr=$1
67 export PYVER_MAJOR=${verstr:0:1}
68 export PYVER_MINOR=${verstr:2:1}
69 if [ "${verstr:3}x" = ".x" ]; then
70 export PYVER_MICRO=${verstr:4}
71 fi 20fi
72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73}
74 21
75python_version() { 22# Avoid processing this eclass more than once.
76 local tmpstr 23if [[ -z "${_PYTHON_ECLASS_INHERITED}" ]]; then
77 python=${python:-/usr/bin/python} 24_PYTHON_ECLASS_INHERITED="1"
78 tmpstr="$(${python} -V 2>&1 )"
79 export PYVER_ALL="${tmpstr#Python }"
80 __python_version_extract $PYVER_ALL
81}
82 25
83# @FUNCTION: python_makesym 26if ! has "${EAPI:-0}" 0 1 2 3 4; then
84# @DESCRIPTION: 27 die "API of python.eclass in EAPI=\"${EAPI}\" not established"
85# Run without arguments, it will create the /usr/bin/python symlinks
86# to the latest installed version
87python_makesym() {
88 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
89 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
90}
91
92# @FUNCTION: python_tkinter_exists
93# @DESCRIPTION:
94# Run without arguments, checks if python was compiled with Tkinter
95# support. If not, prints an error message and dies.
96python_tkinter_exists() {
97 if ! python -c "import Tkinter" >/dev/null 2>&1; then
98 eerror "You need to recompile python with Tkinter support."
99 eerror "Try adding: 'dev-lang/python tk'"
100 eerror "in to /etc/portage/package.use"
101 echo
102 die "missing tkinter support with installed python"
103 fi 28fi
104}
105 29
106# @FUNCTION: python_mod_exists 30_CPYTHON2_GLOBALLY_SUPPORTED_ABIS=(2.4 2.5 2.6 2.7)
107# @USAGE: < module > 31_CPYTHON3_GLOBALLY_SUPPORTED_ABIS=(3.1 3.2)
108# @DESCRIPTION: 32_JYTHON_GLOBALLY_SUPPORTED_ABIS=(2.5-jython)
109# Run with the module name as an argument. it will check if a 33_PYPY_GLOBALLY_SUPPORTED_ABIS=(2.7-pypy-1.7 2.7-pypy-1.8)
110# python module is installed and loadable. it will return 34_PYTHON_GLOBALLY_SUPPORTED_ABIS=(${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]} ${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]} ${_JYTHON_GLOBALLY_SUPPORTED_ABIS[@]} ${_PYPY_GLOBALLY_SUPPORTED_ABIS[@]})
111# TRUE(0) if the module exists, and FALSE(1) if the module does
112# not exist.
113#
114# Example:
115# if python_mod_exists gtk; then
116# echo "gtk support enabled"
117# fi
118python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then
121 return 1
122 fi
123 return 0
124}
125 35
126# @FUNCTION: python_mod_compile 36# ================================================================================================
127# @USAGE: < file > [more files ...] 37# ===================================== HANDLING OF METADATA =====================================
128# @DESCRIPTION: 38# ================================================================================================
129# Given filenames, it will pre-compile the module's .pyc and .pyo.
130# This function should only be run in pkg_postinst()
131#
132# Example:
133# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
134#
135python_mod_compile() {
136 local f myroot
137 39
138 # Check if phase is pkg_postinst() 40_PYTHON_ABI_PATTERN_REGEX="([[:alnum:]]|\.|-|\*|\[|\])+"
139 [[ ${EBUILD_PHASE} != postinst ]] &&\
140 die "${FUNCNAME} should only be run in pkg_postinst()"
141 41
142 # allow compiling for older python versions 42_python_check_python_abi_matching() {
143 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 43 local pattern patterns patterns_list="0" PYTHON_ABI
144 PYVER=${PYTHON_OVERRIDE_PYVER}
145 else
146 python_version
147 fi
148 44
149 # strip trailing slash 45 while (($#)); do
150 myroot="${ROOT%/}"
151
152 # respect ROOT
153 for f in $@; do
154 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
155 done
156
157 if [ -n "${myfiles}" ]; then
158 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
159 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
160 else
161 ewarn "No files to compile!"
162 fi
163}
164
165# @FUNCTION: python_mod_optimize
166# @USAGE: [ path ]
167# @DESCRIPTION:
168# If no arguments supplied, it will recompile all modules under
169# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
170# no recursively
171#
172# If supplied with arguments, it will recompile all modules recursively
173# in the supplied directory
174# This function should only be run in pkg_postinst()
175#
176# Options passed to this function are passed to compileall.py
177#
178# Example:
179# python_mod_optimize /usr/share/codegen
180python_mod_optimize() {
181 local mydirs myfiles myroot myopts path
182
183 # Check if phase is pkg_postinst()
184 [[ ${EBUILD_PHASE} != postinst ]] &&\
185 die "${FUNCNAME} should only be run in pkg_postinst()"
186
187 # strip trailing slash
188 myroot="${ROOT%/}"
189
190 # respect ROOT and options passed to compileall.py
191 while [ $# -gt 0 ]; do
192 case $1 in 46 case "$1" in
193 -l|-f|-q) 47 --patterns-list)
194 myopts="${myopts} $1" 48 patterns_list="1"
195 ;; 49 ;;
196 -d|-x) 50 --)
197 # -x takes regexp as argument so quoting is necessary.
198 myopts="${myopts} $1 \"$2\""
199 shift 51 shift
52 break
200 ;; 53 ;;
201 -*) 54 -*)
202 ewarn "${FUNCNAME}: Ignoring compile option $1" 55 die "${FUNCNAME}(): Unrecognized option '$1'"
203 ;; 56 ;;
204 *) 57 *)
205 for path in $@; do 58 break
206 [ ! -e "${myroot}/${path}" ] && ewarn "${myroot}/${path} doesn't exist!"
207 [ -d "${myroot}/${path#/}" ] && mydirs="${mydirs} ${myroot}/${path#/}"
208 # Files are passed to python_mod_compile which is ROOT-aware
209 [ -f "${myroot}/${path}" ] && myfiles="${myfiles} ${path}"
210 done
211 ;; 59 ;;
212 esac 60 esac
213 shift 61 shift
214 done 62 done
215 63
216 # allow compiling for older python versions 64 if [[ "$#" -ne 2 ]]; then
217 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 65 die "${FUNCNAME}() requires 2 arguments"
218 PYVER=${PYTHON_OVERRIDE_PYVER} 66 fi
67
68 PYTHON_ABI="$1"
69
70 if [[ "${patterns_list}" == "0" ]]; then
71 pattern="$2"
72
73 if [[ "${pattern}" == *"-cpython" ]]; then
74 [[ "${PYTHON_ABI}" =~ ^[[:digit:]]+\.[[:digit:]]+$ && "${PYTHON_ABI}" == ${pattern%-cpython} ]]
75 elif [[ "${pattern}" == *"-jython" ]]; then
76 [[ "${PYTHON_ABI}" == ${pattern} ]]
77 elif [[ "${pattern}" == *"-pypy-"* ]]; then
78 [[ "${PYTHON_ABI}" == ${pattern} ]]
219 else 79 else
220 python_version 80 if [[ "${PYTHON_ABI}" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
81 [[ "${PYTHON_ABI}" == ${pattern} ]]
82 elif [[ "${PYTHON_ABI}" =~ ^[[:digit:]]+\.[[:digit:]]+-jython$ ]]; then
83 [[ "${PYTHON_ABI%-jython}" == ${pattern} ]]
84 elif [[ "${PYTHON_ABI}" =~ ^[[:digit:]]+\.[[:digit:]]+-pypy-[[:digit:]]+\.[[:digit:]]+$ ]]; then
85 [[ "${PYTHON_ABI%-pypy-*}" == ${pattern} ]]
86 else
87 die "${FUNCNAME}(): Unrecognized Python ABI '${PYTHON_ABI}'"
88 fi
221 fi 89 fi
90 else
91 patterns="${2// /$'\n'}"
222 92
223 # set opts 93 while read pattern; do
224 if [ "${PYVER}" = "2.2" ]; then 94 if _python_check_python_abi_matching "${PYTHON_ABI}" "${pattern}"; then
225 compileopts="" 95 return 0
96 fi
97 done <<< "${patterns}"
98
99 return 1
100 fi
101}
102
103_python_package_supporting_installation_for_multiple_python_abis() {
104 if has "${EAPI:-0}" 0 1 2 3 4; then
105 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
106 return 0
226 else 107 else
227 compileopts="-q" 108 return 1
228 fi 109 fi
110 else
111 die "${FUNCNAME}(): Support for EAPI=\"${EAPI}\" not implemented"
112 fi
113}
229 114
230 ebegin "Byte compiling python modules for python-${PYVER} .." 115# @ECLASS-VARIABLE: PYTHON_DEPEND
231 if [ -n "${mydirs}" ]; then 116# @DESCRIPTION:
232 python${PYVER} \ 117# Specification of dependency on dev-lang/python.
233 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \ 118# Syntax:
234 ${compileopts} ${myopts} ${mydirs} 119# PYTHON_DEPEND: [[!]USE_flag? ]<version_components_group>[ version_components_group]
235 python${PYVER} -O \ 120# version_components_group: <major_version[:[minimal_version][:maximal_version]]>
236 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \ 121# major_version: <2|3|*>
237 ${compileopts} ${myopts} ${mydirs} 122# minimal_version: <minimal_major_version.minimal_minor_version>
123# maximal_version: <maximal_major_version.maximal_minor_version>
124
125_python_parse_PYTHON_DEPEND() {
126 local major_version maximal_version minimal_version python_all="0" python_maximal_version python_minimal_version python_versions=() python2="0" python2_maximal_version python2_minimal_version python3="0" python3_maximal_version python3_minimal_version USE_flag= version_components_group version_components_group_regex version_components_groups
127
128 version_components_group_regex="(2|3|\*)(:([[:digit:]]+\.[[:digit:]]+)?(:([[:digit:]]+\.[[:digit:]]+)?)?)?"
129 version_components_groups="${PYTHON_DEPEND}"
130
131 if [[ "${version_components_groups}" =~ ^((\!)?[[:alnum:]_-]+\?\ )?${version_components_group_regex}(\ ${version_components_group_regex})?$ ]]; then
132 if [[ "${version_components_groups}" =~ ^(\!)?[[:alnum:]_-]+\? ]]; then
133 USE_flag="${version_components_groups%\? *}"
134 version_components_groups="${version_components_groups#* }"
238 fi 135 fi
239 136 if [[ "${version_components_groups}" =~ ("*".*" "|" *"|^2.*\ (2|\*)|^3.*\ (3|\*)) ]]; then
240 if [ -n "${myfiles}" ]; then 137 die "Invalid syntax of PYTHON_DEPEND: Incorrectly specified groups of versions"
241 python_mod_compile ${myfiles}
242 fi 138 fi
243 139
244 eend $? 140 version_components_groups="${version_components_groups// /$'\n'}"
141 while read version_components_group; do
142 major_version="${version_components_group:0:1}"
143 minimal_version="${version_components_group:2}"
144 minimal_version="${minimal_version%:*}"
145 maximal_version="${version_components_group:$((3 + ${#minimal_version}))}"
146
147 if [[ "${major_version}" =~ ^(2|3)$ ]]; then
148 if [[ -n "${minimal_version}" && "${major_version}" != "${minimal_version:0:1}" ]]; then
149 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' not in specified group of versions"
150 fi
151 if [[ -n "${maximal_version}" && "${major_version}" != "${maximal_version:0:1}" ]]; then
152 die "Invalid syntax of PYTHON_DEPEND: Maximal version '${maximal_version}' not in specified group of versions"
153 fi
154 fi
155
156 if [[ "${major_version}" == "2" ]]; then
157 python2="1"
158 python_versions=("${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}")
159 python2_minimal_version="${minimal_version}"
160 python2_maximal_version="${maximal_version}"
161 elif [[ "${major_version}" == "3" ]]; then
162 python3="1"
163 python_versions=("${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}")
164 python3_minimal_version="${minimal_version}"
165 python3_maximal_version="${maximal_version}"
166 else
167 python_all="1"
168 python_versions=("${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}" "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}")
169 python_minimal_version="${minimal_version}"
170 python_maximal_version="${maximal_version}"
171 fi
172
173 if [[ -n "${minimal_version}" ]] && ! has "${minimal_version}" "${python_versions[@]}"; then
174 die "Invalid syntax of PYTHON_DEPEND: Unrecognized minimal version '${minimal_version}'"
175 fi
176 if [[ -n "${maximal_version}" ]] && ! has "${maximal_version}" "${python_versions[@]}"; then
177 die "Invalid syntax of PYTHON_DEPEND: Unrecognized maximal version '${maximal_version}'"
178 fi
179
180 if [[ -n "${minimal_version}" && -n "${maximal_version}" && "${minimal_version}" > "${maximal_version}" ]]; then
181 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' greater than maximal version '${maximal_version}'"
182 fi
183 done <<< "${version_components_groups}"
184
185 _PYTHON_ATOMS=()
186
187 _append_accepted_versions_range() {
188 local accepted_version="0" i
189 for ((i = "${#python_versions[@]}"; i >= 0; i--)); do
190 if [[ "${python_versions[${i}]}" == "${python_maximal_version}" ]]; then
191 accepted_version="1"
192 fi
193 if [[ "${accepted_version}" == "1" ]]; then
194 _PYTHON_ATOMS+=("=dev-lang/python-${python_versions[${i}]}*")
195 fi
196 if [[ "${python_versions[${i}]}" == "${python_minimal_version}" ]]; then
197 accepted_version="0"
198 fi
199 done
200 }
201
202 if [[ "${python_all}" == "1" ]]; then
203 if [[ -z "${python_minimal_version}" && -z "${python_maximal_version}" ]]; then
204 _PYTHON_ATOMS+=("dev-lang/python")
205 else
206 python_versions=("${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}" "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}")
207 python_minimal_version="${python_minimal_version:-${python_versions[0]}}"
208 python_maximal_version="${python_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
209 _append_accepted_versions_range
210 fi
211 else
212 if [[ "${python3}" == "1" ]]; then
213 if [[ -z "${python3_minimal_version}" && -z "${python3_maximal_version}" ]]; then
214 _PYTHON_ATOMS+=("=dev-lang/python-3*")
215 else
216 python_versions=("${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}")
217 python_minimal_version="${python3_minimal_version:-${python_versions[0]}}"
218 python_maximal_version="${python3_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
219 _append_accepted_versions_range
220 fi
221 fi
222 if [[ "${python2}" == "1" ]]; then
223 if [[ -z "${python2_minimal_version}" && -z "${python2_maximal_version}" ]]; then
224 _PYTHON_ATOMS+=("=dev-lang/python-2*")
225 else
226 python_versions=("${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}")
227 python_minimal_version="${python2_minimal_version:-${python_versions[0]}}"
228 python_maximal_version="${python2_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
229 _append_accepted_versions_range
230 fi
231 fi
232 fi
233
234 unset -f _append_accepted_versions_range
235
236 if [[ "${#_PYTHON_ATOMS[@]}" -gt 1 ]]; then
237 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
238 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
239 else
240 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
241 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
242 fi
243 else
244 die "Invalid syntax of PYTHON_DEPEND"
245 fi
246}
247
248DEPEND=">=app-admin/eselect-python-20091230"
249RDEPEND="${DEPEND}"
250
251if [[ -n "${PYTHON_DEPEND}" ]]; then
252 _python_parse_PYTHON_DEPEND
253else
254 _PYTHON_ATOMS=("dev-lang/python")
255fi
256unset -f _python_parse_PYTHON_DEPEND
257
258if [[ -n "${NEED_PYTHON}" ]]; then
259 eerror "Use PYTHON_DEPEND variable instead of NEED_PYTHON variable."
260 die "NEED_PYTHON variable is banned"
261fi
262
263# @ECLASS-VARIABLE: PYTHON_USE_WITH
264# @DESCRIPTION:
265# Set this to a space separated list of USE flags the Python slot in use must be built with.
266
267# @ECLASS-VARIABLE: PYTHON_USE_WITH_OR
268# @DESCRIPTION:
269# Set this to a space separated list of USE flags of which one must be turned on for the slot in use.
270
271# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT
272# @DESCRIPTION:
273# Set this to a name of a USE flag if you need to make either PYTHON_USE_WITH or
274# PYTHON_USE_WITH_OR atoms conditional under a USE flag.
275
276if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
277 _PYTHON_USE_WITH_ATOMS_ARRAY=()
278 if [[ -n "${PYTHON_USE_WITH}" ]]; then
279 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
280 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${PYTHON_USE_WITH// /,}]")
281 done
282 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then
283 for _USE_flag in ${PYTHON_USE_WITH_OR}; do
284 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
285 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${_USE_flag}]")
286 done
287 done
288 unset _USE_flag
289 fi
290 if [[ "${#_PYTHON_USE_WITH_ATOMS_ARRAY[@]}" -gt 1 ]]; then
291 _PYTHON_USE_WITH_ATOMS="|| ( ${_PYTHON_USE_WITH_ATOMS_ARRAY[@]} )"
292 else
293 _PYTHON_USE_WITH_ATOMS="${_PYTHON_USE_WITH_ATOMS_ARRAY[@]}"
294 fi
295 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then
296 _PYTHON_USE_WITH_ATOMS="${PYTHON_USE_WITH_OPT}? ( ${_PYTHON_USE_WITH_ATOMS} )"
297 fi
298 DEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
299 RDEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
300 unset _PYTHON_ATOM _PYTHON_USE_WITH_ATOMS _PYTHON_USE_WITH_ATOMS_ARRAY
301fi
302
303unset _PYTHON_ATOMS
304
305# ================================================================================================
306# =================================== MISCELLANEOUS FUNCTIONS ====================================
307# ================================================================================================
308
309_python_implementation() {
310 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then
311 return 0
312 elif [[ "${CATEGORY}/${PN}" == "dev-java/jython" ]]; then
313 return 0
314 elif [[ "${CATEGORY}/${PN}" == "dev-python/pypy" ]]; then
315 return 0
316 else
317 return 1
318 fi
319}
320
321_python_abi-specific_local_scope() {
322 [[ " ${FUNCNAME[@]:2} " =~ " "(_python_final_sanity_checks|python_execute_function|python_mod_optimize|python_mod_cleanup)" " ]]
323}
324
325_python_initialize_prefix_variables() {
326 if has "${EAPI:-0}" 0 1 2; then
327 if [[ -n "${ROOT}" && -z "${EROOT}" ]]; then
328 EROOT="${ROOT%/}${EPREFIX}/"
329 fi
330 if [[ -n "${D}" && -z "${ED}" ]]; then
331 ED="${D%/}${EPREFIX}/"
332 fi
333 fi
334}
335
336unset PYTHON_SANITY_CHECKS_EXECUTED PYTHON_SKIP_SANITY_CHECKS
337
338_python_initial_sanity_checks() {
339 if [[ "$(declare -p PYTHON_SANITY_CHECKS_EXECUTED 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS_EXECUTED="* || " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " && -z "${PYTHON_SKIP_SANITY_CHECKS}" ]]; then
340 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
341 if [[ "$(readlink "${EPREFIX}/usr/bin/python")" != "python-wrapper" ]]; then
342 eerror "'${EPREFIX}/usr/bin/python' is not valid symlink."
343 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
344 die "'${EPREFIX}/usr/bin/python' is not valid symlink"
345 fi
346 if [[ "$(<"${EPREFIX}/usr/bin/python-config")" != *"Gentoo python-config wrapper script"* ]]; then
347 eerror "'${EPREFIX}/usr/bin/python-config' is not valid script"
348 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
349 die "'${EPREFIX}/usr/bin/python-config' is not valid script"
350 fi
351 fi
352}
353
354_python_final_sanity_checks() {
355 if ! _python_implementation && [[ "$(declare -p PYTHON_SANITY_CHECKS_EXECUTED 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS_EXECUTED="* || " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " && -z "${PYTHON_SKIP_SANITY_CHECKS}" ]]; then
356 local PYTHON_ABI="${PYTHON_ABI}"
357 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI}}; do
358 # Ensure that appropriate version of Python is installed.
359 if ! has_version "$(python_get_implementational_package)"; then
360 die "$(python_get_implementational_package) is not installed"
361 fi
362
363 # Ensure that EPYTHON variable is respected.
364 if [[ "$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")" != "${PYTHON_ABI}" ]]; then
365 eerror "Path to 'python': '$(type -p python)'"
366 eerror "ABI: '${ABI}'"
367 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
368 eerror "EPYTHON: '$(PYTHON)'"
369 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
370 eerror "Locally active version of Python: '$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")'"
371 die "'python' does not respect EPYTHON variable"
372 fi
373 done
374 fi
375 PYTHON_SANITY_CHECKS_EXECUTED="1"
376}
377
378# @ECLASS-VARIABLE: PYTHON_COLORS
379# @DESCRIPTION:
380# User-configurable colored output.
381PYTHON_COLORS="${PYTHON_COLORS:-0}"
382
383_python_set_color_variables() {
384 if [[ "${PYTHON_COLORS}" != "0" && "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
385 _BOLD=$'\e[1m'
386 _RED=$'\e[1;31m'
387 _GREEN=$'\e[1;32m'
388 _BLUE=$'\e[1;34m'
389 _CYAN=$'\e[1;36m'
390 _NORMAL=$'\e[0m'
391 else
392 _BOLD=
393 _RED=
394 _GREEN=
395 _BLUE=
396 _CYAN=
397 _NORMAL=
398 fi
399}
400
401_python_check_python_pkg_setup_execution() {
402 [[ " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " ]] && return
403
404 if ! has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_PKG_SETUP_EXECUTED}" ]]; then
405 die "python_pkg_setup() not called"
406 fi
407}
408
409# @FUNCTION: python_pkg_setup
410# @DESCRIPTION:
411# Perform sanity checks and initialize environment.
412#
413# This function is exported in EAPI 2 and 3 when PYTHON_USE_WITH or PYTHON_USE_WITH_OR variable
414# is set and always in EAPI >=4. Calling of this function is mandatory in EAPI >=4.
415python_pkg_setup() {
416 if [[ "${EBUILD_PHASE}" != "setup" ]]; then
417 die "${FUNCNAME}() can be used only in pkg_setup() phase"
418 fi
419
420 if [[ "$#" -ne 0 ]]; then
421 die "${FUNCNAME}() does not accept arguments"
422 fi
423
424 export JYTHON_SYSTEM_CACHEDIR="1"
425 addwrite "${EPREFIX}/var/cache/jython"
426
427 if _python_package_supporting_installation_for_multiple_python_abis; then
428 _python_calculate_PYTHON_ABIS
429 export EPYTHON="$(PYTHON -f)"
430 else
431 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
432 fi
433
434 if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; then
435 if [[ "${PYTHON_USE_WITH_OPT}" ]]; then
436 if [[ "${PYTHON_USE_WITH_OPT}" == !* ]]; then
437 use ${PYTHON_USE_WITH_OPT#!} && return
438 else
439 use !${PYTHON_USE_WITH_OPT} && return
440 fi
441 fi
442
443 python_pkg_setup_check_USE_flags() {
444 local python_atom USE_flag
445 python_atom="$(python_get_implementational_package)"
446
447 for USE_flag in ${PYTHON_USE_WITH}; do
448 if ! has_version "${python_atom}[${USE_flag}]"; then
449 eerror "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
450 die "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
451 fi
452 done
453
454 for USE_flag in ${PYTHON_USE_WITH_OR}; do
455 if has_version "${python_atom}[${USE_flag}]"; then
456 return
457 fi
458 done
459
460 if [[ ${PYTHON_USE_WITH_OR} ]]; then
461 eerror "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
462 die "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
463 fi
464 }
465
466 if _python_package_supporting_installation_for_multiple_python_abis; then
467 PYTHON_SKIP_SANITY_CHECKS="1" python_execute_function -q python_pkg_setup_check_USE_flags
468 else
469 python_pkg_setup_check_USE_flags
470 fi
471
472 unset -f python_pkg_setup_check_USE_flags
473 fi
474
475 PYTHON_PKG_SETUP_EXECUTED="1"
476}
477
478_PYTHON_SHEBANG_BASE_PART_REGEX='^#![[:space:]]*([^[:space:]]*/usr/bin/env[[:space:]]+)?([^[:space:]]*/)?(jython|pypy-c|python)'
479
480# @FUNCTION: python_convert_shebangs
481# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_ABI|Python_version> <file|directory> [files|directories]
482# @DESCRIPTION:
483# Convert shebangs in specified files. Directories can be specified only with --recursive option.
484python_convert_shebangs() {
485 _python_check_python_pkg_setup_execution
486
487 local argument file files=() only_executables="0" python_interpreter quiet="0" recursive="0" shebangs_converted="0"
488
489 while (($#)); do
490 case "$1" in
491 -r|--recursive)
492 recursive="1"
493 ;;
494 -q|--quiet)
495 quiet="1"
496 ;;
497 -x|--only-executables)
498 only_executables="1"
499 ;;
500 --)
501 shift
502 break
503 ;;
504 -*)
505 die "${FUNCNAME}(): Unrecognized option '$1'"
506 ;;
507 *)
508 break
509 ;;
510 esac
511 shift
512 done
513
514 if [[ "$#" -eq 0 ]]; then
515 die "${FUNCNAME}(): Missing Python version and files or directories"
516 elif [[ "$#" -eq 1 ]]; then
517 die "${FUNCNAME}(): Missing files or directories"
518 fi
519
520 if [[ -n "$(_python_get_implementation --ignore-invalid "$1")" ]]; then
521 python_interpreter="$(PYTHON "$1")"
522 else
523 python_interpreter="python$1"
524 fi
525 shift
526
527 for argument in "$@"; do
528 if [[ ! -e "${argument}" ]]; then
529 die "${FUNCNAME}(): '${argument}' does not exist"
530 elif [[ -f "${argument}" ]]; then
531 files+=("${argument}")
532 elif [[ -d "${argument}" ]]; then
533 if [[ "${recursive}" == "1" ]]; then
534 while read -d $'\0' -r file; do
535 files+=("${file}")
536 done < <(find "${argument}" $([[ "${only_executables}" == "1" ]] && echo -perm /111) -type f -print0)
537 else
538 die "${FUNCNAME}(): '${argument}' is not a regular file"
539 fi
540 else
541 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory"
542 fi
543 done
544
545 for file in "${files[@]}"; do
546 file="${file#./}"
547 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
548
549 if [[ "$(head -n1 "${file}")" =~ ${_PYTHON_SHEBANG_BASE_PART_REGEX} ]]; then
550 [[ "$(sed -ne "2p" "${file}")" =~ ^"# Gentoo '".*"' wrapper script generated by python_generate_wrapper_scripts()"$ ]] && continue
551
552 shebangs_converted="1"
553
554 if [[ "${quiet}" == "0" ]]; then
555 einfo "Converting shebang in '${file}'"
556 fi
557
558 sed -e "1s:^#![[:space:]]*\([^[:space:]]*/usr/bin/env[[:space:]]\)\?[[:space:]]*\([^[:space:]]*/\)\?\(jython\|pypy-c\|python\)\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?\(\$\|[[:space:]].*\):#!\1\2${python_interpreter}\6:" -i "${file}" || die "Conversion of shebang in '${file}' failed"
559 fi
560 done
561
562 if [[ "${shebangs_converted}" == "0" ]]; then
563 ewarn "${FUNCNAME}(): Python scripts not found"
564 fi
565}
566
567# @FUNCTION: python_clean_py-compile_files
568# @USAGE: [-q|--quiet]
569# @DESCRIPTION:
570# Clean py-compile files to disable byte-compilation.
571python_clean_py-compile_files() {
572 _python_check_python_pkg_setup_execution
573
574 local file files=() quiet="0"
575
576 while (($#)); do
577 case "$1" in
578 -q|--quiet)
579 quiet="1"
580 ;;
581 -*)
582 die "${FUNCNAME}(): Unrecognized option '$1'"
583 ;;
584 *)
585 die "${FUNCNAME}(): Invalid usage"
586 ;;
587 esac
588 shift
589 done
590
591 while read -d $'\0' -r file; do
592 files+=("${file#./}")
593 done < <(find -name py-compile -type f -print0)
594
595 for file in "${files[@]}"; do
596 if [[ "${quiet}" == "0" ]]; then
597 einfo "Cleaning '${file}' file"
598 fi
599 echo "#!/bin/sh" > "${file}"
600 done
601}
602
603# @FUNCTION: python_clean_installation_image
604# @USAGE: [-q|--quiet]
605# @DESCRIPTION:
606# Delete needless files in installation image.
607#
608# This function can be used only in src_install() phase.
609python_clean_installation_image() {
610 if [[ "${EBUILD_PHASE}" != "install" ]]; then
611 die "${FUNCNAME}() can be used only in src_install() phase"
612 fi
613
614 _python_check_python_pkg_setup_execution
615 _python_initialize_prefix_variables
616
617 local file files=() quiet="0"
618
619 while (($#)); do
620 case "$1" in
621 -q|--quiet)
622 quiet="1"
623 ;;
624 -*)
625 die "${FUNCNAME}(): Unrecognized option '$1'"
626 ;;
627 *)
628 die "${FUNCNAME}(): Invalid usage"
629 ;;
630 esac
631 shift
632 done
633
634 while read -d $'\0' -r file; do
635 files+=("${file}")
636 done < <(find "${ED}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -type f -print0)
637
638 if [[ "${#files[@]}" -gt 0 ]]; then
639 if [[ "${quiet}" == "0" ]]; then
640 ewarn "Deleting byte-compiled Python modules needlessly generated by build system:"
641 fi
642 for file in "${files[@]}"; do
643 if [[ "${quiet}" == "0" ]]; then
644 ewarn " ${file}"
645 fi
646 rm -f "${file}"
647
648 # Delete empty __pycache__ directories.
649 if [[ "${file%/*}" == *"/__pycache__" ]]; then
650 rmdir "${file%/*}" 2> /dev/null
651 fi
652 done
653 fi
654
655 python_clean_sitedirs() {
656 if [[ -d "${ED}$(python_get_sitedir)" ]]; then
657 find "${ED}$(python_get_sitedir)" "(" -name "*.c" -o -name "*.h" -o -name "*.la" ")" -type f -print0 | xargs -0 rm -f
658 fi
659 }
660 if _python_package_supporting_installation_for_multiple_python_abis; then
661 python_execute_function -q python_clean_sitedirs
662 else
663 python_clean_sitedirs
664 fi
665
666 unset -f python_clean_sitedirs
667}
668
669# ================================================================================================
670# =========== FUNCTIONS FOR PACKAGES SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ============
671# ================================================================================================
672
673# @ECLASS-VARIABLE: SUPPORT_PYTHON_ABIS
674# @DESCRIPTION:
675# Set this in EAPI <= 4 to indicate that current package supports installation for
676# multiple Python ABIs.
677
678# @ECLASS-VARIABLE: PYTHON_TESTS_RESTRICTED_ABIS
679# @DESCRIPTION:
680# Space-separated list of Python ABI patterns. Testing in Python ABIs matching any Python ABI
681# patterns specified in this list is skipped.
682
683# @ECLASS-VARIABLE: PYTHON_EXPORT_PHASE_FUNCTIONS
684# @DESCRIPTION:
685# Set this to export phase functions for the following ebuild phases:
686# src_prepare(), src_configure(), src_compile(), src_test(), src_install().
687if ! has "${EAPI:-0}" 0 1; then
688 python_src_prepare() {
689 if [[ "${EBUILD_PHASE}" != "prepare" ]]; then
690 die "${FUNCNAME}() can be used only in src_prepare() phase"
691 fi
692
693 if ! _python_package_supporting_installation_for_multiple_python_abis; then
694 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
695 fi
696
697 _python_check_python_pkg_setup_execution
698
699 if [[ "$#" -ne 0 ]]; then
700 die "${FUNCNAME}() does not accept arguments"
701 fi
702
703 python_copy_sources
704 }
705
706 for python_default_function in src_configure src_compile src_test; do
707 eval "python_${python_default_function}() {
708 if [[ \"\${EBUILD_PHASE}\" != \"${python_default_function#src_}\" ]]; then
709 die \"\${FUNCNAME}() can be used only in ${python_default_function}() phase\"
710 fi
711
712 if ! _python_package_supporting_installation_for_multiple_python_abis; then
713 die \"\${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs\"
714 fi
715
716 _python_check_python_pkg_setup_execution
717
718 python_execute_function -d -s -- \"\$@\"
719 }"
720 done
721 unset python_default_function
722
723 python_src_install() {
724 if [[ "${EBUILD_PHASE}" != "install" ]]; then
725 die "${FUNCNAME}() can be used only in src_install() phase"
726 fi
727
728 if ! _python_package_supporting_installation_for_multiple_python_abis; then
729 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
730 fi
731
732 _python_check_python_pkg_setup_execution
733
734 if has "${EAPI:-0}" 0 1 2 3; then
735 python_execute_function -d -s -- "$@"
736 else
737 python_installation() {
738 emake DESTDIR="${T}/images/${PYTHON_ABI}" install "$@"
739 }
740 python_execute_function -s python_installation "$@"
741 unset python_installation
742
743 python_merge_intermediate_installation_images "${T}/images"
744 fi
745 }
746
747 if [[ -n "${PYTHON_EXPORT_PHASE_FUNCTIONS}" ]]; then
748 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install
749 fi
750fi
751
752if has "${EAPI:-0}" 0 1 2 3 4; then
753 unset PYTHON_ABIS
754fi
755
756_python_calculate_PYTHON_ABIS() {
757 if ! _python_package_supporting_installation_for_multiple_python_abis; then
758 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
759 fi
760
761 _python_initial_sanity_checks
762
763 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3 4; then
764 local PYTHON_ABI
765
766 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
767 local cpython_enabled="0"
768
769 if [[ -z "${USE_PYTHON}" ]]; then
770 die "USE_PYTHON variable is empty"
771 fi
772
773 for PYTHON_ABI in ${USE_PYTHON}; do
774 if ! has "${PYTHON_ABI}" "${_PYTHON_GLOBALLY_SUPPORTED_ABIS[@]}"; then
775 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'"
776 fi
777
778 if has "${PYTHON_ABI}" "${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}" "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}"; then
779 cpython_enabled="1"
780 fi
781
782 if ! _python_check_python_abi_matching --patterns-list "${PYTHON_ABI}" "${RESTRICT_PYTHON_ABIS}"; then
783 export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}"
784 fi
785 done
786
787 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then
788 die "USE_PYTHON variable does not enable any Python ABI supported by ${CATEGORY}/${PF}"
789 fi
790
791 if [[ "${cpython_enabled}" == "0" ]]; then
792 die "USE_PYTHON variable does not enable any CPython ABI"
793 fi
794 else
795 local python_version python2_version python3_version support_python_major_version
796
797 if ! has_version "dev-lang/python"; then
798 die "${FUNCNAME}(): 'dev-lang/python' is not installed"
799 fi
800
801 python_version="$("${EPREFIX}/usr/bin/python" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
802
803 if has_version "=dev-lang/python-2*"; then
804 if [[ "$(readlink "${EPREFIX}/usr/bin/python2")" != "python2."* ]]; then
805 die "'${EPREFIX}/usr/bin/python2' is not valid symlink"
806 fi
807
808 python2_version="$("${EPREFIX}/usr/bin/python2" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
809
810 support_python_major_version="0"
811 for PYTHON_ABI in "${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}"; do
812 if ! _python_check_python_abi_matching --patterns-list "${PYTHON_ABI}" "${RESTRICT_PYTHON_ABIS}"; then
813 support_python_major_version="1"
814 break
815 fi
816 done
817 if [[ "${support_python_major_version}" == "1" ]]; then
818 if _python_check_python_abi_matching --patterns-list "${python2_version}" "${RESTRICT_PYTHON_ABIS}"; then
819 die "Active version of CPython 2 is not supported by ${CATEGORY}/${PF}"
820 fi
821 else
822 python2_version=""
823 fi
824 fi
825
826 if has_version "=dev-lang/python-3*"; then
827 if [[ "$(readlink "${EPREFIX}/usr/bin/python3")" != "python3."* ]]; then
828 die "'${EPREFIX}/usr/bin/python3' is not valid symlink"
829 fi
830
831 python3_version="$("${EPREFIX}/usr/bin/python3" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
832
833 support_python_major_version="0"
834 for PYTHON_ABI in "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}"; do
835 if ! _python_check_python_abi_matching --patterns-list "${PYTHON_ABI}" "${RESTRICT_PYTHON_ABIS}"; then
836 support_python_major_version="1"
837 break
838 fi
839 done
840 if [[ "${support_python_major_version}" == "1" ]]; then
841 if _python_check_python_abi_matching --patterns-list "${python3_version}" "${RESTRICT_PYTHON_ABIS}"; then
842 die "Active version of CPython 3 is not supported by ${CATEGORY}/${PF}"
843 fi
844 else
845 python3_version=""
846 fi
847 fi
848
849 if [[ -z "${python2_version}" && -z "${python3_version}" ]]; then
850 eerror "${CATEGORY}/${PF} requires at least one of the following packages:"
851 for PYTHON_ABI in "${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}" "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}"; do
852 if ! _python_check_python_abi_matching --patterns-list "${PYTHON_ABI}" "${RESTRICT_PYTHON_ABIS}"; then
853 eerror " dev-lang/python:${PYTHON_ABI}"
854 fi
855 done
856 die "No supported version of CPython installed"
857 fi
858
859 if [[ -n "${python2_version}" && "${python_version}" == "2."* && "${python_version}" != "${python2_version}" ]]; then
860 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python2' symlink"
861 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
862 die "Incorrect configuration of Python"
863 fi
864 if [[ -n "${python3_version}" && "${python_version}" == "3."* && "${python_version}" != "${python3_version}" ]]; then
865 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python3' symlink"
866 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
867 die "Incorrect configuration of Python"
868 fi
869
870 PYTHON_ABIS="${python2_version} ${python3_version}"
871 PYTHON_ABIS="${PYTHON_ABIS# }"
872 export PYTHON_ABIS="${PYTHON_ABIS% }"
873 fi
874 fi
875
876 _python_final_sanity_checks
877}
878
879_python_prepare_flags() {
880 local array=() deleted_flag element flags new_value old_flag old_value operator pattern prefix variable
881
882 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
883 eval "_PYTHON_SAVED_${variable}=\"\${!variable}\""
884 for prefix in PYTHON_USER_ PYTHON_; do
885 if [[ "$(declare -p ${prefix}${variable} 2> /dev/null)" == "declare -a ${prefix}${variable}="* ]]; then
886 eval "array=(\"\${${prefix}${variable}[@]}\")"
887 for element in "${array[@]}"; do
888 if [[ "${element}" =~ ^${_PYTHON_ABI_PATTERN_REGEX}\ (\+|-)\ .+ ]]; then
889 pattern="${element%% *}"
890 element="${element#* }"
891 operator="${element%% *}"
892 flags="${element#* }"
893 if _python_check_python_abi_matching "${PYTHON_ABI}" "${pattern}"; then
894 if [[ "${operator}" == "+" ]]; then
895 eval "export ${variable}+=\"\${variable:+ }${flags}\""
896 elif [[ "${operator}" == "-" ]]; then
897 flags="${flags// /$'\n'}"
898 old_value="${!variable// /$'\n'}"
899 new_value=""
900 while read old_flag; do
901 while read deleted_flag; do
902 if [[ "${old_flag}" == ${deleted_flag} ]]; then
903 continue 2
904 fi
905 done <<< "${flags}"
906 new_value+="${new_value:+ }${old_flag}"
907 done <<< "${old_value}"
908 eval "export ${variable}=\"\${new_value}\""
909 fi
910 fi
911 else
912 die "Element '${element}' of ${prefix}${variable} array has invalid syntax"
913 fi
914 done
915 elif [[ -n "$(declare -p ${prefix}${variable} 2> /dev/null)" ]]; then
916 die "${prefix}${variable} should be indexed array"
917 fi
918 done
919 done
920}
921
922_python_restore_flags() {
923 local variable
924
925 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
926 eval "${variable}=\"\${_PYTHON_SAVED_${variable}}\""
927 unset _PYTHON_SAVED_${variable}
928 done
929}
930
931# @FUNCTION: python_execute_function
932# @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [-f|--final-ABI] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--source-dir source_directory] [--] <function> [arguments]
933# @DESCRIPTION:
934# Execute specified function for each value of PYTHON_ABIS, optionally passing additional
935# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
936python_execute_function() {
937 if ! _python_package_supporting_installation_for_multiple_python_abis; then
938 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
939 fi
940
941 _python_check_python_pkg_setup_execution
942 _python_set_color_variables
943
944 local action action_message action_message_template default_function="0" failure_message failure_message_template final_ABI="0" function iterated_PYTHON_ABIS nonfatal="0" previous_directory previous_directory_stack previous_directory_stack_length PYTHON_ABI quiet="0" return_code separate_build_dirs="0" source_dir
945
946 while (($#)); do
947 case "$1" in
948 --action-message)
949 action_message_template="$2"
950 shift
951 ;;
952 -d|--default-function)
953 default_function="1"
954 ;;
955 --failure-message)
956 failure_message_template="$2"
957 shift
958 ;;
959 -f|--final-ABI)
960 final_ABI="1"
961 ;;
962 --nonfatal)
963 nonfatal="1"
964 ;;
965 -q|--quiet)
966 quiet="1"
967 ;;
968 -s|--separate-build-dirs)
969 separate_build_dirs="1"
970 ;;
971 --source-dir)
972 source_dir="$2"
973 shift
974 ;;
975 --)
976 shift
977 break
978 ;;
979 -*)
980 die "${FUNCNAME}(): Unrecognized option '$1'"
981 ;;
982 *)
983 break
984 ;;
985 esac
986 shift
987 done
988
989 if [[ -n "${source_dir}" && "${separate_build_dirs}" == 0 ]]; then
990 die "${FUNCNAME}(): '--source-dir' option can be specified only with '--separate-build-dirs' option"
991 fi
992
993 if [[ "${default_function}" == "0" ]]; then
994 if [[ "$#" -eq 0 ]]; then
995 die "${FUNCNAME}(): Missing function name"
996 fi
997 function="$1"
998 shift
999
1000 if [[ -z "$(type -t "${function}")" ]]; then
1001 die "${FUNCNAME}(): '${function}' function is not defined"
1002 fi
1003 else
1004 if has "${EAPI:-0}" 0 1; then
1005 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
1006 fi
1007
1008 if [[ "${EBUILD_PHASE}" == "configure" ]]; then
1009 if has "${EAPI}" 2 3; then
1010 python_default_function() {
1011 econf "$@"
1012 }
1013 else
1014 python_default_function() {
1015 nonfatal econf "$@"
1016 }
1017 fi
1018 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then
1019 python_default_function() {
1020 emake "$@"
1021 }
1022 elif [[ "${EBUILD_PHASE}" == "test" ]]; then
1023 python_default_function() {
1024 if emake -j1 -n check &> /dev/null; then
1025 emake -j1 check "$@"
1026 elif emake -j1 -n test &> /dev/null; then
1027 emake -j1 test "$@"
1028 fi
1029 }
1030 elif [[ "${EBUILD_PHASE}" == "install" ]]; then
1031 python_default_function() {
1032 emake DESTDIR="${D}" install "$@"
1033 }
1034 else
1035 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase"
1036 fi
1037 function="python_default_function"
1038 fi
1039
1040 # Ensure that python_execute_function() cannot be directly or indirectly called by python_execute_function().
1041 if _python_abi-specific_local_scope; then
1042 die "${FUNCNAME}(): Invalid call stack"
1043 fi
1044
1045 if [[ "${quiet}" == "0" ]]; then
1046 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up"
1047 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking"
1048 [[ "${EBUILD_PHASE}" == "prepare" ]] && action="Preparation"
1049 [[ "${EBUILD_PHASE}" == "configure" ]] && action="Configuration"
1050 [[ "${EBUILD_PHASE}" == "compile" ]] && action="Building"
1051 [[ "${EBUILD_PHASE}" == "test" ]] && action="Testing"
1052 [[ "${EBUILD_PHASE}" == "install" ]] && action="Installation"
1053 [[ "${EBUILD_PHASE}" == "preinst" ]] && action="Preinstallation"
1054 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation"
1055 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation"
1056 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation"
1057 fi
1058
1059 _python_calculate_PYTHON_ABIS
1060 if [[ "${final_ABI}" == "1" ]]; then
1061 iterated_PYTHON_ABIS="$(PYTHON -f --ABI)"
1062 else
1063 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
1064 fi
1065 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
1066 if [[ "${EBUILD_PHASE}" == "test" ]] && _python_check_python_abi_matching --patterns-list "${PYTHON_ABI}" "${PYTHON_TESTS_RESTRICTED_ABIS}"; then
1067 if [[ "${quiet}" == "0" ]]; then
1068 echo " ${_GREEN}*${_NORMAL} ${_BLUE}Testing of ${CATEGORY}/${PF} with $(python_get_implementation_and_version) skipped${_NORMAL}"
1069 fi
1070 continue
1071 fi
1072
1073 _python_prepare_flags
1074
1075 if [[ "${quiet}" == "0" ]]; then
1076 if [[ -n "${action_message_template}" ]]; then
1077 eval "action_message=\"${action_message_template}\""
1078 else
1079 action_message="${action} of ${CATEGORY}/${PF} with $(python_get_implementation_and_version)..."
1080 fi
1081 echo " ${_GREEN}*${_NORMAL} ${_BLUE}${action_message}${_NORMAL}"
1082 fi
1083
1084 if [[ "${separate_build_dirs}" == "1" ]]; then
1085 if [[ -n "${source_dir}" ]]; then
1086 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}"
1087 else
1088 export BUILDDIR="${S}-${PYTHON_ABI}"
1089 fi
1090 pushd "${BUILDDIR}" > /dev/null || die "pushd failed"
1091 else
1092 export BUILDDIR="${S}"
1093 fi
1094
1095 previous_directory="$(pwd)"
1096 previous_directory_stack="$(dirs -p)"
1097 previous_directory_stack_length="$(dirs -p | wc -l)"
1098
1099 if ! has "${EAPI}" 0 1 2 3 && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
1100 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@"
1101 else
1102 EPYTHON="$(PYTHON)" "${function}" "$@"
1103 fi
1104
1105 return_code="$?"
1106
1107 _python_restore_flags
1108
1109 if [[ "${return_code}" -ne 0 ]]; then
1110 if [[ -n "${failure_message_template}" ]]; then
1111 eval "failure_message=\"${failure_message_template}\""
1112 else
1113 failure_message="${action} failed with $(python_get_implementation_and_version) in ${function}() function"
1114 fi
1115
1116 if [[ "${nonfatal}" == "1" ]]; then
1117 if [[ "${quiet}" == "0" ]]; then
1118 ewarn "${failure_message}"
1119 fi
1120 elif [[ "${final_ABI}" == "0" ]] && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
1121 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then
1122 local enabled_PYTHON_ABIS= other_PYTHON_ABI
1123 for other_PYTHON_ABI in ${PYTHON_ABIS}; do
1124 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}"
1125 done
1126 export PYTHON_ABIS="${enabled_PYTHON_ABIS}"
1127 fi
1128 if [[ "${quiet}" == "0" ]]; then
1129 ewarn "${failure_message}"
1130 fi
1131 if [[ -z "${PYTHON_ABIS}" ]]; then
1132 die "${function}() function failed with all enabled Python ABIs"
1133 fi
1134 else
1135 die "${failure_message}"
1136 fi
1137 fi
1138
1139 # Ensure that directory stack has not been decreased.
1140 if [[ "$(dirs -p | wc -l)" -lt "${previous_directory_stack_length}" ]]; then
1141 die "Directory stack decreased illegally"
1142 fi
1143
1144 # Avoid side effects of earlier returning from the specified function.
1145 while [[ "$(dirs -p | wc -l)" -gt "${previous_directory_stack_length}" ]]; do
1146 popd > /dev/null || die "popd failed"
1147 done
1148
1149 # Ensure that the bottom part of directory stack has not been changed. Restore
1150 # previous directory (from before running of the specified function) before
1151 # comparison of directory stacks to avoid mismatch of directory stacks after
1152 # potential using of 'cd' to change current directory. Restoration of previous
1153 # directory allows to safely use 'cd' to change current directory in the
1154 # specified function without changing it back to original directory.
1155 cd "${previous_directory}"
1156 if [[ "$(dirs -p)" != "${previous_directory_stack}" ]]; then
1157 die "Directory stack changed illegally"
1158 fi
1159
1160 if [[ "${separate_build_dirs}" == "1" ]]; then
1161 popd > /dev/null || die "popd failed"
1162 fi
1163 unset BUILDDIR
1164 done
1165
1166 if [[ "${default_function}" == "1" ]]; then
1167 unset -f python_default_function
1168 fi
1169}
1170
1171# @FUNCTION: python_copy_sources
1172# @USAGE: <directory="${S}"> [directory]
1173# @DESCRIPTION:
1174# Copy unpacked sources of current package to separate build directory for each Python ABI.
1175python_copy_sources() {
1176 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1177 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1178 fi
1179
1180 _python_check_python_pkg_setup_execution
1181
1182 local dir dirs=() PYTHON_ABI
1183
1184 if [[ "$#" -eq 0 ]]; then
1185 if [[ "${WORKDIR}" == "${S}" ]]; then
1186 die "${FUNCNAME}() cannot be used with current value of S variable"
1187 fi
1188 dirs=("${S%/}")
1189 else
1190 dirs=("$@")
1191 fi
1192
1193 _python_calculate_PYTHON_ABIS
1194 for PYTHON_ABI in ${PYTHON_ABIS}; do
1195 for dir in "${dirs[@]}"; do
1196 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
1197 done
1198 done
1199}
1200
1201# @FUNCTION: python_generate_wrapper_scripts
1202# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files]
1203# @DESCRIPTION:
1204# Generate wrapper scripts. Existing files are overwritten only with --force option.
1205# If --respect-EPYTHON option is specified, then generated wrapper scripts will
1206# respect EPYTHON variable at run time.
1207#
1208# This function can be used only in src_install() phase.
1209python_generate_wrapper_scripts() {
1210 if [[ "${EBUILD_PHASE}" != "install" ]]; then
1211 die "${FUNCNAME}() can be used only in src_install() phase"
1212 fi
1213
1214 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1215 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1216 fi
1217
1218 _python_check_python_pkg_setup_execution
1219 _python_initialize_prefix_variables
1220
1221 local eselect_python_option file force="0" quiet="0" PYTHON_ABI PYTHON_ABIS_list python2_enabled="0" python3_enabled="0" respect_EPYTHON="0"
1222
1223 while (($#)); do
1224 case "$1" in
1225 -E|--respect-EPYTHON)
1226 respect_EPYTHON="1"
1227 ;;
1228 -f|--force)
1229 force="1"
1230 ;;
1231 -q|--quiet)
1232 quiet="1"
1233 ;;
1234 --)
1235 shift
1236 break
1237 ;;
1238 -*)
1239 die "${FUNCNAME}(): Unrecognized option '$1'"
1240 ;;
1241 *)
1242 break
1243 ;;
1244 esac
1245 shift
1246 done
1247
1248 if [[ "$#" -eq 0 ]]; then
1249 die "${FUNCNAME}(): Missing arguments"
1250 fi
1251
1252 _python_calculate_PYTHON_ABIS
1253 for PYTHON_ABI in "${_CPYTHON2_GLOBALLY_SUPPORTED_ABIS[@]}"; do
1254 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
1255 python2_enabled="1"
1256 fi
1257 done
1258 for PYTHON_ABI in "${_CPYTHON3_GLOBALLY_SUPPORTED_ABIS[@]}"; do
1259 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
1260 python3_enabled="1"
1261 fi
1262 done
1263
1264 if [[ "${python2_enabled}" == "1" && "${python3_enabled}" == "1" ]]; then
1265 eselect_python_option=
1266 elif [[ "${python2_enabled}" == "1" && "${python3_enabled}" == "0" ]]; then
1267 eselect_python_option="--python2"
1268 elif [[ "${python2_enabled}" == "0" && "${python3_enabled}" == "1" ]]; then
1269 eselect_python_option="--python3"
1270 else
1271 die "${FUNCNAME}(): Unsupported environment"
1272 fi
1273
1274 PYTHON_ABIS_list="$("$(PYTHON -f)" -c "print(', '.join('\"%s\"' % x for x in reversed('${PYTHON_ABIS}'.split())))")"
1275
1276 for file in "$@"; do
1277 if [[ -f "${file}" && "${force}" == "0" ]]; then
1278 die "${FUNCNAME}(): '${file}' already exists"
1279 fi
1280
1281 if [[ "${quiet}" == "0" ]]; then
1282 einfo "Generating '${file#${ED%/}}' wrapper script"
1283 fi
1284
1285 cat << EOF > "${file}"
1286#!/usr/bin/env python
1287# Gentoo '${file##*/}' wrapper script generated by python_generate_wrapper_scripts()
1288
1289import os
1290import re
1291import subprocess
1292import sys
1293
1294cpython_ABI_re = re.compile(r"^(\d+\.\d+)$")
1295jython_ABI_re = re.compile(r"^(\d+\.\d+)-jython$")
1296pypy_ABI_re = re.compile(r"^\d+\.\d+-pypy-(\d+\.\d+)$")
1297cpython_interpreter_re = re.compile(r"^python(\d+\.\d+)$")
1298jython_interpreter_re = re.compile(r"^jython(\d+\.\d+)$")
1299pypy_interpreter_re = re.compile(r"^pypy-c(\d+\.\d+)$")
1300cpython_shebang_re = re.compile(r"^#![ \t]*(?:${EPREFIX}/usr/bin/python|(?:${EPREFIX})?/usr/bin/env[ \t]+(?:${EPREFIX}/usr/bin/)?python)")
1301python_shebang_options_re = re.compile(r"^#![ \t]*${EPREFIX}/usr/bin/(?:jython|pypy-c|python)(?:\d+(?:\.\d+)?)?[ \t]+(-\S)")
1302python_verification_output_re = re.compile("^GENTOO_PYTHON_TARGET_SCRIPT_PATH supported\n$")
1303
1304pypy_versions_mapping = {
1305 "1.5": "2.7"
1306}
1307
1308def get_PYTHON_ABI(python_interpreter):
1309 cpython_matched = cpython_interpreter_re.match(python_interpreter)
1310 jython_matched = jython_interpreter_re.match(python_interpreter)
1311 pypy_matched = pypy_interpreter_re.match(python_interpreter)
1312 if cpython_matched is not None:
1313 PYTHON_ABI = cpython_matched.group(1)
1314 elif jython_matched is not None:
1315 PYTHON_ABI = jython_matched.group(1) + "-jython"
1316 elif pypy_matched is not None:
1317 PYTHON_ABI = pypy_versions_mapping[pypy_matched.group(1)] + "-pypy-" + pypy_matched.group(1)
1318 else:
1319 PYTHON_ABI = None
1320 return PYTHON_ABI
1321
1322def get_python_interpreter(PYTHON_ABI):
1323 cpython_matched = cpython_ABI_re.match(PYTHON_ABI)
1324 jython_matched = jython_ABI_re.match(PYTHON_ABI)
1325 pypy_matched = pypy_ABI_re.match(PYTHON_ABI)
1326 if cpython_matched is not None:
1327 python_interpreter = "python" + cpython_matched.group(1)
1328 elif jython_matched is not None:
1329 python_interpreter = "jython" + jython_matched.group(1)
1330 elif pypy_matched is not None:
1331 python_interpreter = "pypy-c" + pypy_matched.group(1)
1332 else:
1333 python_interpreter = None
1334 return python_interpreter
1335
1336EOF
1337 if [[ "$?" != "0" ]]; then
1338 die "${FUNCNAME}(): Generation of '$1' failed"
1339 fi
1340 if [[ "${respect_EPYTHON}" == "1" ]]; then
1341 cat << EOF >> "${file}"
1342python_interpreter = os.environ.get("EPYTHON")
1343if python_interpreter:
1344 PYTHON_ABI = get_PYTHON_ABI(python_interpreter)
1345 if PYTHON_ABI is None:
1346 sys.stderr.write("%s: EPYTHON variable has unrecognized value '%s'\n" % (sys.argv[0], python_interpreter))
1347 sys.exit(1)
1348else:
1349 try:
1350 environment = os.environ.copy()
1351 environment["ROOT"] = "/"
1352 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], env=environment, stdout=subprocess.PIPE)
1353 if eselect_process.wait() != 0:
1354 raise ValueError
1355 except (OSError, ValueError):
1356 sys.stderr.write("%s: Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n" % sys.argv[0])
1357 sys.exit(1)
1358
1359 python_interpreter = eselect_process.stdout.read()
1360 if not isinstance(python_interpreter, str):
1361 # Python 3
1362 python_interpreter = python_interpreter.decode()
1363 python_interpreter = python_interpreter.rstrip("\n")
1364
1365 PYTHON_ABI = get_PYTHON_ABI(python_interpreter)
1366 if PYTHON_ABI is None:
1367 sys.stderr.write("%s: 'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % (sys.argv[0], python_interpreter))
1368 sys.exit(1)
1369
1370wrapper_script_path = os.path.realpath(sys.argv[0])
1371target_executable_path = "%s-%s" % (wrapper_script_path, PYTHON_ABI)
1372if not os.path.exists(target_executable_path):
1373 sys.stderr.write("%s: '%s' does not exist\n" % (sys.argv[0], target_executable_path))
1374 sys.exit(1)
1375EOF
1376 if [[ "$?" != "0" ]]; then
1377 die "${FUNCNAME}(): Generation of '$1' failed"
1378 fi
1379 else
1380 cat << EOF >> "${file}"
1381try:
1382 environment = os.environ.copy()
1383 environment["ROOT"] = "/"
1384 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], env=environment, stdout=subprocess.PIPE)
1385 if eselect_process.wait() != 0:
1386 raise ValueError
1387except (OSError, ValueError):
1388 sys.stderr.write("%s: Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n" % sys.argv[0])
1389 sys.exit(1)
1390
1391python_interpreter = eselect_process.stdout.read()
1392if not isinstance(python_interpreter, str):
1393 # Python 3
1394 python_interpreter = python_interpreter.decode()
1395python_interpreter = python_interpreter.rstrip("\n")
1396
1397PYTHON_ABI = get_PYTHON_ABI(python_interpreter)
1398if PYTHON_ABI is None:
1399 sys.stderr.write("%s: 'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % (sys.argv[0], python_interpreter))
1400 sys.exit(1)
1401
1402wrapper_script_path = os.path.realpath(sys.argv[0])
1403for PYTHON_ABI in [PYTHON_ABI, ${PYTHON_ABIS_list}]:
1404 target_executable_path = "%s-%s" % (wrapper_script_path, PYTHON_ABI)
1405 if os.path.exists(target_executable_path):
1406 break
1407else:
1408 sys.stderr.write("%s: No target script exists for '%s'\n" % (sys.argv[0], wrapper_script_path))
1409 sys.exit(1)
1410
1411python_interpreter = get_python_interpreter(PYTHON_ABI)
1412if python_interpreter is None:
1413 sys.stderr.write("%s: Unrecognized Python ABI '%s'\n" % (sys.argv[0], PYTHON_ABI))
1414 sys.exit(1)
1415EOF
1416 if [[ "$?" != "0" ]]; then
1417 die "${FUNCNAME}(): Generation of '$1' failed"
1418 fi
1419 fi
1420 cat << EOF >> "${file}"
1421
1422target_executable = open(target_executable_path, "rb")
1423target_executable_first_line = target_executable.readline()
1424target_executable.close()
1425if not isinstance(target_executable_first_line, str):
1426 # Python 3
1427 target_executable_first_line = target_executable_first_line.decode("utf_8", "replace")
1428
1429options = []
1430python_shebang_options_matched = python_shebang_options_re.match(target_executable_first_line)
1431if python_shebang_options_matched is not None:
1432 options = [python_shebang_options_matched.group(1)]
1433
1434cpython_shebang_matched = cpython_shebang_re.match(target_executable_first_line)
1435
1436if cpython_shebang_matched is not None:
1437 try:
1438 python_interpreter_path = "${EPREFIX}/usr/bin/%s" % python_interpreter
1439 os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"] = "1"
1440 python_verification_process = subprocess.Popen([python_interpreter_path, "-c", "pass"], stdout=subprocess.PIPE)
1441 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
1442 if python_verification_process.wait() != 0:
1443 raise ValueError
1444
1445 python_verification_output = python_verification_process.stdout.read()
1446 if not isinstance(python_verification_output, str):
1447 # Python 3
1448 python_verification_output = python_verification_output.decode()
1449
1450 if not python_verification_output_re.match(python_verification_output):
1451 raise ValueError
1452
1453 if cpython_interpreter_re.match(python_interpreter) is not None:
1454 os.environ["GENTOO_PYTHON_PROCESS_NAME"] = os.path.basename(sys.argv[0])
1455 os.environ["GENTOO_PYTHON_WRAPPER_SCRIPT_PATH"] = sys.argv[0]
1456 os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH"] = target_executable_path
1457
1458 if hasattr(os, "execv"):
1459 os.execv(python_interpreter_path, [python_interpreter_path] + options + sys.argv)
1460 else:
1461 sys.exit(subprocess.Popen([python_interpreter_path] + options + sys.argv).wait())
1462 except (KeyboardInterrupt, SystemExit):
1463 raise
1464 except:
1465 pass
1466 for variable in ("GENTOO_PYTHON_PROCESS_NAME", "GENTOO_PYTHON_WRAPPER_SCRIPT_PATH", "GENTOO_PYTHON_TARGET_SCRIPT_PATH", "GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"):
1467 if variable in os.environ:
1468 del os.environ[variable]
1469
1470if hasattr(os, "execv"):
1471 os.execv(target_executable_path, sys.argv)
1472else:
1473 sys.exit(subprocess.Popen([target_executable_path] + sys.argv[1:]).wait())
1474EOF
1475 if [[ "$?" != "0" ]]; then
1476 die "${FUNCNAME}(): Generation of '$1' failed"
1477 fi
1478 fperms +x "${file#${ED%/}}" || die "fperms '${file}' failed"
1479 done
1480}
1481
1482# @ECLASS-VARIABLE: PYTHON_VERSIONED_SCRIPTS
1483# @DESCRIPTION:
1484# Array of regular expressions of paths to versioned Python scripts.
1485# Python scripts in /usr/bin and /usr/sbin are versioned by default.
1486
1487# @ECLASS-VARIABLE: PYTHON_VERSIONED_EXECUTABLES
1488# @DESCRIPTION:
1489# Array of regular expressions of paths to versioned executables (including Python scripts).
1490
1491# @ECLASS-VARIABLE: PYTHON_NONVERSIONED_EXECUTABLES
1492# @DESCRIPTION:
1493# Array of regular expressions of paths to nonversioned executables (including Python scripts).
1494
1495# @FUNCTION: python_merge_intermediate_installation_images
1496# @USAGE: [-q|--quiet] [--] <intermediate_installation_images_directory>
1497# @DESCRIPTION:
1498# Merge intermediate installation images into installation image.
1499#
1500# This function can be used only in src_install() phase.
1501python_merge_intermediate_installation_images() {
1502 if [[ "${EBUILD_PHASE}" != "install" ]]; then
1503 die "${FUNCNAME}() can be used only in src_install() phase"
1504 fi
1505
1506 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1507 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1508 fi
1509
1510 _python_check_python_pkg_setup_execution
1511 _python_initialize_prefix_variables
1512
1513 local absolute_file b file files=() intermediate_installation_images_directory PYTHON_ABI quiet="0" regex shebang version_executable wrapper_scripts=() wrapper_scripts_set=()
1514
1515 while (($#)); do
1516 case "$1" in
1517 -q|--quiet)
1518 quiet="1"
1519 ;;
1520 --)
1521 shift
1522 break
1523 ;;
1524 -*)
1525 die "${FUNCNAME}(): Unrecognized option '$1'"
1526 ;;
1527 *)
1528 break
1529 ;;
1530 esac
1531 shift
1532 done
1533
1534 if [[ "$#" -ne 1 ]]; then
1535 die "${FUNCNAME}() requires 1 argument"
1536 fi
1537
1538 intermediate_installation_images_directory="$1"
1539
1540 if [[ ! -d "${intermediate_installation_images_directory}" ]]; then
1541 die "${FUNCNAME}(): Intermediate installation images directory '${intermediate_installation_images_directory}' does not exist"
1542 fi
1543
1544 _python_calculate_PYTHON_ABIS
1545 if [[ "$(PYTHON -f --ABI)" == 3.* ]]; then
1546 b="b"
1547 fi
1548
1549 while read -d $'\0' -r file; do
1550 files+=("${file}")
1551 done < <("$(PYTHON -f)" -c \
1552"import os
1553import sys
1554
1555if hasattr(sys.stdout, 'buffer'):
1556 # Python 3
1557 stdout = sys.stdout.buffer
1558else:
1559 # Python 2
1560 stdout = sys.stdout
1561
1562files_set = set()
1563
1564os.chdir(${b}'${intermediate_installation_images_directory}')
1565
1566for PYTHON_ABI in ${b}'${PYTHON_ABIS}'.split():
1567 for root, dirs, files in os.walk(PYTHON_ABI + ${b}'${EPREFIX}'):
1568 root = root[len(PYTHON_ABI + ${b}'${EPREFIX}')+1:]
1569 files_set.update(root + ${b}'/' + file for file in files)
1570
1571for file in sorted(files_set):
1572 stdout.write(file)
1573 stdout.write(${b}'\x00')" || die "${FUNCNAME}(): Failure of extraction of files in intermediate installation images")
1574
1575 for PYTHON_ABI in ${PYTHON_ABIS}; do
1576 if [[ ! -d "${intermediate_installation_images_directory}/${PYTHON_ABI}" ]]; then
1577 die "${FUNCNAME}(): Intermediate installation image for Python ABI '${PYTHON_ABI}' does not exist"
1578 fi
1579
1580 pushd "${intermediate_installation_images_directory}/${PYTHON_ABI}${EPREFIX}" > /dev/null || die "pushd failed"
1581
1582 for file in "${files[@]}"; do
1583 version_executable="0"
1584 for regex in "/usr/bin/.*" "/usr/sbin/.*" "${PYTHON_VERSIONED_SCRIPTS[@]}"; do
1585 if [[ "/${file}" =~ ^${regex}$ ]]; then
1586 version_executable="1"
1587 break
1588 fi
1589 done
1590 for regex in "${PYTHON_VERSIONED_EXECUTABLES[@]}"; do
1591 if [[ "/${file}" =~ ^${regex}$ ]]; then
1592 version_executable="2"
1593 break
1594 fi
1595 done
1596 if [[ "${version_executable}" != "0" ]]; then
1597 for regex in "${PYTHON_NONVERSIONED_EXECUTABLES[@]}"; do
1598 if [[ "/${file}" =~ ^${regex}$ ]]; then
1599 version_executable="0"
1600 break
1601 fi
1602 done
1603 fi
1604
1605 [[ "${version_executable}" == "0" ]] && continue
1606
1607 if [[ -L "${file}" ]]; then
1608 absolute_file="$(readlink "${file}")"
1609 if [[ "${absolute_file}" == /* ]]; then
1610 absolute_file="${intermediate_installation_images_directory}/${PYTHON_ABI}${EPREFIX}/${absolute_file##/}"
1611 else
1612 if [[ "${file}" == */* ]]; then
1613 absolute_file="${intermediate_installation_images_directory}/${PYTHON_ABI}${EPREFIX}/${file%/*}/${absolute_file}"
1614 else
1615 absolute_file="${intermediate_installation_images_directory}/${PYTHON_ABI}${EPREFIX}/${absolute_file}"
1616 fi
1617 fi
1618 else
1619 absolute_file="${intermediate_installation_images_directory}/${PYTHON_ABI}${EPREFIX}/${file}"
1620 fi
1621
1622 [[ ! -x "${absolute_file}" ]] && continue
1623
1624 shebang="$(head -n1 "${absolute_file}")" || die "Extraction of shebang from '${absolute_file}' failed"
1625
1626 if [[ "${version_executable}" == "2" ]]; then
1627 wrapper_scripts+=("${ED}${file}")
1628 elif [[ "${version_executable}" == "1" ]]; then
1629 if [[ "${shebang}" =~ ${_PYTHON_SHEBANG_BASE_PART_REGEX}([[:digit:]]+(\.[[:digit:]]+)?)?($|[[:space:]]+) ]]; then
1630 wrapper_scripts+=("${ED}${file}")
1631 else
1632 version_executable="0"
1633 fi
1634 fi
1635
1636 [[ "${version_executable}" == "0" ]] && continue
1637
1638 if [[ -e "${file}-${PYTHON_ABI}" ]]; then
1639 die "${FUNCNAME}(): '${EPREFIX}/${file}-${PYTHON_ABI}' already exists"
1640 fi
1641
1642 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
1643
1644 if [[ "${shebang}" =~ ${_PYTHON_SHEBANG_BASE_PART_REGEX}[[:digit:]]*($|[[:space:]]+) ]]; then
1645 if [[ -L "${file}-${PYTHON_ABI}" ]]; then
1646 python_convert_shebangs $([[ "${quiet}" == "1" ]] && echo --quiet) "${PYTHON_ABI}" "${absolute_file}"
1647 else
1648 python_convert_shebangs $([[ "${quiet}" == "1" ]] && echo --quiet) "${PYTHON_ABI}" "${file}-${PYTHON_ABI}"
1649 fi
1650 fi
1651 done
1652
1653 popd > /dev/null || die "popd failed"
1654
1655 # This is per bug #390691, without the duplication refactor, and with
1656 # the 3-way structure per comment #6. This enable users with old
1657 # coreutils to upgrade a lot easier (you need to upgrade python+portage
1658 # before coreutils can be upgraded).
1659 if ROOT="/" has_version '>=sys-apps/coreutils-6.9.90'; then
1660 cp -fr --preserve=all --no-preserve=context "${intermediate_installation_images_directory}/${PYTHON_ABI}/"* "${D}" || die "Merging of intermediate installation image for Python ABI '${PYTHON_ABI} into installation image failed"
1661 elif ROOT="/" has_version sys-apps/coreutils; then
1662 cp -fr --preserve=all "${intermediate_installation_images_directory}/${PYTHON_ABI}/"* "${D}" || die "Merging of intermediate installation image for Python ABI '${PYTHON_ABI} into installation image failed"
1663 else
1664 cp -fpr "${intermediate_installation_images_directory}/${PYTHON_ABI}/"* "${D}" || die "Merging of intermediate installation image for Python ABI '${PYTHON_ABI} into installation image failed"
1665 fi
1666 done
1667
1668 rm -fr "${intermediate_installation_images_directory}"
1669
1670 if [[ "${#wrapper_scripts[@]}" -ge 1 ]]; then
1671 rm -f "${T}/python_wrapper_scripts"
1672
1673 for file in "${wrapper_scripts[@]}"; do
1674 echo -n "${file}" >> "${T}/python_wrapper_scripts"
1675 echo -en "\x00" >> "${T}/python_wrapper_scripts"
1676 done
1677
1678 while read -d $'\0' -r file; do
1679 wrapper_scripts_set+=("${file}")
1680 done < <("$(PYTHON -f)" -c \
1681"import sys
1682
1683if hasattr(sys.stdout, 'buffer'):
1684 # Python 3
1685 stdout = sys.stdout.buffer
1686else:
1687 # Python 2
1688 stdout = sys.stdout
1689
1690python_wrapper_scripts_file = open('${T}/python_wrapper_scripts', 'rb')
1691files = set(python_wrapper_scripts_file.read().rstrip(${b}'\x00').split(${b}'\x00'))
1692python_wrapper_scripts_file.close()
1693
1694for file in sorted(files):
1695 stdout.write(file)
1696 stdout.write(${b}'\x00')" || die "${FUNCNAME}(): Failure of extraction of set of wrapper scripts")
1697
1698 python_generate_wrapper_scripts $([[ "${quiet}" == "1" ]] && echo --quiet) "${wrapper_scripts_set[@]}"
1699 fi
1700}
1701
1702# ================================================================================================
1703# ========= FUNCTIONS FOR PACKAGES NOT SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ==========
1704# ================================================================================================
1705
1706unset EPYTHON PYTHON_ABI
1707
1708# @FUNCTION: python_set_active_version
1709# @USAGE: <Python_ABI|2|3>
1710# @DESCRIPTION:
1711# Set locally active version of Python.
1712# If Python_ABI argument is specified, then version of Python corresponding to Python_ABI is used.
1713# If 2 argument is specified, then active version of CPython 2 is used.
1714# If 3 argument is specified, then active version of CPython 3 is used.
1715#
1716# This function can be used only in pkg_setup() phase.
1717python_set_active_version() {
1718 if [[ "${EBUILD_PHASE}" != "setup" ]]; then
1719 die "${FUNCNAME}() can be used only in pkg_setup() phase"
1720 fi
1721
1722 if _python_package_supporting_installation_for_multiple_python_abis; then
1723 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
1724 fi
1725
1726 if [[ "$#" -ne 1 ]]; then
1727 die "${FUNCNAME}() requires 1 argument"
1728 fi
1729
1730 _python_initial_sanity_checks
1731
1732 if [[ -z "${PYTHON_ABI}" ]]; then
1733 if [[ -n "$(_python_get_implementation --ignore-invalid "$1")" ]]; then
1734 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses,
1735 # so it does not need to be exported to subprocesses.
1736 PYTHON_ABI="$1"
1737 if ! _python_implementation && ! has_version "$(python_get_implementational_package)"; then
1738 die "${FUNCNAME}(): '$(python_get_implementational_package)' is not installed"
1739 fi
1740 export EPYTHON="$(PYTHON "$1")"
1741 elif [[ "$1" == "2" ]]; then
1742 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then
1743 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed"
1744 fi
1745 export EPYTHON="$(PYTHON -2)"
1746 PYTHON_ABI="${EPYTHON#python}"
1747 PYTHON_ABI="${PYTHON_ABI%%-*}"
1748 elif [[ "$1" == "3" ]]; then
1749 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then
1750 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed"
1751 fi
1752 export EPYTHON="$(PYTHON -3)"
1753 PYTHON_ABI="${EPYTHON#python}"
1754 PYTHON_ABI="${PYTHON_ABI%%-*}"
1755 else
1756 die "${FUNCNAME}(): Unrecognized argument '$1'"
1757 fi
1758 fi
1759
1760 _python_final_sanity_checks
1761
1762 # python-updater checks PYTHON_REQUESTED_ACTIVE_VERSION variable.
1763 PYTHON_REQUESTED_ACTIVE_VERSION="$1"
1764}
1765
1766# @FUNCTION: python_need_rebuild
1767# @DESCRIPTION:
1768# Mark current package for rebuilding by python-updater after
1769# switching of active version of Python.
1770python_need_rebuild() {
1771 if _python_package_supporting_installation_for_multiple_python_abis; then
1772 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
1773 fi
1774
1775 _python_check_python_pkg_setup_execution
1776
1777 if [[ "$#" -ne 0 ]]; then
1778 die "${FUNCNAME}() does not accept arguments"
1779 fi
1780
1781 export PYTHON_NEED_REBUILD="$(PYTHON --ABI)"
1782}
1783
1784# ================================================================================================
1785# ======================================= GETTER FUNCTIONS =======================================
1786# ================================================================================================
1787
1788_PYTHON_ABI_EXTRACTION_COMMAND=\
1789'import platform
1790import sys
1791sys.stdout.write(".".join(str(x) for x in sys.version_info[:2]))
1792if platform.system()[:4] == "Java":
1793 sys.stdout.write("-jython")
1794elif hasattr(platform, "python_implementation") and platform.python_implementation() == "PyPy":
1795 sys.stdout.write("-pypy-" + ".".join(str(x) for x in sys.pypy_version_info[:2]))'
1796
1797_python_get_implementation() {
1798 local ignore_invalid="0"
1799
1800 while (($#)); do
1801 case "$1" in
1802 --ignore-invalid)
1803 ignore_invalid="1"
1804 ;;
1805 --)
1806 shift
1807 break
1808 ;;
1809 -*)
1810 die "${FUNCNAME}(): Unrecognized option '$1'"
1811 ;;
1812 *)
1813 break
1814 ;;
1815 esac
1816 shift
1817 done
1818
1819 if [[ "$#" -ne 1 ]]; then
1820 die "${FUNCNAME}() requires 1 argument"
1821 fi
1822
1823 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
1824 echo "CPython"
1825 elif [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+-jython$ ]]; then
1826 echo "Jython"
1827 elif [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+-pypy-[[:digit:]]+\.[[:digit:]]+$ ]]; then
1828 echo "PyPy"
1829 else
1830 if [[ "${ignore_invalid}" == "0" ]]; then
1831 die "${FUNCNAME}(): Unrecognized Python ABI '$1'"
1832 fi
1833 fi
1834}
1835
1836# @FUNCTION: PYTHON
1837# @USAGE: [-2] [-3] [--ABI] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}">
1838# @DESCRIPTION:
1839# Print filename of Python interpreter for specified Python ABI. If Python_ABI argument
1840# is ommitted, then PYTHON_ABI environment variable must be set and is used.
1841# If -2 option is specified, then active version of CPython 2 is used.
1842# If -3 option is specified, then active version of CPython 3 is used.
1843# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1844# -2, -3 and --final-ABI options and Python_ABI argument cannot be specified simultaneously.
1845# If --ABI option is specified, then only specified Python ABI is printed instead of
1846# filename of Python interpreter.
1847# If --absolute-path option is specified, then absolute path to Python interpreter is printed.
1848# --ABI and --absolute-path options cannot be specified simultaneously.
1849PYTHON() {
1850 _python_check_python_pkg_setup_execution
1851
1852 local ABI_output="0" absolute_path_output="0" final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" python_interpreter python2="0" python3="0"
1853
1854 while (($#)); do
1855 case "$1" in
1856 -2)
1857 python2="1"
1858 ;;
1859 -3)
1860 python3="1"
1861 ;;
1862 --ABI)
1863 ABI_output="1"
1864 ;;
1865 -a|--absolute-path)
1866 absolute_path_output="1"
1867 ;;
1868 -f|--final-ABI)
1869 final_ABI="1"
1870 ;;
1871 --)
1872 shift
1873 break
1874 ;;
1875 -*)
1876 die "${FUNCNAME}(): Unrecognized option '$1'"
1877 ;;
1878 *)
1879 break
1880 ;;
1881 esac
1882 shift
1883 done
1884
1885 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then
1886 die "${FUNCNAME}(): '--ABI' and '--absolute-path' options cannot be specified simultaneously"
1887 fi
1888
1889 if [[ "$((${python2} + ${python3} + ${final_ABI}))" -gt 1 ]]; then
1890 die "${FUNCNAME}(): '-2', '-3' or '--final-ABI' options cannot be specified simultaneously"
1891 fi
1892
1893 if [[ "$#" -eq 0 ]]; then
1894 if [[ "${final_ABI}" == "1" ]]; then
1895 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1896 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1897 fi
1898 _python_calculate_PYTHON_ABIS
1899 PYTHON_ABI="${PYTHON_ABIS##* }"
1900 elif [[ "${python2}" == "1" ]]; then
1901 PYTHON_ABI="$(ROOT="/" eselect python show --python2 --ABI)"
1902 if [[ -z "${PYTHON_ABI}" ]]; then
1903 die "${FUNCNAME}(): Active version of CPython 2 not set"
1904 elif [[ "${PYTHON_ABI}" != "2."* ]]; then
1905 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`"
1906 fi
1907 elif [[ "${python3}" == "1" ]]; then
1908 PYTHON_ABI="$(ROOT="/" eselect python show --python3 --ABI)"
1909 if [[ -z "${PYTHON_ABI}" ]]; then
1910 die "${FUNCNAME}(): Active version of CPython 3 not set"
1911 elif [[ "${PYTHON_ABI}" != "3."* ]]; then
1912 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`"
1913 fi
1914 elif _python_package_supporting_installation_for_multiple_python_abis; then
1915 if ! _python_abi-specific_local_scope; then
1916 die "${FUNCNAME}() should be used in ABI-specific local scope"
1917 fi
1918 else
1919 PYTHON_ABI="$("${EPREFIX}/usr/bin/python" -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")"
1920 if [[ -z "${PYTHON_ABI}" ]]; then
1921 die "${FUNCNAME}(): Failure of extraction of locally active version of Python"
1922 fi
1923 fi
1924 elif [[ "$#" -eq 1 ]]; then
1925 if [[ "${final_ABI}" == "1" ]]; then
1926 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously"
1927 fi
1928 if [[ "${python2}" == "1" ]]; then
1929 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously"
1930 fi
1931 if [[ "${python3}" == "1" ]]; then
1932 die "${FUNCNAME}(): '-3' option and Python ABI cannot be specified simultaneously"
1933 fi
1934 PYTHON_ABI="$1"
1935 else
1936 die "${FUNCNAME}(): Invalid usage"
1937 fi
1938
1939 if [[ "${ABI_output}" == "1" ]]; then
1940 echo -n "${PYTHON_ABI}"
1941 return
1942 else
1943 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1944 python_interpreter="python${PYTHON_ABI}"
1945 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1946 python_interpreter="jython${PYTHON_ABI%-jython}"
1947 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
1948 python_interpreter="pypy-c${PYTHON_ABI#*-pypy-}"
1949 fi
1950
1951 if [[ "${absolute_path_output}" == "1" ]]; then
1952 echo -n "${EPREFIX}/usr/bin/${python_interpreter}"
1953 else
1954 echo -n "${python_interpreter}"
1955 fi
1956 fi
1957
1958 if [[ -n "${ABI}" && "${ABI}" != "${DEFAULT_ABI}" && "${DEFAULT_ABI}" != "default" ]]; then
1959 echo -n "-${ABI}"
1960 fi
1961}
1962
1963# @FUNCTION: python_get_implementation
1964# @USAGE: [-f|--final-ABI]
1965# @DESCRIPTION:
1966# Print name of Python implementation.
1967# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1968python_get_implementation() {
1969 _python_check_python_pkg_setup_execution
1970
1971 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1972
1973 while (($#)); do
1974 case "$1" in
1975 -f|--final-ABI)
1976 final_ABI="1"
1977 ;;
1978 -*)
1979 die "${FUNCNAME}(): Unrecognized option '$1'"
1980 ;;
1981 *)
1982 die "${FUNCNAME}(): Invalid usage"
1983 ;;
1984 esac
1985 shift
1986 done
1987
1988 if [[ "${final_ABI}" == "1" ]]; then
1989 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1990 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1991 fi
1992 PYTHON_ABI="$(PYTHON -f --ABI)"
1993 else
1994 if _python_package_supporting_installation_for_multiple_python_abis; then
1995 if ! _python_abi-specific_local_scope; then
1996 die "${FUNCNAME}() should be used in ABI-specific local scope"
1997 fi
1998 else
1999 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2000 fi
2001 fi
2002
2003 echo "$(_python_get_implementation "${PYTHON_ABI}")"
2004}
2005
2006# @FUNCTION: python_get_implementational_package
2007# @USAGE: [-f|--final-ABI]
2008# @DESCRIPTION:
2009# Print category, name and slot of package providing Python implementation.
2010# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2011python_get_implementational_package() {
2012 _python_check_python_pkg_setup_execution
2013
2014 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
2015
2016 while (($#)); do
2017 case "$1" in
2018 -f|--final-ABI)
2019 final_ABI="1"
2020 ;;
2021 -*)
2022 die "${FUNCNAME}(): Unrecognized option '$1'"
2023 ;;
2024 *)
2025 die "${FUNCNAME}(): Invalid usage"
2026 ;;
2027 esac
2028 shift
2029 done
2030
2031 if [[ "${final_ABI}" == "1" ]]; then
2032 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2033 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2034 fi
2035 PYTHON_ABI="$(PYTHON -f --ABI)"
2036 else
2037 if _python_package_supporting_installation_for_multiple_python_abis; then
2038 if ! _python_abi-specific_local_scope; then
2039 die "${FUNCNAME}() should be used in ABI-specific local scope"
2040 fi
2041 else
2042 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2043 fi
2044 fi
2045
2046 if [[ "${EAPI:-0}" == "0" ]]; then
2047 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2048 echo "=dev-lang/python-${PYTHON_ABI}*"
2049 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2050 echo "=dev-java/jython-${PYTHON_ABI%-jython}*"
2051 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2052 echo "=dev-python/pypy-${PYTHON_ABI#*-pypy-}*"
2053 fi
2054 else
2055 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2056 echo "dev-lang/python:${PYTHON_ABI}"
2057 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2058 echo "dev-java/jython:${PYTHON_ABI%-jython}"
2059 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2060 echo "dev-python/pypy:${PYTHON_ABI#*-pypy-}"
2061 fi
2062 fi
2063}
2064
2065# @FUNCTION: python_get_includedir
2066# @USAGE: [-b|--base-path] [-f|--final-ABI]
2067# @DESCRIPTION:
2068# Print path to Python include directory.
2069# If --base-path option is specified, then path not prefixed with "/" is printed.
2070# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2071python_get_includedir() {
2072 _python_check_python_pkg_setup_execution
2073
2074 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
2075
2076 while (($#)); do
2077 case "$1" in
2078 -b|--base-path)
2079 base_path="1"
2080 ;;
2081 -f|--final-ABI)
2082 final_ABI="1"
2083 ;;
2084 -*)
2085 die "${FUNCNAME}(): Unrecognized option '$1'"
2086 ;;
2087 *)
2088 die "${FUNCNAME}(): Invalid usage"
2089 ;;
2090 esac
2091 shift
2092 done
2093
2094 if [[ "${base_path}" == "0" ]]; then
2095 prefix="/"
2096 fi
2097
2098 if [[ "${final_ABI}" == "1" ]]; then
2099 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2100 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2101 fi
2102 PYTHON_ABI="$(PYTHON -f --ABI)"
2103 else
2104 if _python_package_supporting_installation_for_multiple_python_abis; then
2105 if ! _python_abi-specific_local_scope; then
2106 die "${FUNCNAME}() should be used in ABI-specific local scope"
2107 fi
2108 else
2109 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2110 fi
2111 fi
2112
2113 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2114 echo "${prefix}usr/include/python${PYTHON_ABI}"
2115 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2116 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Include"
2117 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2118 echo "${prefix}usr/$(get_libdir)/pypy${PYTHON_ABI#*-pypy-}/include"
2119 fi
2120}
2121
2122# @FUNCTION: python_get_libdir
2123# @USAGE: [-b|--base-path] [-f|--final-ABI]
2124# @DESCRIPTION:
2125# Print path to Python standard library directory.
2126# If --base-path option is specified, then path not prefixed with "/" is printed.
2127# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2128python_get_libdir() {
2129 _python_check_python_pkg_setup_execution
2130
2131 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
2132
2133 while (($#)); do
2134 case "$1" in
2135 -b|--base-path)
2136 base_path="1"
2137 ;;
2138 -f|--final-ABI)
2139 final_ABI="1"
2140 ;;
2141 -*)
2142 die "${FUNCNAME}(): Unrecognized option '$1'"
2143 ;;
2144 *)
2145 die "${FUNCNAME}(): Invalid usage"
2146 ;;
2147 esac
2148 shift
2149 done
2150
2151 if [[ "${base_path}" == "0" ]]; then
2152 prefix="/"
2153 fi
2154
2155 if [[ "${final_ABI}" == "1" ]]; then
2156 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2157 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2158 fi
2159 PYTHON_ABI="$(PYTHON -f --ABI)"
2160 else
2161 if _python_package_supporting_installation_for_multiple_python_abis; then
2162 if ! _python_abi-specific_local_scope; then
2163 die "${FUNCNAME}() should be used in ABI-specific local scope"
2164 fi
2165 else
2166 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2167 fi
2168 fi
2169
2170 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2171 echo "${prefix}usr/$(get_libdir)/python${PYTHON_ABI}"
2172 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2173 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Lib"
2174 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2175 die "${FUNCNAME}(): PyPy has multiple standard library directories"
2176 fi
2177}
2178
2179# @FUNCTION: python_get_sitedir
2180# @USAGE: [-b|--base-path] [-f|--final-ABI]
2181# @DESCRIPTION:
2182# Print path to Python site-packages directory.
2183# If --base-path option is specified, then path not prefixed with "/" is printed.
2184# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2185python_get_sitedir() {
2186 _python_check_python_pkg_setup_execution
2187
2188 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
2189
2190 while (($#)); do
2191 case "$1" in
2192 -b|--base-path)
2193 base_path="1"
2194 ;;
2195 -f|--final-ABI)
2196 final_ABI="1"
2197 ;;
2198 -*)
2199 die "${FUNCNAME}(): Unrecognized option '$1'"
2200 ;;
2201 *)
2202 die "${FUNCNAME}(): Invalid usage"
2203 ;;
2204 esac
2205 shift
2206 done
2207
2208 if [[ "${base_path}" == "0" ]]; then
2209 prefix="/"
2210 fi
2211
2212 if [[ "${final_ABI}" == "1" ]]; then
2213 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2214 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2215 fi
2216 PYTHON_ABI="$(PYTHON -f --ABI)"
2217 else
2218 if _python_package_supporting_installation_for_multiple_python_abis; then
2219 if ! _python_abi-specific_local_scope; then
2220 die "${FUNCNAME}() should be used in ABI-specific local scope"
2221 fi
2222 else
2223 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2224 fi
2225 fi
2226
2227 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2228 echo "${prefix}usr/$(get_libdir)/python${PYTHON_ABI}/site-packages"
2229 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2230 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Lib/site-packages"
2231 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2232 echo "${prefix}usr/$(get_libdir)/pypy${PYTHON_ABI#*-pypy-}/site-packages"
2233 fi
2234}
2235
2236# @FUNCTION: python_get_library
2237# @USAGE: [-b|--base-path] [-f|--final-ABI] [-l|--linker-option]
2238# @DESCRIPTION:
2239# Print path to Python library.
2240# If --base-path option is specified, then path not prefixed with "/" is printed.
2241# If --linker-option is specified, then "-l${library}" linker option is printed.
2242# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2243python_get_library() {
2244 _python_check_python_pkg_setup_execution
2245
2246 local base_path="0" final_ABI="0" linker_option="0" prefix PYTHON_ABI="${PYTHON_ABI}"
2247
2248 while (($#)); do
2249 case "$1" in
2250 -b|--base-path)
2251 base_path="1"
2252 ;;
2253 -f|--final-ABI)
2254 final_ABI="1"
2255 ;;
2256 -l|--linker-option)
2257 linker_option="1"
2258 ;;
2259 -*)
2260 die "${FUNCNAME}(): Unrecognized option '$1'"
2261 ;;
2262 *)
2263 die "${FUNCNAME}(): Invalid usage"
2264 ;;
2265 esac
2266 shift
2267 done
2268
2269 if [[ "${base_path}" == "0" ]]; then
2270 prefix="/"
2271 fi
2272
2273 if [[ "${base_path}" == "1" && "${linker_option}" == "1" ]]; then
2274 die "${FUNCNAME}(): '--base-path' and '--linker-option' options cannot be specified simultaneously"
2275 fi
2276
2277 if [[ "${final_ABI}" == "1" ]]; then
2278 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2279 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2280 fi
2281 PYTHON_ABI="$(PYTHON -f --ABI)"
2282 else
2283 if _python_package_supporting_installation_for_multiple_python_abis; then
2284 if ! _python_abi-specific_local_scope; then
2285 die "${FUNCNAME}() should be used in ABI-specific local scope"
2286 fi
2287 else
2288 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2289 fi
2290 fi
2291
2292 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2293 if [[ "${linker_option}" == "1" ]]; then
2294 echo "-lpython${PYTHON_ABI}"
2295 else
2296 echo "${prefix}usr/$(get_libdir)/libpython${PYTHON_ABI}$(get_libname)"
2297 fi
2298 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2299 die "${FUNCNAME}(): Jython does not have shared library"
2300 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2301 die "${FUNCNAME}(): PyPy does not have shared library"
2302 fi
2303}
2304
2305# @FUNCTION: python_get_version
2306# @USAGE: [-f|--final-ABI] [-l|--language] [--full] [--major] [--minor] [--micro]
2307# @DESCRIPTION:
2308# Print version of Python implementation.
2309# --full, --major, --minor and --micro options cannot be specified simultaneously.
2310# If --full, --major, --minor and --micro options are not specified, then "${major_version}.${minor_version}" is printed.
2311# If --language option is specified, then version of Python language is printed.
2312# --language and --full options cannot be specified simultaneously.
2313# --language and --micro options cannot be specified simultaneously.
2314# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2315python_get_version() {
2316 _python_check_python_pkg_setup_execution
2317
2318 local final_ABI="0" language="0" language_version full="0" major="0" minor="0" micro="0" PYTHON_ABI="${PYTHON_ABI}" python_command
2319
2320 while (($#)); do
2321 case "$1" in
2322 -f|--final-ABI)
2323 final_ABI="1"
2324 ;;
2325 -l|--language)
2326 language="1"
2327 ;;
2328 --full)
2329 full="1"
2330 ;;
2331 --major)
2332 major="1"
2333 ;;
2334 --minor)
2335 minor="1"
2336 ;;
2337 --micro)
2338 micro="1"
2339 ;;
2340 -*)
2341 die "${FUNCNAME}(): Unrecognized option '$1'"
2342 ;;
2343 *)
2344 die "${FUNCNAME}(): Invalid usage"
2345 ;;
2346 esac
2347 shift
2348 done
2349
2350 if [[ "${final_ABI}" == "1" ]]; then
2351 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2352 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2353 fi
2354 else
2355 if _python_package_supporting_installation_for_multiple_python_abis && ! _python_abi-specific_local_scope; then
2356 die "${FUNCNAME}() should be used in ABI-specific local scope"
2357 fi
2358 fi
2359
2360 if [[ "$((${full} + ${major} + ${minor} + ${micro}))" -gt 1 ]]; then
2361 die "${FUNCNAME}(): '--full', '--major', '--minor' or '--micro' options cannot be specified simultaneously"
2362 fi
2363
2364 if [[ "${language}" == "1" ]]; then
2365 if [[ "${final_ABI}" == "1" ]]; then
2366 PYTHON_ABI="$(PYTHON -f --ABI)"
2367 elif [[ -z "${PYTHON_ABI}" ]]; then
2368 PYTHON_ABI="$(PYTHON --ABI)"
2369 fi
2370 language_version="${PYTHON_ABI%%-*}"
2371 if [[ "${full}" == "1" ]]; then
2372 die "${FUNCNAME}(): '--language' and '--full' options cannot be specified simultaneously"
2373 elif [[ "${major}" == "1" ]]; then
2374 echo "${language_version%.*}"
2375 elif [[ "${minor}" == "1" ]]; then
2376 echo "${language_version#*.}"
2377 elif [[ "${micro}" == "1" ]]; then
2378 die "${FUNCNAME}(): '--language' and '--micro' options cannot be specified simultaneously"
2379 else
2380 echo "${language_version}"
2381 fi
2382 else
2383 if [[ "${full}" == "1" ]]; then
2384 python_command="import sys; print('.'.join(str(x) for x in getattr(sys, 'pypy_version_info', sys.version_info)[:3]))"
2385 elif [[ "${major}" == "1" ]]; then
2386 python_command="import sys; print(getattr(sys, 'pypy_version_info', sys.version_info)[0])"
2387 elif [[ "${minor}" == "1" ]]; then
2388 python_command="import sys; print(getattr(sys, 'pypy_version_info', sys.version_info)[1])"
2389 elif [[ "${micro}" == "1" ]]; then
2390 python_command="import sys; print(getattr(sys, 'pypy_version_info', sys.version_info)[2])"
2391 else
2392 if [[ -n "${PYTHON_ABI}" && "${final_ABI}" == "0" ]]; then
2393 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
2394 echo "${PYTHON_ABI}"
2395 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
2396 echo "${PYTHON_ABI%-jython}"
2397 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "PyPy" ]]; then
2398 echo "${PYTHON_ABI#*-pypy-}"
2399 fi
2400 return
2401 fi
2402 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:2]))"
2403 fi
2404
2405 if [[ "${final_ABI}" == "1" ]]; then
2406 "$(PYTHON -f)" -c "${python_command}"
2407 else
2408 "$(PYTHON ${PYTHON_ABI})" -c "${python_command}"
2409 fi
2410 fi
2411}
2412
2413# @FUNCTION: python_get_implementation_and_version
2414# @USAGE: [-f|--final-ABI]
2415# @DESCRIPTION:
2416# Print name and version of Python implementation.
2417# If version of Python implementation is not bound to version of Python language, then
2418# version of Python language is additionally printed.
2419# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
2420python_get_implementation_and_version() {
2421 _python_check_python_pkg_setup_execution
2422
2423 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
2424
2425 while (($#)); do
2426 case "$1" in
2427 -f|--final-ABI)
2428 final_ABI="1"
2429 ;;
2430 -*)
2431 die "${FUNCNAME}(): Unrecognized option '$1'"
2432 ;;
2433 *)
2434 die "${FUNCNAME}(): Invalid usage"
2435 ;;
2436 esac
2437 shift
2438 done
2439
2440 if [[ "${final_ABI}" == "1" ]]; then
2441 if ! _python_package_supporting_installation_for_multiple_python_abis; then
2442 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2443 fi
2444 PYTHON_ABI="$(PYTHON -f --ABI)"
2445 else
2446 if _python_package_supporting_installation_for_multiple_python_abis; then
2447 if ! _python_abi-specific_local_scope; then
2448 die "${FUNCNAME}() should be used in ABI-specific local scope"
2449 fi
2450 else
2451 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2452 fi
2453 fi
2454
2455 if [[ "${PYTHON_ABI}" =~ ^[[:digit:]]+\.[[:digit:]]+-[[:alnum:]]+-[[:digit:]]+\.[[:digit:]]+$ ]]; then
2456 echo "$(_python_get_implementation "${PYTHON_ABI}") ${PYTHON_ABI##*-} (Python ${PYTHON_ABI%%-*})"
2457 else
2458 echo "$(_python_get_implementation "${PYTHON_ABI}") ${PYTHON_ABI%%-*}"
2459 fi
2460}
2461
2462# ================================================================================================
2463# ================================ FUNCTIONS FOR RUNNING OF TESTS ================================
2464# ================================================================================================
2465
2466# @ECLASS-VARIABLE: PYTHON_TEST_VERBOSITY
2467# @DESCRIPTION:
2468# User-configurable verbosity of tests of Python modules.
2469# Supported values: 0, 1, 2, 3, 4.
2470PYTHON_TEST_VERBOSITY="${PYTHON_TEST_VERBOSITY:-1}"
2471
2472_python_test_hook() {
2473 if [[ "$#" -ne 1 ]]; then
2474 die "${FUNCNAME}() requires 1 argument"
2475 fi
2476
2477 if _python_package_supporting_installation_for_multiple_python_abis && [[ "$(type -t "${_PYTHON_TEST_FUNCTION}_$1_hook")" == "function" ]]; then
2478 "${_PYTHON_TEST_FUNCTION}_$1_hook"
2479 fi
2480}
2481
2482# @FUNCTION: python_execute_nosetests
2483# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
2484# @DESCRIPTION:
2485# Execute nosetests for all enabled Python ABIs.
2486# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
2487# python_execute_nosetests_pre_hook() and python_execute_nosetests_post_hook(), if they are defined.
2488python_execute_nosetests() {
2489 _python_check_python_pkg_setup_execution
2490 _python_set_color_variables
2491
2492 local PYTHONPATH_template separate_build_dirs
2493
2494 while (($#)); do
2495 case "$1" in
2496 -P|--PYTHONPATH)
2497 PYTHONPATH_template="$2"
2498 shift
2499 ;;
2500 -s|--separate-build-dirs)
2501 separate_build_dirs="1"
2502 ;;
2503 --)
2504 shift
2505 break
2506 ;;
2507 -*)
2508 die "${FUNCNAME}(): Unrecognized option '$1'"
2509 ;;
2510 *)
2511 break
2512 ;;
2513 esac
2514 shift
2515 done
2516
2517 python_test_function() {
2518 local evaluated_PYTHONPATH
2519
2520 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
2521
2522 _PYTHON_TEST_FUNCTION="python_execute_nosetests" _python_test_hook pre
2523
2524 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
2525 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
2526 PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
2527 else
2528 echo ${_BOLD}nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
2529 nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
2530 fi
2531
2532 _PYTHON_TEST_FUNCTION="python_execute_nosetests" _python_test_hook post
2533 }
2534 if _python_package_supporting_installation_for_multiple_python_abis; then
2535 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
2536 else
2537 if [[ -n "${separate_build_dirs}" ]]; then
2538 die "${FUNCNAME}(): Invalid usage"
2539 fi
2540 python_test_function "$@" || die "Testing failed"
2541 fi
2542
2543 unset -f python_test_function
2544}
2545
2546# @FUNCTION: python_execute_py.test
2547# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
2548# @DESCRIPTION:
2549# Execute py.test for all enabled Python ABIs.
2550# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
2551# python_execute_py.test_pre_hook() and python_execute_py.test_post_hook(), if they are defined.
2552python_execute_py.test() {
2553 _python_check_python_pkg_setup_execution
2554 _python_set_color_variables
2555
2556 local PYTHONPATH_template separate_build_dirs
2557
2558 while (($#)); do
2559 case "$1" in
2560 -P|--PYTHONPATH)
2561 PYTHONPATH_template="$2"
2562 shift
2563 ;;
2564 -s|--separate-build-dirs)
2565 separate_build_dirs="1"
2566 ;;
2567 --)
2568 shift
2569 break
2570 ;;
2571 -*)
2572 die "${FUNCNAME}(): Unrecognized option '$1'"
2573 ;;
2574 *)
2575 break
2576 ;;
2577 esac
2578 shift
2579 done
2580
2581 python_test_function() {
2582 local evaluated_PYTHONPATH
2583
2584 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
2585
2586 _PYTHON_TEST_FUNCTION="python_execute_py.test" _python_test_hook pre
2587
2588 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
2589 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@"${_NORMAL}
2590 PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" || return "$?"
2591 else
2592 echo ${_BOLD}py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@"${_NORMAL}
2593 py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" || return "$?"
2594 fi
2595
2596 _PYTHON_TEST_FUNCTION="python_execute_py.test" _python_test_hook post
2597 }
2598 if _python_package_supporting_installation_for_multiple_python_abis; then
2599 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
2600 else
2601 if [[ -n "${separate_build_dirs}" ]]; then
2602 die "${FUNCNAME}(): Invalid usage"
2603 fi
2604 python_test_function "$@" || die "Testing failed"
2605 fi
2606
2607 unset -f python_test_function
2608}
2609
2610# @FUNCTION: python_execute_trial
2611# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
2612# @DESCRIPTION:
2613# Execute trial for all enabled Python ABIs.
2614# In ebuilds of packages supporting installation for multiple Python ABIs, this function
2615# calls python_execute_trial_pre_hook() and python_execute_trial_post_hook(), if they are defined.
2616python_execute_trial() {
2617 _python_check_python_pkg_setup_execution
2618 _python_set_color_variables
2619
2620 local PYTHONPATH_template separate_build_dirs
2621
2622 while (($#)); do
2623 case "$1" in
2624 -P|--PYTHONPATH)
2625 PYTHONPATH_template="$2"
2626 shift
2627 ;;
2628 -s|--separate-build-dirs)
2629 separate_build_dirs="1"
2630 ;;
2631 --)
2632 shift
2633 break
2634 ;;
2635 -*)
2636 die "${FUNCNAME}(): Unrecognized option '$1'"
2637 ;;
2638 *)
2639 break
2640 ;;
2641 esac
2642 shift
2643 done
2644
2645 python_test_function() {
2646 local evaluated_PYTHONPATH
2647
2648 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
2649
2650 _PYTHON_TEST_FUNCTION="python_execute_trial" _python_test_hook pre
2651
2652 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
2653 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
2654 PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
2655 else
2656 echo ${_BOLD}trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
2657 trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
2658 fi
2659
2660 _PYTHON_TEST_FUNCTION="python_execute_trial" _python_test_hook post
2661 }
2662 if _python_package_supporting_installation_for_multiple_python_abis; then
2663 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
2664 else
2665 if [[ -n "${separate_build_dirs}" ]]; then
2666 die "${FUNCNAME}(): Invalid usage"
2667 fi
2668 python_test_function "$@" || die "Testing failed"
2669 fi
2670
2671 unset -f python_test_function
2672}
2673
2674# ================================================================================================
2675# ======================= FUNCTIONS FOR HANDLING OF BYTE-COMPILED MODULES ========================
2676# ================================================================================================
2677
2678# @FUNCTION: python_enable_pyc
2679# @DESCRIPTION:
2680# Tell Python to automatically recompile modules to .pyc/.pyo if the
2681# timestamps/version stamps have changed.
2682python_enable_pyc() {
2683 _python_check_python_pkg_setup_execution
2684
2685 if [[ "$#" -ne 0 ]]; then
2686 die "${FUNCNAME}() does not accept arguments"
2687 fi
2688
2689 unset PYTHONDONTWRITEBYTECODE
2690}
2691
2692# @FUNCTION: python_disable_pyc
2693# @DESCRIPTION:
2694# Tell Python not to automatically recompile modules to .pyc/.pyo
2695# even if the timestamps/version stamps do not match. This is done
2696# to protect sandbox.
2697python_disable_pyc() {
2698 _python_check_python_pkg_setup_execution
2699
2700 if [[ "$#" -ne 0 ]]; then
2701 die "${FUNCNAME}() does not accept arguments"
2702 fi
2703
2704 export PYTHONDONTWRITEBYTECODE="1"
2705}
2706
2707_python_clean_compiled_modules() {
2708 _python_initialize_prefix_variables
2709 _python_set_color_variables
2710
2711 [[ "${FUNCNAME[1]}" =~ ^(python_mod_optimize|python_mod_cleanup)$ ]] || die "${FUNCNAME}(): Invalid usage"
2712
2713 local base_module_name compiled_file compiled_files=() dir path py_file root
2714
2715 # Strip trailing slash from EROOT.
2716 root="${EROOT%/}"
2717
2718 for path in "$@"; do
2719 compiled_files=()
2720 if [[ -d "${path}" ]]; then
2721 while read -d $'\0' -r compiled_file; do
2722 compiled_files+=("${compiled_file}")
2723 done < <(find "${path}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -print0)
2724
2725 if [[ "${EBUILD_PHASE}" == "postrm" ]]; then
2726 # Delete empty child directories.
2727 find "${path}" -type d | sort -r | while read -r dir; do
2728 if rmdir "${dir}" 2> /dev/null; then
2729 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2730 fi
2731 done
2732 fi
2733 elif [[ "${path}" == *.py ]]; then
2734 base_module_name="${path##*/}"
2735 base_module_name="${base_module_name%.py}"
2736 if [[ -d "${path%/*}/__pycache__" ]]; then
2737 while read -d $'\0' -r compiled_file; do
2738 compiled_files+=("${compiled_file}")
2739 done < <(find "${path%/*}/__pycache__" "(" -name "${base_module_name}.*.py[co]" -o -name "${base_module_name}\$py.class" ")" -print0)
2740 fi
2741 compiled_files+=("${path}c" "${path}o" "${path%.py}\$py.class")
2742 fi
2743
2744 for compiled_file in "${compiled_files[@]}"; do
2745 [[ ! -f "${compiled_file}" ]] && continue
2746 dir="${compiled_file%/*}"
2747 dir="${dir##*/}"
2748 if [[ "${compiled_file}" == *.py[co] ]]; then
2749 if [[ "${dir}" == "__pycache__" ]]; then
2750 base_module_name="${compiled_file##*/}"
2751 base_module_name="${base_module_name%.*py[co]}"
2752 base_module_name="${base_module_name%.*}"
2753 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2754 else
2755 py_file="${compiled_file%[co]}"
2756 fi
2757 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2758 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2759 else
2760 [[ -f "${py_file}" ]] && continue
2761 fi
2762 echo "${_BLUE}<<< ${compiled_file%[co]}[co]${_NORMAL}"
2763 rm -f "${compiled_file%[co]}"[co]
2764 elif [[ "${compiled_file}" == *\$py.class ]]; then
2765 if [[ "${dir}" == "__pycache__" ]]; then
2766 base_module_name="${compiled_file##*/}"
2767 base_module_name="${base_module_name%\$py.class}"
2768 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2769 else
2770 py_file="${compiled_file%\$py.class}.py"
2771 fi
2772 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2773 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2774 else
2775 [[ -f "${py_file}" ]] && continue
2776 fi
2777 echo "${_BLUE}<<< ${compiled_file}${_NORMAL}"
2778 rm -f "${compiled_file}"
2779 else
2780 die "${FUNCNAME}(): Unrecognized file type: '${compiled_file}'"
2781 fi
2782
2783 # Delete empty parent directories.
2784 dir="${compiled_file%/*}"
2785 while [[ "${dir}" != "${root}" ]]; do
2786 if rmdir "${dir}" 2> /dev/null; then
2787 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2788 else
2789 break
2790 fi
2791 dir="${dir%/*}"
2792 done
2793 done
2794 done
2795}
2796
2797# @FUNCTION: python_mod_optimize
2798# @USAGE: [--allow-evaluated-non-sitedir-paths] [-d directory] [-f] [-l] [-q] [-x regular_expression] [--] <file|directory> [files|directories]
2799# @DESCRIPTION:
2800# Byte-compile specified Python modules.
2801# -d, -f, -l, -q and -x options passed to this function are passed to compileall.py.
2802#
2803# This function can be used only in pkg_postinst() phase.
2804python_mod_optimize() {
2805 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
2806 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
2807 fi
2808
2809 _python_check_python_pkg_setup_execution
2810 _python_initialize_prefix_variables
2811
2812 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis || _python_implementation || [[ "${CATEGORY}/${PN}" == "sys-apps/portage" ]]; then
2813 # PYTHON_ABI variable cannot be local in packages not supporting installation for multiple Python ABIs.
2814 local allow_evaluated_non_sitedir_paths="0" dir dirs=() evaluated_dirs=() evaluated_files=() file files=() iterated_PYTHON_ABIS options=() other_dirs=() other_files=() previous_PYTHON_ABI="${PYTHON_ABI}" return_code root site_packages_dirs=() site_packages_files=() stderr stderr_line
2815
2816 if _python_package_supporting_installation_for_multiple_python_abis; then
2817 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
2818 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
2819 fi
2820 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
2821 else
2822 if has "${EAPI:-0}" 0 1 2 3; then
2823 iterated_PYTHON_ABIS="${PYTHON_ABI:=$(PYTHON --ABI)}"
2824 else
2825 iterated_PYTHON_ABIS="${PYTHON_ABI}"
2826 fi
2827 fi
2828
2829 # Strip trailing slash from EROOT.
2830 root="${EROOT%/}"
2831
2832 while (($#)); do
2833 case "$1" in
2834 --allow-evaluated-non-sitedir-paths)
2835 allow_evaluated_non_sitedir_paths="1"
2836 ;;
2837 -l|-f|-q)
2838 options+=("$1")
2839 ;;
2840 -d|-x)
2841 options+=("$1" "$2")
2842 shift
2843 ;;
2844 --)
2845 shift
2846 break
2847 ;;
2848 -*)
2849 die "${FUNCNAME}(): Unrecognized option '$1'"
2850 ;;
2851 *)
2852 break
2853 ;;
2854 esac
2855 shift
2856 done
2857
2858 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
2859 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2860 fi
2861
2862 if [[ "$#" -eq 0 ]]; then
2863 die "${FUNCNAME}(): Missing files or directories"
2864 fi
2865
2866 while (($#)); do
2867 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2868 die "${FUNCNAME}(): Invalid argument '$1'"
2869 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
2870 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
2871 elif [[ "$1" =~ ^/ ]]; then
2872 if _python_package_supporting_installation_for_multiple_python_abis; then
2873 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
2874 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
2875 fi
2876 if [[ "$1" != *\$* ]]; then
2877 die "${FUNCNAME}(): '$1' has invalid syntax"
2878 fi
2879 if [[ "$1" == *.py ]]; then
2880 evaluated_files+=("$1")
2881 else
2882 evaluated_dirs+=("$1")
2883 fi
2884 else
2885 if [[ -d "${root}$1" ]]; then
2886 other_dirs+=("${root}$1")
2887 elif [[ -f "${root}$1" ]]; then
2888 other_files+=("${root}$1")
2889 elif [[ -e "${root}$1" ]]; then
2890 eerror "${FUNCNAME}(): '${root}$1' is not a regular file or a directory"
2891 else
2892 eerror "${FUNCNAME}(): '${root}$1' does not exist"
2893 fi
2894 fi
2895 else
2896 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2897 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
2898 site_packages_dirs+=("$1")
2899 break
2900 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
2901 site_packages_files+=("$1")
2902 break
2903 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
2904 eerror "${FUNCNAME}(): '$1' is not a regular file or a directory"
2905 else
2906 eerror "${FUNCNAME}(): '$1' does not exist"
2907 fi
2908 done
2909 fi
2910 shift
2911 done
2912
2913 # Set additional options.
2914 options+=("-q")
2915
2916 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2917 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})) || ((${#evaluated_dirs[@]})) || ((${#evaluated_files[@]})); then
2918 return_code="0"
2919 stderr=""
2920 ebegin "Compilation and optimization of Python modules for $(python_get_implementation_and_version)"
2921 if ((${#site_packages_dirs[@]})) || ((${#evaluated_dirs[@]})); then
2922 for dir in "${site_packages_dirs[@]}"; do
2923 dirs+=("${root}$(python_get_sitedir)/${dir}")
2924 done
2925 for dir in "${evaluated_dirs[@]}"; do
2926 eval "dirs+=(\"\${root}${dir}\")"
2927 done
2928 stderr+="${stderr:+$'\n'}$("$(PYTHON)" -m compileall "${options[@]}" "${dirs[@]}" 2>&1)" || return_code="1"
2929 if ! has "$(_python_get_implementation "${PYTHON_ABI}")" Jython PyPy; then
2930 "$(PYTHON)" -O -m compileall "${options[@]}" "${dirs[@]}" &> /dev/null || return_code="1"
2931 fi
2932 _python_clean_compiled_modules "${dirs[@]}"
2933 fi
2934 if ((${#site_packages_files[@]})) || ((${#evaluated_files[@]})); then
2935 for file in "${site_packages_files[@]}"; do
2936 files+=("${root}$(python_get_sitedir)/${file}")
2937 done
2938 for file in "${evaluated_files[@]}"; do
2939 eval "files+=(\"\${root}${file}\")"
2940 done
2941 stderr+="${stderr:+$'\n'}$("$(PYTHON)" -m py_compile "${files[@]}" 2>&1)" || return_code="1"
2942 if ! has "$(_python_get_implementation "${PYTHON_ABI}")" Jython PyPy; then
2943 "$(PYTHON)" -O -m py_compile "${files[@]}" &> /dev/null || return_code="1"
2944 fi
2945 _python_clean_compiled_modules "${files[@]}"
2946 fi
2947 eend "${return_code}"
2948 if [[ -n "${stderr}" ]]; then
2949 eerror "Syntax errors / warnings in Python modules for $(python_get_implementation_and_version):" &> /dev/null
2950 while read stderr_line; do
2951 eerror " ${stderr_line}"
2952 done <<< "${stderr}"
2953 fi
2954 fi
2955 unset dirs files
2956 done
2957
2958 if _python_package_supporting_installation_for_multiple_python_abis; then
2959 # Restore previous value of PYTHON_ABI.
2960 if [[ -n "${previous_PYTHON_ABI}" ]]; then
2961 PYTHON_ABI="${previous_PYTHON_ABI}"
2962 else
2963 unset PYTHON_ABI
2964 fi
2965 fi
2966
2967 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then
2968 return_code="0"
2969 stderr=""
2970 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for $(python_get_implementation_and_version)"
2971 if ((${#other_dirs[@]})); then
2972 stderr+="${stderr:+$'\n'}$("$(PYTHON ${PYTHON_ABI})" -m compileall "${options[@]}" "${other_dirs[@]}" 2>&1)" || return_code="1"
2973 if ! has "$(_python_get_implementation "${PYTHON_ABI}")" Jython PyPy; then
2974 "$(PYTHON ${PYTHON_ABI})" -O -m compileall "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
2975 fi
2976 _python_clean_compiled_modules "${other_dirs[@]}"
2977 fi
2978 if ((${#other_files[@]})); then
2979 stderr+="${stderr:+$'\n'}$("$(PYTHON ${PYTHON_ABI})" -m py_compile "${other_files[@]}" 2>&1)" || return_code="1"
2980 if ! has "$(_python_get_implementation "${PYTHON_ABI}")" Jython PyPy; then
2981 "$(PYTHON ${PYTHON_ABI})" -O -m py_compile "${other_files[@]}" &> /dev/null || return_code="1"
2982 fi
2983 _python_clean_compiled_modules "${other_files[@]}"
2984 fi
2985 eend "${return_code}"
2986 if [[ -n "${stderr}" ]]; then
2987 eerror "Syntax errors / warnings in Python modules placed outside of site-packages directories for $(python_get_implementation_and_version):" &> /dev/null
2988 while read stderr_line; do
2989 eerror " ${stderr_line}"
2990 done <<< "${stderr}"
2991 fi
2992 fi
2993 else
2994 # Deprecated part of python_mod_optimize()
2995 ewarn
2996 ewarn "Deprecation Warning: Usage of ${FUNCNAME}() in packages not supporting installation"
2997 ewarn "for multiple Python ABIs in EAPI <=2 is deprecated and will be disallowed on 2011-08-01."
2998 ewarn "Use EAPI >=3 and call ${FUNCNAME}() with paths having appropriate syntax."
2999 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
3000 ewarn
3001
3002 local myroot mydirs=() myfiles=() myopts=() return_code="0"
3003
3004 # strip trailing slash
3005 myroot="${EROOT%/}"
3006
3007 # respect EROOT and options passed to compileall.py
3008 while (($#)); do
3009 case "$1" in
3010 -l|-f|-q)
3011 myopts+=("$1")
3012 ;;
3013 -d|-x)
3014 myopts+=("$1" "$2")
3015 shift
3016 ;;
3017 --)
3018 shift
3019 break
3020 ;;
3021 -*)
3022 die "${FUNCNAME}(): Unrecognized option '$1'"
3023 ;;
3024 *)
3025 break
3026 ;;
3027 esac
3028 shift
3029 done
3030
3031 if [[ "$#" -eq 0 ]]; then
3032 die "${FUNCNAME}(): Missing files or directories"
3033 fi
3034
3035 while (($#)); do
3036 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
3037 die "${FUNCNAME}(): Invalid argument '$1'"
3038 elif [[ -d "${myroot}/${1#/}" ]]; then
3039 mydirs+=("${myroot}/${1#/}")
3040 elif [[ -f "${myroot}/${1#/}" ]]; then
3041 myfiles+=("${myroot}/${1#/}")
3042 elif [[ -e "${myroot}/${1#/}" ]]; then
3043 eerror "${FUNCNAME}(): ${myroot}/${1#/} is not a regular file or directory"
3044 else
3045 eerror "${FUNCNAME}(): ${myroot}/${1#/} does not exist"
3046 fi
3047 shift
3048 done
3049
3050 # set additional opts
3051 myopts+=(-q)
3052
3053 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
3054
3055 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
3056 if ((${#mydirs[@]})); then
3057 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1"
3058 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
3059 _python_clean_compiled_modules "${mydirs[@]}"
3060 fi
3061
3062 if ((${#myfiles[@]})); then
3063 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" || return_code="1"
3064 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null || return_code="1"
3065 _python_clean_compiled_modules "${myfiles[@]}"
3066 fi
3067
3068 eend "${return_code}"
3069 fi
245} 3070}
246 3071
247# @FUNCTION: python_mod_cleanup 3072# @FUNCTION: python_mod_cleanup
248# @USAGE: [ dir ] 3073# @USAGE: [--allow-evaluated-non-sitedir-paths] [--] <file|directory> [files|directories]
249# @DESCRIPTION: 3074# @DESCRIPTION:
250# Run with optional arguments, where arguments are directories of 3075# Delete orphaned byte-compiled Python modules corresponding to specified Python modules.
251# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
252# 3076#
253# It will recursively scan all compiled python modules in the directories 3077# This function can be used only in pkg_postrm() phase.
254# and determine if they are orphaned (eg. their corresponding .py is missing.)
255# if they are, then it will remove their corresponding .pyc and .pyo
256#
257# This function should only be run in pkg_postrm()
258python_mod_cleanup() { 3078python_mod_cleanup() {
259 local SEARCH_PATH myroot
260
261 # Check if phase is pkg_postrm()
262 [[ ${EBUILD_PHASE} != postrm ]] &&\ 3079 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
263 die "${FUNCNAME} should only be run in pkg_postrm()" 3080 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
3081 fi
264 3082
3083 _python_check_python_pkg_setup_execution
3084 _python_initialize_prefix_variables
3085
3086 local allow_evaluated_non_sitedir_paths="0" dir iterated_PYTHON_ABIS PYTHON_ABI="${PYTHON_ABI}" root search_paths=() sitedir
3087
3088 if _python_package_supporting_installation_for_multiple_python_abis; then
3089 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
3090 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
3091 fi
3092 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
3093 else
3094 if has "${EAPI:-0}" 0 1 2 3; then
3095 iterated_PYTHON_ABIS="${PYTHON_ABI:-$(PYTHON --ABI)}"
3096 else
3097 iterated_PYTHON_ABIS="${PYTHON_ABI}"
3098 fi
3099 fi
3100
265 # strip trailing slash 3101 # Strip trailing slash from EROOT.
266 myroot="${ROOT%/}" 3102 root="${EROOT%/}"
267 3103
3104 while (($#)); do
3105 case "$1" in
3106 --allow-evaluated-non-sitedir-paths)
3107 allow_evaluated_non_sitedir_paths="1"
3108 ;;
3109 --)
3110 shift
3111 break
3112 ;;
3113 -*)
3114 die "${FUNCNAME}(): Unrecognized option '$1'"
3115 ;;
3116 *)
3117 break
3118 ;;
3119 esac
3120 shift
3121 done
3122
3123 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
3124 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
3125 fi
3126
268 if [ $# -gt 0 ]; then 3127 if [[ "$#" -eq 0 ]]; then
269 for path in $@; do 3128 die "${FUNCNAME}(): Missing files or directories"
270 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}" 3129 fi
3130
3131 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis || _python_implementation || [[ "${CATEGORY}/${PN}" == "sys-apps/portage" ]]; then
3132 while (($#)); do
3133 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
3134 die "${FUNCNAME}(): Invalid argument '$1'"
3135 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
3136 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
3137 elif [[ "$1" =~ ^/ ]]; then
3138 if _python_package_supporting_installation_for_multiple_python_abis; then
3139 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
3140 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
3141 fi
3142 if [[ "$1" != *\$* ]]; then
3143 die "${FUNCNAME}(): '$1' has invalid syntax"
3144 fi
3145 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
3146 eval "search_paths+=(\"\${root}$1\")"
3147 done
3148 else
3149 search_paths+=("${root}$1")
3150 fi
3151 else
3152 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
3153 search_paths+=("${root}$(python_get_sitedir)/$1")
3154 done
3155 fi
3156 shift
271 done 3157 done
272 else 3158 else
273 for path in ${myroot}/usr/lib*/python*/site-packages; do 3159 # Deprecated part of python_mod_cleanup()
274 SEARCH_PATH="${SEARCH_PATH} ${path}" 3160 ewarn
275 done 3161 ewarn "Deprecation Warning: Usage of ${FUNCNAME}() in packages not supporting installation"
276 fi 3162 ewarn "for multiple Python ABIs in EAPI <=2 is deprecated and will be disallowed on 2011-08-01."
3163 ewarn "Use EAPI >=3 and call ${FUNCNAME}() with paths having appropriate syntax."
3164 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
3165 ewarn
277 3166
278 for path in ${SEARCH_PATH}; do 3167 search_paths=("${@#/}")
279 einfo "Cleaning orphaned Python bytecode from ${path} .." 3168 search_paths=("${search_paths[@]/#/${root}/}")
280 for obj in $(find ${path} -name '*.py[co]'); do
281 src_py="${obj%[co]}"
282 if [ ! -f "${src_py}" ]; then
283 einfo "Purging ${src_py}[co]"
284 rm -f ${src_py}[co]
285 fi 3169 fi
286 done 3170
287 # attempt to remove directories that maybe empty 3171 _python_clean_compiled_modules "${search_paths[@]}"
288 for dir in $(find ${path} -type d | sort -r); do
289 rmdir ${dir} 2>/dev/null
290 done
291 done
292} 3172}
3173
3174# ================================================================================================
3175# ===================================== DEPRECATED FUNCTIONS =====================================
3176# ================================================================================================
3177
3178fi # _PYTHON_ECLASS_INHERITED

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.151

  ViewVC Help
Powered by ViewVC 1.1.20