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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.85  
changed lines
  Added in v.1.133

  ViewVC Help
Powered by ViewVC 1.1.20