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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.66  
changed lines
  Added in v.1.128

  ViewVC Help
Powered by ViewVC 1.1.20