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

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

  ViewVC Help
Powered by ViewVC 1.1.20