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

Diff of /eclass/python.eclass

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

Revision 1.89 Revision 1.103
1# Copyright 1999-2010 Gentoo Foundation 1# Copyright 1999-2010 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.89 2010/02/14 18:53:11 arfrever Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.103 2010/10/03 00:38:13 arfrever Exp $
4 4
5# @ECLASS: python.eclass 5# @ECLASS: python.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# Gentoo Python Project <python@gentoo.org> 7# Gentoo Python Project <python@gentoo.org>
8# @BLURB: Eclass for Python packages 8# @BLURB: Eclass for Python packages
159 die "PYTHON_DEPEND and NEED_PYTHON cannot be set simultaneously" 159 die "PYTHON_DEPEND and NEED_PYTHON cannot be set simultaneously"
160elif [[ -n "${PYTHON_DEPEND}" ]]; then 160elif [[ -n "${PYTHON_DEPEND}" ]]; then
161 _parse_PYTHON_DEPEND 161 _parse_PYTHON_DEPEND
162elif [[ -n "${NEED_PYTHON}" ]]; then 162elif [[ -n "${NEED_PYTHON}" ]]; then
163 if ! has "${EAPI:-0}" 0 1 2; then 163 if ! has "${EAPI:-0}" 0 1 2; then
164 eerror "Use PYTHON_DEPEND instead of NEED_PYTHON." 164 eerror "Use PYTHON_DEPEND variable instead of NEED_PYTHON variable."
165 die "NEED_PYTHON cannot be used in this EAPI" 165 die "NEED_PYTHON variable cannot be used in this EAPI"
166 fi 166 fi
167
168 ewarn
169 ewarn "\"${EBUILD}\":"
170 ewarn "Deprecation Warning: NEED_PYTHON variable is deprecated and will be banned on 2010-10-01."
171 ewarn "Use PYTHON_DEPEND variable instead of NEED_PYTHON variable."
172 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
173 ewarn
174
175 unset _BOLD _NORMAL
176
167 _PYTHON_ATOMS=(">=dev-lang/python-${NEED_PYTHON}") 177 _PYTHON_ATOMS=(">=dev-lang/python-${NEED_PYTHON}")
168 DEPEND+="${DEPEND:+ }${_PYTHON_ATOMS[@]}" 178 DEPEND+="${DEPEND:+ }${_PYTHON_ATOMS[@]}"
169 RDEPEND+="${RDEPEND:+ }${_PYTHON_ATOMS[@]}" 179 RDEPEND+="${RDEPEND:+ }${_PYTHON_ATOMS[@]}"
170else 180else
171 _PYTHON_ATOMS=("dev-lang/python") 181 _PYTHON_ATOMS=("dev-lang/python")
182# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT 192# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT
183# @DESCRIPTION: 193# @DESCRIPTION:
184# Set this to a name of a USE flag if you need to make either PYTHON_USE_WITH or 194# Set this to a name of a USE flag if you need to make either PYTHON_USE_WITH or
185# PYTHON_USE_WITH_OR atoms conditional under a USE flag. 195# PYTHON_USE_WITH_OR atoms conditional under a USE flag.
186 196
187# @FUNCTION: python_pkg_setup
188# @DESCRIPTION:
189# Makes sure PYTHON_USE_WITH or PYTHON_USE_WITH_OR listed use flags
190# are respected. Only exported if one of those variables is set.
191if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then 197if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
192 python_pkg_setup() {
193 python_pkg_setup_fail() {
194 eerror "${1}"
195 die "${1}"
196 }
197
198 [[ ${PYTHON_USE_WITH_OPT} ]] && use !${PYTHON_USE_WITH_OPT} && return
199
200 python_pkg_setup_check_USE_flags() {
201 local pyatom use
202 pyatom="$(python_get_implementational_package)"
203
204 for use in ${PYTHON_USE_WITH}; do
205 if ! has_version "${pyatom}[${use}]"; then
206 python_pkg_setup_fail "Please rebuild ${pyatom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
207 fi
208 done
209
210 for use in ${PYTHON_USE_WITH_OR}; do
211 if has_version "${pyatom}[${use}]"; then
212 return
213 fi
214 done
215
216 if [[ ${PYTHON_USE_WITH_OR} ]]; then
217 python_pkg_setup_fail "Please rebuild ${pyatom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
218 fi
219 }
220
221 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
222 python_execute_function -q python_pkg_setup_check_USE_flags
223 else
224 python_pkg_setup_check_USE_flags
225 fi
226
227 unset -f python_pkg_setup_check_USE_flags python_pkg_setup_fail
228 }
229
230 EXPORT_FUNCTIONS pkg_setup
231
232 _PYTHON_USE_WITH_ATOM="" 198 _PYTHON_USE_WITH_ATOMS_ARRAY=()
233 if [[ -n "${PYTHON_USE_WITH}" ]]; then 199 if [[ -n "${PYTHON_USE_WITH}" ]]; then
234 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do 200 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
235 _PYTHON_USE_WITH_ATOM+="${_PYTHON_USE_WITH_ATOM:+ }${_PYTHON_ATOM}[${PYTHON_USE_WITH/ /,}]" 201 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${PYTHON_USE_WITH// /,}]")
236 done 202 done
237 _PYTHON_USE_WITH_ATOM="|| ( ${_PYTHON_USE_WITH_ATOM} )"
238 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then 203 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then
239 for _USE_flag in ${PYTHON_USE_WITH_OR}; do 204 for _USE_flag in ${PYTHON_USE_WITH_OR}; do
240 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do 205 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
241 _PYTHON_USE_WITH_ATOM+="${_PYTHON_USE_WITH_ATOM:+ }${_PYTHON_ATOM}[${_USE_flag}]" 206 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${_USE_flag}]")
242 done 207 done
243 done 208 done
244 unset _USE_flag 209 unset _USE_flag
210 fi
211 if [[ "${#_PYTHON_USE_WITH_ATOMS_ARRAY[@]}" -gt 1 ]]; then
245 _PYTHON_USE_WITH_ATOM="|| ( ${_PYTHON_USE_WITH_ATOM} )" 212 _PYTHON_USE_WITH_ATOMS="|| ( ${_PYTHON_USE_WITH_ATOMS_ARRAY[@]} )"
213 else
214 _PYTHON_USE_WITH_ATOMS="${_PYTHON_USE_WITH_ATOMS_ARRAY[@]}"
246 fi 215 fi
247 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then 216 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then
248 _PYTHON_USE_WITH_ATOM="${PYTHON_USE_WITH_OPT}? ( ${_PYTHON_USE_WITH_ATOM} )" 217 _PYTHON_USE_WITH_ATOMS="${PYTHON_USE_WITH_OPT}? ( ${_PYTHON_USE_WITH_ATOMS} )"
249 fi 218 fi
250 DEPEND+=" ${_PYTHON_USE_WITH_ATOM}" 219 DEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
251 RDEPEND+=" ${_PYTHON_USE_WITH_ATOM}" 220 RDEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
252 unset _PYTHON_ATOM _PYTHON_USE_WITH_ATOM 221 unset _PYTHON_ATOM _PYTHON_USE_WITH_ATOMS _PYTHON_USE_WITH_ATOMS_ARRAY
253fi 222fi
254 223
255unset _PYTHON_ATOMS 224unset _PYTHON_ATOMS
256 225
257# ================================================================================================ 226# ================================================================================================
258# ======== FUNCTIONS FOR PACKAGES SUPPORTING INSTALLATION FOR MULTIPLE VERSIONS OF PYTHON ======== 227# =================================== MISCELLANEOUS FUNCTIONS ====================================
259# ================================================================================================ 228# ================================================================================================
260 229
230_python_implementation() {
231 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then
232 return 0
233 elif [[ "${CATEGORY}/${PN}" == "dev-java/jython" ]]; then
234 return 0
235 else
236 return 1
237 fi
238}
239
240_python_package_supporting_installation_for_multiple_python_abis() {
241 if [[ "${EBUILD_PHASE}" == "depend" ]]; then
242 die "${FUNCNAME}() cannot be used in global scope"
243 fi
244
245 if has "${EAPI:-0}" 0 1 2 3 4; then
246 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
247 return 0
248 else
249 return 1
250 fi
251 else
252 die "${FUNCNAME}(): Support for EAPI=\"${EAPI}\" not implemented"
253 fi
254}
255
256_python_abi-specific_local_scope() {
257 [[ " ${FUNCNAME[@]:2} " =~ " "(_python_final_sanity_checks|python_execute_function|python_mod_optimize|python_mod_cleanup)" " ]]
258}
259
260_python_initialize_prefix_variables() {
261 if has "${EAPI:-0}" 0 1 2; then
262 if [[ -n "${ROOT}" && -z "${EROOT}" ]]; then
263 EROOT="${ROOT%/}${EPREFIX}/"
264 fi
265 if [[ -n "${D}" && -z "${ED}" ]]; then
266 ED="${D%/}${EPREFIX}/"
267 fi
268 fi
269}
270
271unset PYTHON_SANITY_CHECKS_EXECUTED PYTHON_SKIP_SANITY_CHECKS
272
273_python_initial_sanity_checks() {
274 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
275 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
276 if [[ "$(readlink "${EPREFIX}/usr/bin/python")" != "python-wrapper" ]]; then
277 eerror "'${EPREFIX}/usr/bin/python' is not valid symlink."
278 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
279 die "'${EPREFIX}/usr/bin/python' is not valid symlink"
280 fi
281 if [[ "$(<"${EPREFIX}/usr/bin/python-config")" != *"Gentoo python-config wrapper script"* ]]; then
282 eerror "'${EPREFIX}/usr/bin/python-config' is not valid script"
283 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
284 die "'${EPREFIX}/usr/bin/python-config' is not valid script"
285 fi
286 fi
287}
288
289_python_final_sanity_checks() {
290 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
291 local PYTHON_ABI="${PYTHON_ABI}"
292 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI}}; do
293 # Ensure that appropriate version of Python is installed.
294 if ! has_version "$(python_get_implementational_package)"; then
295 die "$(python_get_implementational_package) is not installed"
296 fi
297
298 # Ensure that EPYTHON variable is respected.
299 if [[ "$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")" != "${PYTHON_ABI}" ]]; then
300 eerror "Path to 'python': '$(type -p python)'"
301 eerror "ABI: '${ABI}'"
302 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
303 eerror "EPYTHON: '$(PYTHON)'"
304 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
305 eerror "Locally active version of Python: '$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")'"
306 die "'python' does not respect EPYTHON variable"
307 fi
308 done
309 fi
310 PYTHON_SANITY_CHECKS_EXECUTED="1"
311}
312
313# @ECLASS-VARIABLE: PYTHON_COLORS
314# @DESCRIPTION:
315# User-configurable colored output.
316PYTHON_COLORS="${PYTHON_COLORS:-0}"
317
318_python_set_color_variables() {
319 if [[ "${PYTHON_COLORS}" != "0" && "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
320 _BOLD=$'\e[1m'
321 _RED=$'\e[1;31m'
322 _GREEN=$'\e[1;32m'
323 _BLUE=$'\e[1;34m'
324 _CYAN=$'\e[1;36m'
325 _NORMAL=$'\e[0m'
326 else
327 _BOLD=
328 _RED=
329 _GREEN=
330 _BLUE=
331 _CYAN=
332 _NORMAL=
333 fi
334}
335
336unset PYTHON_PKG_SETUP_EXECUTED
337
338_python_check_python_pkg_setup_execution() {
339 [[ " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " ]] && return
340
341 if ! has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_PKG_SETUP_EXECUTED}" ]]; then
342 die "python_pkg_setup() not called"
343 fi
344}
345
346# @FUNCTION: python_pkg_setup
347# @DESCRIPTION:
348# Perform sanity checks and initialize environment.
349#
350# This function is exported in EAPI 2 and 3 when PYTHON_USE_WITH or PYTHON_USE_WITH_OR variable
351# is set and always in EAPI >=4. Calling of this function is mandatory in EAPI >=4.
352#
353# This function can be used only in pkg_setup() phase.
354python_pkg_setup() {
355 # Check if phase is pkg_setup().
356 [[ "${EBUILD_PHASE}" != "setup" ]] && die "${FUNCNAME}() can be used only in pkg_setup() phase"
357
358 if [[ "$#" -ne 0 ]]; then
359 die "${FUNCNAME}() does not accept arguments"
360 fi
361
362 if _python_package_supporting_installation_for_multiple_python_abis; then
363 _python_calculate_PYTHON_ABIS
364 export EPYTHON="$(PYTHON -f)"
365 else
366 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
367 fi
368
369 if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; then
370 if [[ "${PYTHON_USE_WITH_OPT}" ]]; then
371 if [[ "${PYTHON_USE_WITH_OPT}" == !* ]]; then
372 use ${PYTHON_USE_WITH_OPT#!} && return
373 else
374 use !${PYTHON_USE_WITH_OPT} && return
375 fi
376 fi
377
378 python_pkg_setup_check_USE_flags() {
379 local python_atom USE_flag
380 python_atom="$(python_get_implementational_package)"
381
382 for USE_flag in ${PYTHON_USE_WITH}; do
383 if ! has_version "${python_atom}[${USE_flag}]"; then
384 eerror "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
385 die "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
386 fi
387 done
388
389 for USE_flag in ${PYTHON_USE_WITH_OR}; do
390 if has_version "${python_atom}[${USE_flag}]"; then
391 return
392 fi
393 done
394
395 if [[ ${PYTHON_USE_WITH_OR} ]]; then
396 eerror "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
397 die "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
398 fi
399 }
400
401 if _python_package_supporting_installation_for_multiple_python_abis; then
402 PYTHON_SKIP_SANITY_CHECKS="1" python_execute_function -q python_pkg_setup_check_USE_flags
403 else
404 python_pkg_setup_check_USE_flags
405 fi
406
407 unset -f python_pkg_setup_check_USE_flags
408 fi
409
410 PYTHON_PKG_SETUP_EXECUTED="1"
411}
412
413if ! has "${EAPI:-0}" 0 1 2 3 || has "${EAPI:-0}" 2 3 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; then
414 EXPORT_FUNCTIONS pkg_setup
415fi
416
417# @FUNCTION: python_convert_shebangs
418# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_version> <file|directory> [files|directories]
419# @DESCRIPTION:
420# Convert shebangs in specified files. Directories can be specified only with --recursive option.
421python_convert_shebangs() {
422 _python_check_python_pkg_setup_execution
423
424 local argument file files=() only_executables="0" python_version quiet="0" recursive="0"
425
426 while (($#)); do
427 case "$1" in
428 -r|--recursive)
429 recursive="1"
430 ;;
431 -q|--quiet)
432 quiet="1"
433 ;;
434 -x|--only-executables)
435 only_executables="1"
436 ;;
437 --)
438 shift
439 break
440 ;;
441 -*)
442 die "${FUNCNAME}(): Unrecognized option '$1'"
443 ;;
444 *)
445 break
446 ;;
447 esac
448 shift
449 done
450
451 if [[ "$#" -eq 0 ]]; then
452 die "${FUNCNAME}(): Missing Python version and files or directories"
453 elif [[ "$#" -eq 1 ]]; then
454 die "${FUNCNAME}(): Missing files or directories"
455 fi
456
457 python_version="$1"
458 shift
459
460 for argument in "$@"; do
461 if [[ ! -e "${argument}" ]]; then
462 die "${FUNCNAME}(): '${argument}' does not exist"
463 elif [[ -f "${argument}" ]]; then
464 files+=("${argument}")
465 elif [[ -d "${argument}" ]]; then
466 if [[ "${recursive}" == "1" ]]; then
467 while read -d $'\0' -r file; do
468 files+=("${file}")
469 done < <(find "${argument}" $([[ "${only_executables}" == "1" ]] && echo -perm /111) -type f -print0)
470 else
471 die "${FUNCNAME}(): '${argument}' is not a regular file"
472 fi
473 else
474 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory"
475 fi
476 done
477
478 for file in "${files[@]}"; do
479 file="${file#./}"
480 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
481
482 if [[ "$(head -n1 "${file}")" =~ ^'#!'.*python ]]; then
483 [[ "$(sed -ne "2p" "${file}")" =~ ^"# Gentoo '".*"' wrapper script generated by python_generate_wrapper_scripts()"$ ]] && continue
484
485 if [[ "${quiet}" == "0" ]]; then
486 einfo "Converting shebang in '${file}'"
487 fi
488
489 sed -e "1s/python\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?/python${python_version}/" -i "${file}" || die "Conversion of shebang in '${file}' failed"
490
491 # Delete potential whitespace after "#!".
492 sed -e '1s/\(^#!\)[[:space:]]*/\1/' -i "${file}" || die "sed '${file}' failed"
493 fi
494 done
495}
496
497# @FUNCTION: python_clean_installation_image
498# @USAGE: [-q|--quiet]
499# @DESCRIPTION:
500# Delete needless files in installation image.
501python_clean_installation_image() {
502 _python_check_python_pkg_setup_execution
503 _python_initialize_prefix_variables
504
505 local file files=() quiet="0"
506
507 # Check if phase is src_install().
508 [[ "${EBUILD_PHASE}" != "install" ]] && die "${FUNCNAME}() can be used only in src_install() phase"
509
510 while (($#)); do
511 case "$1" in
512 -q|--quiet)
513 quiet="1"
514 ;;
515 -*)
516 die "${FUNCNAME}(): Unrecognized option '$1'"
517 ;;
518 *)
519 die "${FUNCNAME}(): Invalid usage"
520 ;;
521 esac
522 shift
523 done
524
525 while read -d $'\0' -r file; do
526 files+=("${file}")
527 done < <(find "${ED}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -type f -print0)
528
529 if [[ "${#files[@]}" -gt 0 ]]; then
530 if [[ "${quiet}" == "0" ]]; then
531 ewarn "Deleting byte-compiled Python modules needlessly generated by build system:"
532 fi
533 for file in "${files[@]}"; do
534 if [[ "${quiet}" == "0" ]]; then
535 ewarn " ${file}"
536 fi
537 rm -f "${file}"
538
539 # Delete empty __pycache__ directories.
540 if [[ "${file%/*}" == *"/__pycache__" ]]; then
541 rmdir "${file%/*}" 2> /dev/null
542 fi
543 done
544 fi
545
546 python_clean_sitedirs() {
547 if [[ -d "${ED}$(python_get_sitedir)" ]]; then
548 find "${ED}$(python_get_sitedir)" "(" -name "*.c" -o -name "*.h" -o -name "*.la" ")" -type f -print0 | xargs -0 rm -f
549 fi
550 }
551 if _python_package_supporting_installation_for_multiple_python_abis; then
552 python_execute_function -q python_clean_sitedirs
553 else
554 python_clean_sitedirs
555 fi
556
557 unset -f python_clean_sitedirs
558}
559
560# ================================================================================================
561# =========== FUNCTIONS FOR PACKAGES SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ============
562# ================================================================================================
563
261# @ECLASS-VARIABLE: SUPPORT_PYTHON_ABIS 564# @ECLASS-VARIABLE: SUPPORT_PYTHON_ABIS
262# @DESCRIPTION: 565# @DESCRIPTION:
263# Set this in EAPI <= 4 to indicate that current package supports installation for 566# Set this in EAPI <= 4 to indicate that current package supports installation for
264# multiple versions of Python. 567# multiple Python ABIs.
265 568
266# @ECLASS-VARIABLE: PYTHON_DEFINE_DEFAULT_FUNCTIONS 569# @ECLASS-VARIABLE: PYTHON_EXPORT_PHASE_FUNCTIONS
267# @DESCRIPTION: 570# @DESCRIPTION:
268# Set this to define default functions for the following ebuild phases: 571# Set this to export phase functions for the following ebuild phases:
269# src_prepare, src_configure, src_compile, src_test, src_install. 572# src_prepare, src_configure, src_compile, src_test, src_install.
270if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_DEFINE_DEFAULT_FUNCTIONS}" ]]; then 573if ! has "${EAPI:-0}" 0 1; then
271 python_src_prepare() { 574 python_src_prepare() {
575 _python_check_python_pkg_setup_execution
576
577 if ! _python_package_supporting_installation_for_multiple_python_abis; then
578 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
579 fi
580
581 if [[ "$#" -ne 0 ]]; then
582 die "${FUNCNAME}() does not accept arguments"
583 fi
584
272 python_copy_sources 585 python_copy_sources
273 } 586 }
274 587
275 for python_default_function in src_configure src_compile src_test src_install; do 588 for python_default_function in src_configure src_compile src_test src_install; do
276 eval "python_${python_default_function}() { python_execute_function -d -s; }" 589 eval "python_${python_default_function}() {
590 _python_check_python_pkg_setup_execution
591
592 if ! _python_package_supporting_installation_for_multiple_python_abis; then
593 die \"\${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs\"
594 fi
595
596 python_execute_function -d -s -- \"\$@\"
597 }"
277 done 598 done
278 unset python_default_function 599 unset python_default_function
279 600
601 if [[ -n "${PYTHON_EXPORT_PHASE_FUNCTIONS}" ]]; then
280 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install 602 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install
603 fi
281fi 604fi
282 605
283unset PYTHON_ABIS 606unset PYTHON_ABIS
284unset PYTHON_ABIS_SANITY_CHECKS
285 607
286# @FUNCTION: validate_PYTHON_ABIS 608_python_calculate_PYTHON_ABIS() {
287# @DESCRIPTION: 609 if ! _python_package_supporting_installation_for_multiple_python_abis; then
288# Ensure that PYTHON_ABIS variable has valid value. 610 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
289# This function usually should not be directly called in ebuilds.
290validate_PYTHON_ABIS() {
291 # Ensure that some functions cannot be accidentally successfully used in EAPI <= 4 without setting SUPPORT_PYTHON_ABIS variable.
292 if has "${EAPI:-0}" 0 1 2 3 4 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
293 die "${FUNCNAME}() cannot be used in this EAPI without setting SUPPORT_PYTHON_ABIS variable"
294 fi 611 fi
295 612
296 # Ensure that /usr/bin/python and /usr/bin/python-config are valid. 613 _python_initial_sanity_checks
297 if [[ "$(readlink "${EPREFIX}/usr/bin/python")" != "python-wrapper" ]]; then
298 eerror "'${EPREFIX}/usr/bin/python' is not valid symlink."
299 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
300 die "'${EPREFIX}/usr/bin/python' is not valid symlink"
301 fi
302 if [[ "$(<"${EPREFIX}/usr/bin/python-config")" != *"Gentoo python-config wrapper script"* ]]; then
303 eerror "'${EPREFIX}/usr/bin/python-config' is not valid script"
304 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
305 die "'${EPREFIX}/usr/bin/python-config' is not valid script"
306 fi
307 614
308 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 5. 615 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 5.
309 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3 4; then 616 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3 4; then
310 local PYTHON_ABI restricted_ABI support_ABI supported_PYTHON_ABIS= 617 local PYTHON_ABI restricted_ABI support_ABI supported_PYTHON_ABIS=
311 PYTHON_ABI_SUPPORTED_VALUES="${_CPYTHON2_SUPPORTED_ABIS[@]} ${_CPYTHON3_SUPPORTED_ABIS[@]} ${_JYTHON_SUPPORTED_ABIS[@]}" 618 PYTHON_ABI_SUPPORTED_VALUES="${_CPYTHON2_SUPPORTED_ABIS[@]} ${_CPYTHON3_SUPPORTED_ABIS[@]} ${_JYTHON_SUPPORTED_ABIS[@]}"
312 619
313 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then 620 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
314 local python2_enabled="0" python3_enabled="0" 621 local cpython_enabled="0"
315 622
316 if [[ -z "${USE_PYTHON}" ]]; then 623 if [[ -z "${USE_PYTHON}" ]]; then
317 die "USE_PYTHON variable is empty" 624 die "USE_PYTHON variable is empty"
318 fi 625 fi
319 626
320 for PYTHON_ABI in ${USE_PYTHON}; do 627 for PYTHON_ABI in ${USE_PYTHON}; do
321 if ! has "${PYTHON_ABI}" ${PYTHON_ABI_SUPPORTED_VALUES}; then 628 if ! has "${PYTHON_ABI}" ${PYTHON_ABI_SUPPORTED_VALUES}; then
322 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'" 629 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'"
323 fi 630 fi
324 631
325 if has "${PYTHON_ABI}" "${_CPYTHON2_SUPPORTED_ABIS[@]}"; then 632 if has "${PYTHON_ABI}" "${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}"; then
326 python2_enabled="1" 633 cpython_enabled="1"
327 fi
328 if has "${PYTHON_ABI}" "${_CPYTHON3_SUPPORTED_ABIS[@]}"; then
329 python3_enabled="1"
330 fi 634 fi
331 635
332 support_ABI="1" 636 support_ABI="1"
333 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 637 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
334 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then 638 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
338 done 642 done
339 [[ "${support_ABI}" == "1" ]] && export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}" 643 [[ "${support_ABI}" == "1" ]] && export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}"
340 done 644 done
341 645
342 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then 646 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then
343 die "USE_PYTHON variable does not enable any version of Python supported by ${CATEGORY}/${PF}" 647 die "USE_PYTHON variable does not enable any Python ABI supported by ${CATEGORY}/${PF}"
344 fi 648 fi
345 649
346 if [[ "${python2_enabled}" == "0" ]]; then 650 if [[ "${cpython_enabled}" == "0" ]]; then
347 ewarn "USE_PYTHON variable does not enable any version of Python 2. This configuration is unsupported."
348 fi
349 if [[ "${python3_enabled}" == "0" ]]; then
350 ewarn "USE_PYTHON variable does not enable any version of Python 3. This configuration is unsupported."
351 fi
352 if [[ "${python2_enabled}" == "0" && "${python3_enabled}" == "0" ]]; then
353 die "USE_PYTHON variable does not enable any version of CPython" 651 die "USE_PYTHON variable does not enable any CPython ABI"
354 fi 652 fi
355 else 653 else
356 local python_version python2_version= python3_version= support_python_major_version 654 local python_version python2_version= python3_version= support_python_major_version
655
656 if ! has_version "dev-lang/python"; then
657 die "${FUNCNAME}(): 'dev-lang/python' is not installed"
658 fi
357 659
358 python_version="$("${EPREFIX}/usr/bin/python" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')" 660 python_version="$("${EPREFIX}/usr/bin/python" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
359 661
360 if has_version "=dev-lang/python-2*"; then 662 if has_version "=dev-lang/python-2*"; then
361 if [[ "$(readlink "${EPREFIX}/usr/bin/python2")" != "python2."* ]]; then 663 if [[ "$(readlink "${EPREFIX}/usr/bin/python2")" != "python2."* ]]; then
426 PYTHON_ABIS="${PYTHON_ABIS# }" 728 PYTHON_ABIS="${PYTHON_ABIS# }"
427 export PYTHON_ABIS="${PYTHON_ABIS% }" 729 export PYTHON_ABIS="${PYTHON_ABIS% }"
428 fi 730 fi
429 fi 731 fi
430 732
431 if ! _python_implementation && [[ "$(declare -p PYTHON_ABIS_SANITY_CHECKS 2> /dev/null)" != "declare -- PYTHON_ABIS_SANITY_CHECKS="* ]]; then 733 _python_final_sanity_checks
432 local PYTHON_ABI 734}
433 for PYTHON_ABI in ${PYTHON_ABIS}; do 735
434 # Ensure that appropriate version of Python is installed. 736_python_prepare_flags() {
435 if ! has_version "$(python_get_implementational_package)"; then 737 local array=() deleted_flag element flags new_value old_flag old_value operator pattern prefix variable
436 die "$(python_get_implementational_package) is not installed" 738
739 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
740 eval "_PYTHON_SAVED_${variable}=\"\${!variable}\""
741 for prefix in PYTHON_USER_ PYTHON_; do
742 if [[ "$(declare -p ${prefix}${variable} 2> /dev/null)" == "declare -a ${prefix}${variable}="* ]]; then
743 eval "array=(\"\${${prefix}${variable}[@]}\")"
744 for element in "${array[@]}"; do
745 if [[ "${element}" =~ ^([[:alnum:]]|\.|-|\*|\[|\])+\ (\+|-)\ .+ ]]; then
746 pattern="${element%% *}"
747 element="${element#* }"
748 operator="${element%% *}"
749 flags="${element#* }"
750 if [[ "${PYTHON_ABI}" == ${pattern} ]]; then
751 if [[ "${operator}" == "+" ]]; then
752 eval "export ${variable}+=\"\${variable:+ }${flags}\""
753 elif [[ "${operator}" == "-" ]]; then
754 flags="${flags// /$'\n'}"
755 old_value="${!variable// /$'\n'}"
756 new_value=""
757 while read old_flag; do
758 while read deleted_flag; do
759 if [[ "${old_flag}" == ${deleted_flag} ]]; then
760 continue 2
761 fi
762 done <<< "${flags}"
763 new_value+="${new_value:+ }${old_flag}"
764 done <<< "${old_value}"
765 eval "export ${variable}=\"\${new_value}\""
766 fi
767 fi
768 else
769 die "Element '${element}' of ${prefix}${variable} array has invalid syntax"
437 fi 770 fi
438 771 done
439 # Ensure that EPYTHON variable is respected. 772 elif [[ -n "$(declare -p ${prefix}${variable} 2> /dev/null)" ]]; then
440 if [[ "$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")" != "${PYTHON_ABI}" ]]; then 773 die "${prefix}${variable} should be indexed array"
441 eerror "python: '$(type -p python)'"
442 eerror "ABI: '${ABI}'"
443 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
444 eerror "EPYTHON: '$(PYTHON)'"
445 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
446 eerror "Version of enabled Python: '$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")'"
447 die "'python' does not respect EPYTHON variable"
448 fi 774 fi
449 done 775 done
450 PYTHON_ABIS_SANITY_CHECKS="1" 776 done
451 fi 777}
778
779_python_restore_flags() {
780 local variable
781
782 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
783 eval "${variable}=\"\${_PYTHON_SAVED_${variable}}\""
784 unset _PYTHON_SAVED_${variable}
785 done
452} 786}
453 787
454# @FUNCTION: python_execute_function 788# @FUNCTION: python_execute_function
455# @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--source-dir source_directory] [--] <function> [arguments] 789# @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]
456# @DESCRIPTION: 790# @DESCRIPTION:
457# Execute specified function for each value of PYTHON_ABIS, optionally passing additional 791# Execute specified function for each value of PYTHON_ABIS, optionally passing additional
458# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables. 792# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
459python_execute_function() { 793python_execute_function() {
460 local action action_message action_message_template= default_function="0" failure_message failure_message_template= function i nonfatal="0" previous_directory previous_directory_stack previous_directory_stack_length PYTHON_ABI quiet="0" separate_build_dirs="0" source_dir= 794 _python_check_python_pkg_setup_execution
795
796 if ! _python_package_supporting_installation_for_multiple_python_abis; then
797 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
798 fi
799
800 _python_set_color_variables
801
802 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=
461 803
462 while (($#)); do 804 while (($#)); do
463 case "$1" in 805 case "$1" in
464 --action-message) 806 --action-message)
465 action_message_template="$2" 807 action_message_template="$2"
470 ;; 812 ;;
471 --failure-message) 813 --failure-message)
472 failure_message_template="$2" 814 failure_message_template="$2"
473 shift 815 shift
474 ;; 816 ;;
817 -f|--final-ABI)
818 final_ABI="1"
819 ;;
475 --nonfatal) 820 --nonfatal)
476 nonfatal="1" 821 nonfatal="1"
477 ;; 822 ;;
478 -q|--quiet) 823 -q|--quiet)
479 quiet="1" 824 quiet="1"
512 857
513 if [[ -z "$(type -t "${function}")" ]]; then 858 if [[ -z "$(type -t "${function}")" ]]; then
514 die "${FUNCNAME}(): '${function}' function is not defined" 859 die "${FUNCNAME}(): '${function}' function is not defined"
515 fi 860 fi
516 else 861 else
517 if [[ "$#" -ne 0 ]]; then
518 die "${FUNCNAME}(): '--default-function' option and function name cannot be specified simultaneously"
519 fi
520 if has "${EAPI:-0}" 0 1; then 862 if has "${EAPI:-0}" 0 1; then
521 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI" 863 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
522 fi 864 fi
523 865
524 if [[ "${EBUILD_PHASE}" == "configure" ]]; then 866 if [[ "${EBUILD_PHASE}" == "configure" ]]; then
525 if has "${EAPI}" 2 3; then 867 if has "${EAPI}" 2 3; then
526 python_default_function() { 868 python_default_function() {
527 econf 869 econf "$@"
528 } 870 }
529 else 871 else
530 python_default_function() { 872 python_default_function() {
531 nonfatal econf 873 nonfatal econf "$@"
532 } 874 }
533 fi 875 fi
534 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then 876 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then
535 python_default_function() { 877 python_default_function() {
536 emake 878 emake "$@"
537 } 879 }
538 elif [[ "${EBUILD_PHASE}" == "test" ]]; then 880 elif [[ "${EBUILD_PHASE}" == "test" ]]; then
539 python_default_function() { 881 python_default_function() {
540 if emake -j1 -n check &> /dev/null; then 882 if emake -j1 -n check &> /dev/null; then
541 emake -j1 check 883 emake -j1 check "$@"
542 elif emake -j1 -n test &> /dev/null; then 884 elif emake -j1 -n test &> /dev/null; then
543 emake -j1 test 885 emake -j1 test "$@"
544 fi 886 fi
545 } 887 }
546 elif [[ "${EBUILD_PHASE}" == "install" ]]; then 888 elif [[ "${EBUILD_PHASE}" == "install" ]]; then
547 python_default_function() { 889 python_default_function() {
548 emake DESTDIR="${D}" install 890 emake DESTDIR="${D}" install "$@"
549 } 891 }
550 else 892 else
551 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase" 893 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase"
552 fi 894 fi
553 function="python_default_function" 895 function="python_default_function"
554 fi 896 fi
555 897
556 for ((i = 1; i < "${#FUNCNAME[@]}"; i++)); do 898 # Ensure that python_execute_function() cannot be directly or indirectly called by python_execute_function().
557 if [[ "${FUNCNAME[${i}]}" == "${FUNCNAME}" ]]; then 899 if _python_abi-specific_local_scope; then
558 die "${FUNCNAME}(): Invalid call stack" 900 die "${FUNCNAME}(): Invalid call stack"
559 fi 901 fi
560 done
561 902
562 if [[ "${quiet}" == "0" ]]; then 903 if [[ "${quiet}" == "0" ]]; then
563 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up" 904 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up"
564 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking" 905 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking"
565 [[ "${EBUILD_PHASE}" == "prepare" ]] && action="Preparation" 906 [[ "${EBUILD_PHASE}" == "prepare" ]] && action="Preparation"
571 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation" 912 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation"
572 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation" 913 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation"
573 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation" 914 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation"
574 fi 915 fi
575 916
576 local RED GREEN BLUE NORMAL 917 _python_calculate_PYTHON_ABIS
577 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then 918 if [[ "${final_ABI}" == "1" ]]; then
578 RED=$'\e[1;31m' 919 iterated_PYTHON_ABIS="$(PYTHON -f --ABI)"
579 GREEN=$'\e[1;32m'
580 BLUE=$'\e[1;34m'
581 NORMAL=$'\e[0m'
582 else 920 else
583 RED= 921 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
584 GREEN=
585 BLUE=
586 NORMAL=
587 fi 922 fi
588
589 validate_PYTHON_ABIS
590 for PYTHON_ABI in ${PYTHON_ABIS}; do 923 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
924 _python_prepare_flags
925
591 if [[ "${quiet}" == "0" ]]; then 926 if [[ "${quiet}" == "0" ]]; then
592 if [[ -n "${action_message_template}" ]]; then 927 if [[ -n "${action_message_template}" ]]; then
593 action_message="$(eval echo -n "${action_message_template}")" 928 eval "action_message=\"${action_message_template}\""
594 else 929 else
595 action_message="${action} of ${CATEGORY}/${PF} with $(python_get_implementation) $(python_get_version)..." 930 action_message="${action} of ${CATEGORY}/${PF} with $(python_get_implementation) $(python_get_version)..."
596 fi 931 fi
597 echo " ${GREEN}*${NORMAL} ${BLUE}${action_message}${NORMAL}" 932 echo " ${_GREEN}*${_NORMAL} ${_BLUE}${action_message}${_NORMAL}"
598 fi 933 fi
599 934
600 if [[ "${separate_build_dirs}" == "1" ]]; then 935 if [[ "${separate_build_dirs}" == "1" ]]; then
601 if [[ -n "${source_dir}" ]]; then 936 if [[ -n "${source_dir}" ]]; then
602 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}" 937 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}"
616 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@" 951 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@"
617 else 952 else
618 EPYTHON="$(PYTHON)" "${function}" "$@" 953 EPYTHON="$(PYTHON)" "${function}" "$@"
619 fi 954 fi
620 955
621 if [[ "$?" != "0" ]]; then 956 return_code="$?"
957
958 _python_restore_flags
959
960 if [[ "${return_code}" -ne 0 ]]; then
622 if [[ -n "${failure_message_template}" ]]; then 961 if [[ -n "${failure_message_template}" ]]; then
623 failure_message="$(eval echo -n "${failure_message_template}")" 962 eval "failure_message=\"${failure_message_template}\""
624 else 963 else
625 failure_message="${action} failed with $(python_get_implementation) $(python_get_version) in ${function}() function" 964 failure_message="${action} failed with $(python_get_implementation) $(python_get_version) in ${function}() function"
626 fi 965 fi
627 966
628 if [[ "${nonfatal}" == "1" ]]; then 967 if [[ "${nonfatal}" == "1" ]]; then
629 if [[ "${quiet}" == "0" ]]; then 968 if [[ "${quiet}" == "0" ]]; then
630 ewarn "${RED}${failure_message}${NORMAL}" 969 ewarn "${failure_message}"
631 fi 970 fi
632 elif has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then 971 elif [[ "${final_ABI}" == "0" ]] && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
633 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then 972 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then
634 local enabled_PYTHON_ABIS= other_PYTHON_ABI 973 local enabled_PYTHON_ABIS= other_PYTHON_ABI
635 for other_PYTHON_ABI in ${PYTHON_ABIS}; do 974 for other_PYTHON_ABI in ${PYTHON_ABIS}; do
636 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}" 975 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}"
637 done 976 done
638 export PYTHON_ABIS="${enabled_PYTHON_ABIS}" 977 export PYTHON_ABIS="${enabled_PYTHON_ABIS}"
639 fi 978 fi
640 if [[ "${quiet}" == "0" ]]; then 979 if [[ "${quiet}" == "0" ]]; then
641 ewarn "${RED}${failure_message}${NORMAL}" 980 ewarn "${failure_message}"
642 fi 981 fi
643 if [[ -z "${PYTHON_ABIS}" ]]; then 982 if [[ -z "${PYTHON_ABIS}" ]]; then
644 die "${function}() function failed with all enabled versions of Python" 983 die "${function}() function failed with all enabled Python ABIs"
645 fi 984 fi
646 else 985 else
647 die "${failure_message}" 986 die "${failure_message}"
648 fi 987 fi
649 fi 988 fi
679 unset -f python_default_function 1018 unset -f python_default_function
680 fi 1019 fi
681} 1020}
682 1021
683# @FUNCTION: python_copy_sources 1022# @FUNCTION: python_copy_sources
684# @USAGE: [--no-link] [--] [directory] 1023# @USAGE: <directory="${S}"> [directory]
685# @DESCRIPTION: 1024# @DESCRIPTION:
686# Copy unpacked sources of current package to separate build directory for each Python ABI. 1025# Copy unpacked sources of current package to separate build directory for each Python ABI.
687python_copy_sources() { 1026python_copy_sources() {
1027 _python_check_python_pkg_setup_execution
1028
1029 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1030 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1031 fi
1032
688 local dir dirs=() no_link="0" PYTHON_ABI 1033 local dir dirs=() PYTHON_ABI
689
690 while (($#)); do
691 case "$1" in
692 --no-link)
693 no_link="1"
694 ;;
695 --)
696 shift
697 break
698 ;;
699 -*)
700 die "${FUNCNAME}(): Unrecognized option '$1'"
701 ;;
702 *)
703 break
704 ;;
705 esac
706 shift
707 done
708 1034
709 if [[ "$#" -eq 0 ]]; then 1035 if [[ "$#" -eq 0 ]]; then
710 if [[ "${WORKDIR}" == "${S}" ]]; then 1036 if [[ "${WORKDIR}" == "${S}" ]]; then
711 die "${FUNCNAME}() cannot be used" 1037 die "${FUNCNAME}() cannot be used with current value of S variable"
712 fi 1038 fi
713 dirs="${S}" 1039 dirs=("${S%/}")
714 else 1040 else
715 dirs="$@" 1041 dirs=("$@")
716 fi 1042 fi
717 1043
718 validate_PYTHON_ABIS 1044 _python_calculate_PYTHON_ABIS
719 for PYTHON_ABI in ${PYTHON_ABIS}; do 1045 for PYTHON_ABI in ${PYTHON_ABIS}; do
720 for dir in "${dirs[@]}"; do 1046 for dir in "${dirs[@]}"; do
721 if [[ "${no_link}" == "1" ]]; then
722 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed" 1047 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
723 else
724 cp -lpr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
725 fi
726 done 1048 done
727 done 1049 done
728}
729
730# @FUNCTION: python_set_build_dir_symlink
731# @USAGE: [directory="build"]
732# @DESCRIPTION:
733# Create build directory symlink.
734python_set_build_dir_symlink() {
735 local dir="$1"
736
737 [[ -z "${PYTHON_ABI}" ]] && die "PYTHON_ABI variable not set"
738 [[ -z "${dir}" ]] && dir="build"
739
740 # Do not delete preexistent directories.
741 rm -f "${dir}" || die "Deletion of '${dir}' failed"
742 ln -s "${dir}-${PYTHON_ABI}" "${dir}" || die "Creation of '${dir}' directory symlink failed"
743} 1050}
744 1051
745# @FUNCTION: python_generate_wrapper_scripts 1052# @FUNCTION: python_generate_wrapper_scripts
746# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files] 1053# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files]
747# @DESCRIPTION: 1054# @DESCRIPTION:
748# Generate wrapper scripts. Existing files are overwritten only with --force option. 1055# Generate wrapper scripts. Existing files are overwritten only with --force option.
749# If --respect-EPYTHON option is specified, then generated wrapper scripts will 1056# If --respect-EPYTHON option is specified, then generated wrapper scripts will
750# respect EPYTHON variable at run time. 1057# respect EPYTHON variable at run time.
751python_generate_wrapper_scripts() { 1058python_generate_wrapper_scripts() {
1059 _python_check_python_pkg_setup_execution
1060
1061 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1062 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1063 fi
1064
752 _python_initialize_prefix_variables 1065 _python_initialize_prefix_variables
753 1066
754 local eselect_python_option file force="0" quiet="0" PYTHON_ABI python2_enabled="0" python3_enabled="0" respect_EPYTHON="0" 1067 local eselect_python_option file force="0" quiet="0" PYTHON_ABI python2_enabled="0" python3_enabled="0" respect_EPYTHON="0"
755 1068
756 while (($#)); do 1069 while (($#)); do
780 1093
781 if [[ "$#" -eq 0 ]]; then 1094 if [[ "$#" -eq 0 ]]; then
782 die "${FUNCNAME}(): Missing arguments" 1095 die "${FUNCNAME}(): Missing arguments"
783 fi 1096 fi
784 1097
785 validate_PYTHON_ABIS 1098 _python_calculate_PYTHON_ABIS
786 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do 1099 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do
787 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then 1100 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
788 python2_enabled="1" 1101 python2_enabled="1"
789 fi 1102 fi
790 done 1103 done
808 if [[ -f "${file}" && "${force}" == "0" ]]; then 1121 if [[ -f "${file}" && "${force}" == "0" ]]; then
809 die "${FUNCNAME}(): '$1' already exists" 1122 die "${FUNCNAME}(): '$1' already exists"
810 fi 1123 fi
811 1124
812 if [[ "${quiet}" == "0" ]]; then 1125 if [[ "${quiet}" == "0" ]]; then
813 einfo "Generating '${file#${D%/}}' wrapper script" 1126 einfo "Generating '${file#${ED%/}}' wrapper script"
814 fi 1127 fi
815 1128
816 cat << EOF > "${file}" 1129 cat << EOF > "${file}"
817#!/usr/bin/env python 1130#!/usr/bin/env python
818# Gentoo '${file##*/}' wrapper script 1131# Gentoo '${file##*/}' wrapper script generated by python_generate_wrapper_scripts()
819 1132
820import os 1133import os
821import re 1134import re
822import subprocess 1135import subprocess
823import sys 1136import sys
824 1137
825EPYTHON_re = re.compile(r"^python(\d+\.\d+)$") 1138EPYTHON_re = re.compile(r"^python(\d+\.\d+)$")
1139python_shebang_re = re.compile(r"^#! *(${EPREFIX}/usr/bin/python|(${EPREFIX})?/usr/bin/env +(${EPREFIX}/usr/bin/)?python)")
1140python_verification_output_re = re.compile("^GENTOO_PYTHON_TARGET_SCRIPT_PATH supported\n$")
826 1141
827EOF 1142EOF
828 if [[ "$?" != "0" ]]; then 1143 if [[ "$?" != "0" ]]; then
829 die "${FUNCNAME}(): Generation of '$1' failed" 1144 die "${FUNCNAME}(): Generation of '$1' failed"
830 fi 1145 fi
845 raise ValueError 1160 raise ValueError
846 except (OSError, ValueError): 1161 except (OSError, ValueError):
847 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n") 1162 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
848 sys.exit(1) 1163 sys.exit(1)
849 1164
850 eselect_output = eselect_process.stdout.read() 1165 EPYTHON = eselect_process.stdout.read()
851 if not isinstance(eselect_output, str): 1166 if not isinstance(EPYTHON, str):
852 # Python 3 1167 # Python 3
853 eselect_output = eselect_output.decode() 1168 EPYTHON = EPYTHON.decode()
1169 EPYTHON = EPYTHON.rstrip("\n")
854 1170
855 EPYTHON_matched = EPYTHON_re.match(eselect_output) 1171 EPYTHON_matched = EPYTHON_re.match(EPYTHON)
856 if EPYTHON_matched: 1172 if EPYTHON_matched:
857 PYTHON_ABI = EPYTHON_matched.group(1) 1173 PYTHON_ABI = EPYTHON_matched.group(1)
858 else: 1174 else:
859 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s" % eselect_output) 1175 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
860 sys.exit(1) 1176 sys.exit(1)
861EOF 1177EOF
862 if [[ "$?" != "0" ]]; then 1178 if [[ "$?" != "0" ]]; then
863 die "${FUNCNAME}(): Generation of '$1' failed" 1179 die "${FUNCNAME}(): Generation of '$1' failed"
864 fi 1180 fi
870 raise ValueError 1186 raise ValueError
871except (OSError, ValueError): 1187except (OSError, ValueError):
872 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n") 1188 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
873 sys.exit(1) 1189 sys.exit(1)
874 1190
875eselect_output = eselect_process.stdout.read() 1191EPYTHON = eselect_process.stdout.read()
876if not isinstance(eselect_output, str): 1192if not isinstance(EPYTHON, str):
877 # Python 3 1193 # Python 3
878 eselect_output = eselect_output.decode() 1194 EPYTHON = EPYTHON.decode()
1195EPYTHON = EPYTHON.rstrip("\n")
879 1196
880EPYTHON_matched = EPYTHON_re.match(eselect_output) 1197EPYTHON_matched = EPYTHON_re.match(EPYTHON)
881if EPYTHON_matched: 1198if EPYTHON_matched:
882 PYTHON_ABI = EPYTHON_matched.group(1) 1199 PYTHON_ABI = EPYTHON_matched.group(1)
883else: 1200else:
884 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s" % eselect_output) 1201 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
885 sys.exit(1) 1202 sys.exit(1)
886EOF 1203EOF
887 if [[ "$?" != "0" ]]; then 1204 if [[ "$?" != "0" ]]; then
888 die "${FUNCNAME}(): Generation of '$1' failed" 1205 die "${FUNCNAME}(): Generation of '$1' failed"
889 fi 1206 fi
890 fi 1207 fi
891 cat << EOF >> "${file}" 1208 cat << EOF >> "${file}"
892 1209
1210wrapper_script_path = os.path.realpath(sys.argv[0])
1211target_executable_path = "%s-%s" % (wrapper_script_path, PYTHON_ABI)
1212os.environ["GENTOO_PYTHON_PROCESS_NAME"] = os.path.basename(sys.argv[0])
893os.environ["PYTHON_SCRIPT_NAME"] = sys.argv[0] 1213os.environ["GENTOO_PYTHON_WRAPPER_SCRIPT_PATH"] = sys.argv[0]
894target_executable = "%s-%s" % (os.path.realpath(sys.argv[0]), PYTHON_ABI) 1214os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH"] = target_executable_path
895if not os.path.exists(target_executable): 1215if not os.path.exists(target_executable_path):
896 sys.stderr.write("'%s' does not exist\n" % target_executable) 1216 sys.stderr.write("'%s' does not exist\n" % target_executable_path)
897 sys.exit(1) 1217 sys.exit(1)
898 1218
1219target_executable = open(target_executable_path, "rb")
1220target_executable_first_line = target_executable.readline()
1221if not isinstance(target_executable_first_line, str):
1222 # Python 3
1223 target_executable_first_line = target_executable_first_line.decode("utf_8", "replace")
1224
1225python_shebang_matched = python_shebang_re.match(target_executable_first_line)
1226target_executable.close()
1227
1228if python_shebang_matched:
1229 try:
1230 python_interpreter_path = "${EPREFIX}/usr/bin/%s" % EPYTHON
1231 os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"] = "1"
1232 python_verification_process = subprocess.Popen([python_interpreter_path, "-c", "pass"], stdout=subprocess.PIPE)
1233 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
1234 if python_verification_process.wait() != 0:
1235 raise ValueError
1236
1237 python_verification_output = python_verification_process.stdout.read()
1238 if not isinstance(python_verification_output, str):
1239 # Python 3
1240 python_verification_output = python_verification_output.decode()
1241
1242 if not python_verification_output_re.match(python_verification_output):
1243 raise ValueError
1244
1245 os.execv(python_interpreter_path, [python_interpreter_path] + sys.argv)
1246 except:
1247 pass
1248 if "GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION" in os.environ:
1249 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
1250
899os.execv(target_executable, sys.argv) 1251os.execv(target_executable_path, sys.argv)
900EOF 1252EOF
901 if [[ "$?" != "0" ]]; then 1253 if [[ "$?" != "0" ]]; then
902 die "${FUNCNAME}(): Generation of '$1' failed" 1254 die "${FUNCNAME}(): Generation of '$1' failed"
903 fi 1255 fi
904 fperms +x "${file#${ED%/}}" || die "fperms '${file}' failed" 1256 fperms +x "${file#${ED%/}}" || die "fperms '${file}' failed"
905 done 1257 done
906} 1258}
907 1259
908# ================================================================================================ 1260# ================================================================================================
909# ====== FUNCTIONS FOR PACKAGES NOT SUPPORTING INSTALLATION FOR MULTIPLE VERSIONS OF PYTHON ====== 1261# ========= FUNCTIONS FOR PACKAGES NOT SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ==========
910# ================================================================================================ 1262# ================================================================================================
1263
1264unset EPYTHON PYTHON_ABI
911 1265
912# @FUNCTION: python_set_active_version 1266# @FUNCTION: python_set_active_version
913# @USAGE: <CPython_ABI|2|3> 1267# @USAGE: <CPython_ABI|2|3>
914# @DESCRIPTION: 1268# @DESCRIPTION:
915# Set specified version of CPython as active version of Python. 1269# Set specified version of CPython as active version of Python.
1270#
1271# This function can be used only in pkg_setup() phase.
916python_set_active_version() { 1272python_set_active_version() {
917 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 1273 # Check if phase is pkg_setup().
1274 [[ "${EBUILD_PHASE}" != "setup" ]] && die "${FUNCNAME}() can be used only in pkg_setup() phase"
1275
1276 if _python_package_supporting_installation_for_multiple_python_abis; then
918 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple versions of Python" 1277 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
919 fi 1278 fi
920 1279
921 if [[ "$#" -ne 1 ]]; then 1280 if [[ "$#" -ne 1 ]]; then
922 die "${FUNCNAME}() requires 1 argument" 1281 die "${FUNCNAME}() requires 1 argument"
923 fi 1282 fi
924 1283
1284 _python_initial_sanity_checks
1285
1286 if [[ -z "${PYTHON_ABI}" ]]; then
925 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then 1287 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
926 if ! _python_implementation && ! has_version "dev-lang/python:$1"; then 1288 if ! _python_implementation && ! has_version "dev-lang/python:$1"; then
927 die "${FUNCNAME}(): 'dev-lang/python:$1' is not installed" 1289 die "${FUNCNAME}(): 'dev-lang/python:$1' is not installed"
928 fi 1290 fi
929 export EPYTHON="$(PYTHON "$1")" 1291 export EPYTHON="$(PYTHON "$1")"
930 elif [[ "$1" == "2" ]]; then 1292 elif [[ "$1" == "2" ]]; then
931 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then 1293 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then
932 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed" 1294 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed"
933 fi 1295 fi
934 export EPYTHON="$(PYTHON -2)" 1296 export EPYTHON="$(PYTHON -2)"
935 elif [[ "$1" == "3" ]]; then 1297 elif [[ "$1" == "3" ]]; then
936 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then 1298 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then
937 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed" 1299 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed"
938 fi 1300 fi
939 export EPYTHON="$(PYTHON -3)" 1301 export EPYTHON="$(PYTHON -3)"
940 else 1302 else
941 die "${FUNCNAME}(): Unrecognized argument '$1'" 1303 die "${FUNCNAME}(): Unrecognized argument '$1'"
942 fi 1304 fi
943 1305
944 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses, 1306 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses,
945 # so it does not need to be exported to subprocesses. 1307 # so it does not need to be exported to subprocesses.
946 PYTHON_ABI="${EPYTHON#python}" 1308 PYTHON_ABI="${EPYTHON#python}"
947 PYTHON_ABI="${PYTHON_ABI%%-*}" 1309 PYTHON_ABI="${PYTHON_ABI%%-*}"
1310 fi
1311
1312 _python_final_sanity_checks
948 1313
949 # python-updater checks PYTHON_REQUESTED_ACTIVE_VERSION variable. 1314 # python-updater checks PYTHON_REQUESTED_ACTIVE_VERSION variable.
950 PYTHON_REQUESTED_ACTIVE_VERSION="$1" 1315 PYTHON_REQUESTED_ACTIVE_VERSION="$1"
951} 1316}
952 1317
953# @FUNCTION: python_need_rebuild 1318# @FUNCTION: python_need_rebuild
954# @DESCRIPTION: Mark current package for rebuilding by python-updater after 1319# @DESCRIPTION: Mark current package for rebuilding by python-updater after
955# switching of active version of Python. 1320# switching of active version of Python.
956python_need_rebuild() { 1321python_need_rebuild() {
1322 _python_check_python_pkg_setup_execution
1323
1324 if _python_package_supporting_installation_for_multiple_python_abis; then
1325 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
1326 fi
1327
1328 if [[ "$#" -ne 0 ]]; then
1329 die "${FUNCNAME}() does not accept arguments"
1330 fi
1331
957 export PYTHON_NEED_REBUILD="$(PYTHON -A --ABI)" 1332 export PYTHON_NEED_REBUILD="$(PYTHON --ABI)"
958} 1333}
959 1334
960# ================================================================================================ 1335# ================================================================================================
961# ======================================= GETTER FUNCTIONS ======================================= 1336# ======================================= GETTER FUNCTIONS =======================================
962# ================================================================================================ 1337# ================================================================================================
980 die "${FUNCNAME}(): Unrecognized Python ABI '$1'" 1355 die "${FUNCNAME}(): Unrecognized Python ABI '$1'"
981 fi 1356 fi
982} 1357}
983 1358
984# @FUNCTION: PYTHON 1359# @FUNCTION: PYTHON
985# @USAGE: [-2] [-3] [--ABI] [-A|--active] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}"> 1360# @USAGE: [-2] [-3] [--ABI] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}">
986# @DESCRIPTION: 1361# @DESCRIPTION:
987# Print filename of Python interpreter for specified Python ABI. If Python_ABI argument 1362# Print filename of Python interpreter for specified Python ABI. If Python_ABI argument
988# is ommitted, then PYTHON_ABI environment variable must be set and is used. 1363# is ommitted, then PYTHON_ABI environment variable must be set and is used.
989# If -2 option is specified, then active version of Python 2 is used. 1364# If -2 option is specified, then active version of Python 2 is used.
990# If -3 option is specified, then active version of Python 3 is used. 1365# If -3 option is specified, then active version of Python 3 is used.
991# If --active option is specified, then active version of Python is used.
992# Active version of Python can be set by python_set_active_version().
993# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used. 1366# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
994# -2, -3, --active and --final-ABI options and Python_ABI argument cannot be specified simultaneously. 1367# -2, -3 and --final-ABI options and Python_ABI argument cannot be specified simultaneously.
995# If --ABI option is specified, then only specified Python ABI is printed instead of 1368# If --ABI option is specified, then only specified Python ABI is printed instead of
996# filename of Python interpreter. 1369# filename of Python interpreter.
997# If --absolute-path option is specified, then absolute path to Python interpreter is printed. 1370# If --absolute-path option is specified, then absolute path to Python interpreter is printed.
998# --ABI and --absolute-path options cannot be specified simultaneously. 1371# --ABI and --absolute-path options cannot be specified simultaneously.
999PYTHON() { 1372PYTHON() {
1373 _python_check_python_pkg_setup_execution
1374
1000 local ABI_output="0" absolute_path_output="0" active="0" final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" python_interpreter python2="0" python3="0" 1375 local ABI_output="0" absolute_path_output="0" final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" python_interpreter python2="0" python3="0"
1001 1376
1002 while (($#)); do 1377 while (($#)); do
1003 case "$1" in 1378 case "$1" in
1004 -2) 1379 -2)
1005 python2="1" 1380 python2="1"
1008 python3="1" 1383 python3="1"
1009 ;; 1384 ;;
1010 --ABI) 1385 --ABI)
1011 ABI_output="1" 1386 ABI_output="1"
1012 ;; 1387 ;;
1013 -A|--active)
1014 active="1"
1015 ;;
1016 -a|--absolute-path) 1388 -a|--absolute-path)
1017 absolute_path_output="1" 1389 absolute_path_output="1"
1018 ;; 1390 ;;
1019 -f|--final-ABI) 1391 -f|--final-ABI)
1020 final_ABI="1" 1392 final_ABI="1"
1032 esac 1404 esac
1033 shift 1405 shift
1034 done 1406 done
1035 1407
1036 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then 1408 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then
1037 die "${FUNCNAME}(): '--ABI and '--absolute-path' options cannot be specified simultaneously" 1409 die "${FUNCNAME}(): '--ABI' and '--absolute-path' options cannot be specified simultaneously"
1038 fi 1410 fi
1039 1411
1040 if [[ "$((${python2} + ${python3} + ${active} + ${final_ABI}))" -gt 1 ]]; then 1412 if [[ "$((${python2} + ${python3} + ${final_ABI}))" -gt 1 ]]; then
1041 die "${FUNCNAME}(): '-2', '-3', '--active' or '--final-ABI' options cannot be specified simultaneously" 1413 die "${FUNCNAME}(): '-2', '-3' or '--final-ABI' options cannot be specified simultaneously"
1042 fi 1414 fi
1043 1415
1044 if [[ "$#" -eq 0 ]]; then 1416 if [[ "$#" -eq 0 ]]; then
1045 if [[ "${active}" == "1" ]]; then
1046 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
1047 die "${FUNCNAME}(): '--active' option cannot be used in ebuilds of packages supporting installation for multiple versions of Python"
1048 fi
1049 PYTHON_ABI="$("${EPREFIX}/usr/bin/python" -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")"
1050 elif [[ "${final_ABI}" == "1" ]]; then 1417 if [[ "${final_ABI}" == "1" ]]; then
1051 if has "${EAPI:-0}" 0 1 2 3 4 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then 1418 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1052 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple versions of Python" 1419 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1053 fi 1420 fi
1054 validate_PYTHON_ABIS 1421 _python_calculate_PYTHON_ABIS
1055 PYTHON_ABI="${PYTHON_ABIS##* }" 1422 PYTHON_ABI="${PYTHON_ABIS##* }"
1056 elif [[ "${python2}" == "1" ]]; then 1423 elif [[ "${python2}" == "1" ]]; then
1057 PYTHON_ABI="$(eselect python show --python2 --ABI)" 1424 PYTHON_ABI="$(eselect python show --python2 --ABI)"
1058 if [[ -z "${PYTHON_ABI}" ]]; then 1425 if [[ -z "${PYTHON_ABI}" ]]; then
1059 die "${FUNCNAME}(): Active Python 2 interpreter not set" 1426 die "${FUNCNAME}(): Active version of Python 2 not set"
1060 elif [[ "${PYTHON_ABI}" != "2."* ]]; then 1427 elif [[ "${PYTHON_ABI}" != "2."* ]]; then
1061 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`" 1428 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`"
1062 fi 1429 fi
1063 elif [[ "${python3}" == "1" ]]; then 1430 elif [[ "${python3}" == "1" ]]; then
1064 PYTHON_ABI="$(eselect python show --python3 --ABI)" 1431 PYTHON_ABI="$(eselect python show --python3 --ABI)"
1065 if [[ -z "${PYTHON_ABI}" ]]; then 1432 if [[ -z "${PYTHON_ABI}" ]]; then
1066 die "${FUNCNAME}(): Active Python 3 interpreter not set" 1433 die "${FUNCNAME}(): Active version of Python 3 not set"
1067 elif [[ "${PYTHON_ABI}" != "3."* ]]; then 1434 elif [[ "${PYTHON_ABI}" != "3."* ]]; then
1068 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`" 1435 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`"
1069 fi 1436 fi
1437 elif _python_package_supporting_installation_for_multiple_python_abis; then
1438 if ! _python_abi-specific_local_scope; then
1439 die "${FUNCNAME}() should be used in ABI-specific local scope"
1440 fi
1441 else
1442 PYTHON_ABI="$("${EPREFIX}/usr/bin/python" -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")"
1070 elif [[ -z "${PYTHON_ABI}" ]]; then 1443 if [[ -z "${PYTHON_ABI}" ]]; then
1071 die "${FUNCNAME}(): Invalid usage: Python ABI not specified" 1444 die "${FUNCNAME}(): Failure of extraction of locally active version of Python"
1445 fi
1072 fi 1446 fi
1073 elif [[ "$#" -eq 1 ]]; then 1447 elif [[ "$#" -eq 1 ]]; then
1074 if [[ "${active}" == "1" ]]; then
1075 die "${FUNCNAME}(): '--active' option and Python ABI cannot be specified simultaneously"
1076 fi
1077 if [[ "${final_ABI}" == "1" ]]; then 1448 if [[ "${final_ABI}" == "1" ]]; then
1078 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously" 1449 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously"
1079 fi 1450 fi
1080 if [[ "${python2}" == "1" ]]; then 1451 if [[ "${python2}" == "1" ]]; then
1081 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously" 1452 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously"
1114# @USAGE: [-f|--final-ABI] 1485# @USAGE: [-f|--final-ABI]
1115# @DESCRIPTION: 1486# @DESCRIPTION:
1116# Print name of Python implementation. 1487# Print name of Python implementation.
1117# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used. 1488# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1118python_get_implementation() { 1489python_get_implementation() {
1490 _python_check_python_pkg_setup_execution
1491
1119 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" 1492 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1120 1493
1121 while (($#)); do 1494 while (($#)); do
1122 case "$1" in 1495 case "$1" in
1123 -f|--final-ABI) 1496 -f|--final-ABI)
1132 esac 1505 esac
1133 shift 1506 shift
1134 done 1507 done
1135 1508
1136 if [[ "${final_ABI}" == "1" ]]; then 1509 if [[ "${final_ABI}" == "1" ]]; then
1510 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1511 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1512 fi
1137 PYTHON_ABI="$(PYTHON -f --ABI)" 1513 PYTHON_ABI="$(PYTHON -f --ABI)"
1138 elif [[ -z "${PYTHON_ABI}" ]]; then 1514 else
1515 if _python_package_supporting_installation_for_multiple_python_abis; then
1516 if ! _python_abi-specific_local_scope; then
1517 die "${FUNCNAME}() should be used in ABI-specific local scope"
1518 fi
1519 else
1139 PYTHON_ABI="$(PYTHON -A --ABI)" 1520 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1521 fi
1140 fi 1522 fi
1141 1523
1142 echo "$(_python_get_implementation "${PYTHON_ABI}")" 1524 echo "$(_python_get_implementation "${PYTHON_ABI}")"
1143} 1525}
1144 1526
1146# @USAGE: [-f|--final-ABI] 1528# @USAGE: [-f|--final-ABI]
1147# @DESCRIPTION: 1529# @DESCRIPTION:
1148# Print category, name and slot of package providing Python implementation. 1530# Print category, name and slot of package providing Python implementation.
1149# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used. 1531# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1150python_get_implementational_package() { 1532python_get_implementational_package() {
1533 _python_check_python_pkg_setup_execution
1534
1151 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" 1535 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1152 1536
1153 while (($#)); do 1537 while (($#)); do
1154 case "$1" in 1538 case "$1" in
1155 -f|--final-ABI) 1539 -f|--final-ABI)
1164 esac 1548 esac
1165 shift 1549 shift
1166 done 1550 done
1167 1551
1168 if [[ "${final_ABI}" == "1" ]]; then 1552 if [[ "${final_ABI}" == "1" ]]; then
1553 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1554 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1555 fi
1169 PYTHON_ABI="$(PYTHON -f --ABI)" 1556 PYTHON_ABI="$(PYTHON -f --ABI)"
1170 elif [[ -z "${PYTHON_ABI}" ]]; then 1557 else
1558 if _python_package_supporting_installation_for_multiple_python_abis; then
1559 if ! _python_abi-specific_local_scope; then
1560 die "${FUNCNAME}() should be used in ABI-specific local scope"
1561 fi
1562 else
1171 PYTHON_ABI="$(PYTHON -A --ABI)" 1563 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1564 fi
1172 fi 1565 fi
1173 1566
1174 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then 1567 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1175 echo "dev-lang/python:${PYTHON_ABI}" 1568 echo "dev-lang/python:${PYTHON_ABI}"
1176 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then 1569 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1177 echo "dev-java/jython:${PYTHON_ABI%-jython}" 1570 echo "dev-java/jython:${PYTHON_ABI%-jython}"
1178 fi 1571 fi
1179} 1572}
1180 1573
1181# @FUNCTION: python_get_includedir 1574# @FUNCTION: python_get_includedir
1182# @USAGE: [-f|--final-ABI] 1575# @USAGE: [-b|--base-path] [-f|--final-ABI]
1183# @DESCRIPTION: 1576# @DESCRIPTION:
1184# Print path to Python include directory. 1577# Print path to Python include directory.
1578# If --base-path option is specified, then path not prefixed with "/" is printed.
1185# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used. 1579# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1186python_get_includedir() { 1580python_get_includedir() {
1581 _python_check_python_pkg_setup_execution
1582
1187 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" 1583 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1584
1585 while (($#)); do
1586 case "$1" in
1587 -b|--base-path)
1588 base_path="1"
1589 ;;
1590 -f|--final-ABI)
1591 final_ABI="1"
1592 ;;
1593 -*)
1594 die "${FUNCNAME}(): Unrecognized option '$1'"
1595 ;;
1596 *)
1597 die "${FUNCNAME}(): Invalid usage"
1598 ;;
1599 esac
1600 shift
1601 done
1602
1603 if [[ "${base_path}" == "0" ]]; then
1604 prefix="/"
1605 fi
1606
1607 if [[ "${final_ABI}" == "1" ]]; then
1608 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1609 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1610 fi
1611 PYTHON_ABI="$(PYTHON -f --ABI)"
1612 else
1613 if _python_package_supporting_installation_for_multiple_python_abis; then
1614 if ! _python_abi-specific_local_scope; then
1615 die "${FUNCNAME}() should be used in ABI-specific local scope"
1616 fi
1617 else
1618 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1619 fi
1620 fi
1621
1622 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1623 echo "${prefix}usr/include/python${PYTHON_ABI}"
1624 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1625 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Include"
1626 fi
1627}
1628
1629# @FUNCTION: python_get_libdir
1630# @USAGE: [-b|--base-path] [-f|--final-ABI]
1631# @DESCRIPTION:
1632# Print path to Python library directory.
1633# If --base-path option is specified, then path not prefixed with "/" is printed.
1634# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1635python_get_libdir() {
1636 _python_check_python_pkg_setup_execution
1637
1638 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1639
1640 while (($#)); do
1641 case "$1" in
1642 -b|--base-path)
1643 base_path="1"
1644 ;;
1645 -f|--final-ABI)
1646 final_ABI="1"
1647 ;;
1648 -*)
1649 die "${FUNCNAME}(): Unrecognized option '$1'"
1650 ;;
1651 *)
1652 die "${FUNCNAME}(): Invalid usage"
1653 ;;
1654 esac
1655 shift
1656 done
1657
1658 if [[ "${base_path}" == "0" ]]; then
1659 prefix="/"
1660 fi
1661
1662 if [[ "${final_ABI}" == "1" ]]; then
1663 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1664 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1665 fi
1666 PYTHON_ABI="$(PYTHON -f --ABI)"
1667 else
1668 if _python_package_supporting_installation_for_multiple_python_abis; then
1669 if ! _python_abi-specific_local_scope; then
1670 die "${FUNCNAME}() should be used in ABI-specific local scope"
1671 fi
1672 else
1673 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1674 fi
1675 fi
1676
1677 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1678 echo "${prefix}usr/$(get_libdir)/python${PYTHON_ABI}"
1679 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1680 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Lib"
1681 fi
1682}
1683
1684# @FUNCTION: python_get_sitedir
1685# @USAGE: [-b|--base-path] [-f|--final-ABI]
1686# @DESCRIPTION:
1687# Print path to Python site-packages directory.
1688# If --base-path option is specified, then path not prefixed with "/" is printed.
1689# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1690python_get_sitedir() {
1691 _python_check_python_pkg_setup_execution
1692
1693 local final_ABI="0" options=()
1694
1695 while (($#)); do
1696 case "$1" in
1697 -b|--base-path)
1698 options+=("$1")
1699 ;;
1700 -f|--final-ABI)
1701 final_ABI="1"
1702 options+=("$1")
1703 ;;
1704 -*)
1705 die "${FUNCNAME}(): Unrecognized option '$1'"
1706 ;;
1707 *)
1708 die "${FUNCNAME}(): Invalid usage"
1709 ;;
1710 esac
1711 shift
1712 done
1713
1714 if [[ "${final_ABI}" == "1" ]]; then
1715 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1716 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1717 fi
1718 else
1719 if _python_package_supporting_installation_for_multiple_python_abis && ! _python_abi-specific_local_scope; then
1720 die "${FUNCNAME}() should be used in ABI-specific local scope"
1721 fi
1722 fi
1723
1724 echo "$(python_get_libdir "${options[@]}")/site-packages"
1725}
1726
1727# @FUNCTION: python_get_library
1728# @USAGE: [-b|--base-path] [-f|--final-ABI] [-l|--linker-option]
1729# @DESCRIPTION:
1730# Print path to Python library.
1731# If --base-path option is specified, then path not prefixed with "/" is printed.
1732# If --linker-option is specified, then "-l${library}" linker option is printed.
1733# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1734python_get_library() {
1735 _python_check_python_pkg_setup_execution
1736
1737 local base_path="0" final_ABI="0" linker_option="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1738
1739 while (($#)); do
1740 case "$1" in
1741 -b|--base-path)
1742 base_path="1"
1743 ;;
1744 -f|--final-ABI)
1745 final_ABI="1"
1746 ;;
1747 -l|--linker-option)
1748 linker_option="1"
1749 ;;
1750 -*)
1751 die "${FUNCNAME}(): Unrecognized option '$1'"
1752 ;;
1753 *)
1754 die "${FUNCNAME}(): Invalid usage"
1755 ;;
1756 esac
1757 shift
1758 done
1759
1760 if [[ "${base_path}" == "0" ]]; then
1761 prefix="/"
1762 fi
1763
1764 if [[ "${base_path}" == "1" && "${linker_option}" == "1" ]]; then
1765 die "${FUNCNAME}(): '--base-path' and '--linker-option' options cannot be specified simultaneously"
1766 fi
1767
1768 if [[ "${final_ABI}" == "1" ]]; then
1769 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1770 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1771 fi
1772 PYTHON_ABI="$(PYTHON -f --ABI)"
1773 else
1774 if _python_package_supporting_installation_for_multiple_python_abis; then
1775 if ! _python_abi-specific_local_scope; then
1776 die "${FUNCNAME}() should be used in ABI-specific local scope"
1777 fi
1778 else
1779 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1780 fi
1781 fi
1782
1783 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1784 if [[ "${linker_option}" == "1" ]]; then
1785 echo "-lpython${PYTHON_ABI}"
1786 else
1787 echo "${prefix}usr/$(get_libdir)/libpython${PYTHON_ABI}$(get_libname)"
1788 fi
1789 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1790 die "${FUNCNAME}(): Jython does not have shared library"
1791 fi
1792}
1793
1794# @FUNCTION: python_get_version
1795# @USAGE: [-f|--final-ABI] [--full] [--major] [--minor] [--micro]
1796# @DESCRIPTION:
1797# Print Python version.
1798# --full, --major, --minor and --micro options cannot be specified simultaneously.
1799# If --full, --major, --minor and --micro options are not specified, then "${major_version}.${minor_version}" is printed.
1800# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1801python_get_version() {
1802 _python_check_python_pkg_setup_execution
1803
1804 local final_ABI="0" full="0" major="0" minor="0" micro="0" python_command
1188 1805
1189 while (($#)); do 1806 while (($#)); do
1190 case "$1" in 1807 case "$1" in
1191 -f|--final-ABI) 1808 -f|--final-ABI)
1192 final_ABI="1" 1809 final_ABI="1"
1193 ;; 1810 ;;
1811 --full)
1812 full="1"
1813 ;;
1814 --major)
1815 major="1"
1816 ;;
1817 --minor)
1818 minor="1"
1819 ;;
1820 --micro)
1821 micro="1"
1822 ;;
1194 -*) 1823 -*)
1195 die "${FUNCNAME}(): Unrecognized option '$1'" 1824 die "${FUNCNAME}(): Unrecognized option '$1'"
1196 ;; 1825 ;;
1197 *) 1826 *)
1198 die "${FUNCNAME}(): Invalid usage" 1827 die "${FUNCNAME}(): Invalid usage"
1199 ;; 1828 ;;
1200 esac 1829 esac
1201 shift 1830 shift
1202 done 1831 done
1203 1832
1204 if [[ "${final_ABI}" == "1" ]]; then
1205 PYTHON_ABI="$(PYTHON -f --ABI)"
1206 elif [[ -z "${PYTHON_ABI}" ]]; then
1207 PYTHON_ABI="$(PYTHON -A --ABI)"
1208 fi
1209
1210 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1211 echo "/usr/include/python${PYTHON_ABI}"
1212 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1213 echo "/usr/share/jython-${PYTHON_ABI%-jython}/Include"
1214 fi
1215}
1216
1217# @FUNCTION: python_get_libdir
1218# @USAGE: [-f|--final-ABI]
1219# @DESCRIPTION:
1220# Print path to Python library directory.
1221# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1222python_get_libdir() {
1223 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1224
1225 while (($#)); do
1226 case "$1" in
1227 -f|--final-ABI)
1228 final_ABI="1"
1229 ;;
1230 -*)
1231 die "${FUNCNAME}(): Unrecognized option '$1'"
1232 ;;
1233 *)
1234 die "${FUNCNAME}(): Invalid usage"
1235 ;;
1236 esac
1237 shift
1238 done
1239
1240 if [[ "${final_ABI}" == "1" ]]; then
1241 PYTHON_ABI="$(PYTHON -f --ABI)"
1242 elif [[ -z "${PYTHON_ABI}" ]]; then
1243 PYTHON_ABI="$(PYTHON -A --ABI)"
1244 fi
1245
1246 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1247 echo "/usr/$(get_libdir)/python${PYTHON_ABI}"
1248 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1249 echo "/usr/share/jython-${PYTHON_ABI%-jython}/Lib"
1250 fi
1251}
1252
1253# @FUNCTION: python_get_sitedir
1254# @USAGE: [-f|--final-ABI]
1255# @DESCRIPTION:
1256# Print path to Python site-packages directory.
1257# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1258python_get_sitedir() {
1259 local options=()
1260
1261 while (($#)); do
1262 case "$1" in
1263 -f|--final-ABI)
1264 options+=("$1")
1265 ;;
1266 -*)
1267 die "${FUNCNAME}(): Unrecognized option '$1'"
1268 ;;
1269 *)
1270 die "${FUNCNAME}(): Invalid usage"
1271 ;;
1272 esac
1273 shift
1274 done
1275
1276 echo "$(python_get_libdir "${options[@]}")/site-packages"
1277}
1278
1279# @FUNCTION: python_get_library
1280# @USAGE: [-f|--final-ABI] [-l|--linker-option]
1281# @DESCRIPTION:
1282# Print path to Python library.
1283# If --linker-option is specified, then "-l${library}" linker option is printed.
1284# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1285python_get_library() {
1286 local final_ABI="0" linker_option="0" PYTHON_ABI="${PYTHON_ABI}"
1287
1288 while (($#)); do
1289 case "$1" in
1290 -f|--final-ABI)
1291 final_ABI="1"
1292 ;;
1293 -l|--linker-option)
1294 linker_option="1"
1295 ;;
1296 -*)
1297 die "${FUNCNAME}(): Unrecognized option '$1'"
1298 ;;
1299 *)
1300 die "${FUNCNAME}(): Invalid usage"
1301 ;;
1302 esac
1303 shift
1304 done
1305
1306 if [[ "${final_ABI}" == "1" ]]; then
1307 PYTHON_ABI="$(PYTHON -f --ABI)"
1308 elif [[ -z "${PYTHON_ABI}" ]]; then
1309 PYTHON_ABI="$(PYTHON -A --ABI)"
1310 fi
1311
1312 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1313 if [[ "${linker_option}" == "1" ]]; then
1314 echo "-lpython${PYTHON_ABI}"
1315 else
1316 echo "/usr/$(get_libdir)/libpython${PYTHON_ABI}$(get_libname)"
1317 fi
1318 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1319 die "${FUNCNAME}(): Jython does not have shared library"
1320 fi
1321}
1322
1323# @FUNCTION: python_get_version
1324# @USAGE: [-f|--final-ABI] [--major] [--minor] [--micro]
1325# @DESCRIPTION:
1326# Print Python version.
1327# --major, --minor and --micro options cannot be specified simultaneously.
1328# If --major, --minor and --micro options are not specified, then "${major_version}.${minor_version}" is printed.
1329# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1330python_get_version() {
1331 local final_ABI="0" major="0" minor="0" micro="0" python_command
1332
1333 while (($#)); do
1334 case "$1" in
1335 -f|--final-ABI)
1336 final_ABI="1"
1337 ;;
1338 --major)
1339 major="1"
1340 ;;
1341 --minor)
1342 minor="1"
1343 ;;
1344 --micro)
1345 micro="1"
1346 ;;
1347 -*)
1348 die "${FUNCNAME}(): Unrecognized option '$1'"
1349 ;;
1350 *)
1351 die "${FUNCNAME}(): Invalid usage"
1352 ;;
1353 esac
1354 shift
1355 done
1356
1357 if [[ "$((${major} + ${minor} + ${micro}))" -gt 1 ]]; then 1833 if [[ "$((${full} + ${major} + ${minor} + ${micro}))" -gt 1 ]]; then
1358 die "${FUNCNAME}(): '--major', '--minor' or '--micro' options cannot be specified simultaneously" 1834 die "${FUNCNAME}(): '--full', '--major', '--minor' or '--micro' options cannot be specified simultaneously"
1359 fi 1835 fi
1360 1836
1837 if [[ "${full}" == "1" ]]; then
1838 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:3]))"
1361 if [[ "${major}" == "1" ]]; then 1839 elif [[ "${major}" == "1" ]]; then
1362 python_command="from sys import version_info; print(version_info[0])" 1840 python_command="from sys import version_info; print(version_info[0])"
1363 elif [[ "${minor}" == "1" ]]; then 1841 elif [[ "${minor}" == "1" ]]; then
1364 python_command="from sys import version_info; print(version_info[1])" 1842 python_command="from sys import version_info; print(version_info[1])"
1365 elif [[ "${micro}" == "1" ]]; then 1843 elif [[ "${micro}" == "1" ]]; then
1366 python_command="from sys import version_info; print(version_info[2])" 1844 python_command="from sys import version_info; print(version_info[2])"
1367 else 1845 else
1846 if [[ -n "${PYTHON_ABI}" && "${final_ABI}" == "0" ]]; then
1847 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1848 echo "${PYTHON_ABI}"
1849 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1850 echo "${PYTHON_ABI%-jython}"
1851 fi
1852 return
1853 fi
1368 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:2]))" 1854 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:2]))"
1369 fi 1855 fi
1370 1856
1371 if [[ "${final_ABI}" == "1" ]]; then 1857 if [[ "${final_ABI}" == "1" ]]; then
1858 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1859 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1860 fi
1372 "$(PYTHON -f)" -c "${python_command}" 1861 "$(PYTHON -f)" -c "${python_command}"
1373 else 1862 else
1863 if _python_package_supporting_installation_for_multiple_python_abis && ! _python_abi-specific_local_scope; then
1864 die "${FUNCNAME}() should be used in ABI-specific local scope"
1865 fi
1374 "$(PYTHON "${PYTHON_ABI--A}")" -c "${python_command}" 1866 "$(PYTHON ${PYTHON_ABI})" -c "${python_command}"
1375 fi
1376}
1377
1378# ================================================================================================
1379# =================================== MISCELLANEOUS FUNCTIONS ====================================
1380# ================================================================================================
1381
1382_python_implementation() {
1383 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then
1384 return 0
1385 elif [[ "${CATEGORY}/${PN}" == "dev-java/jython" ]]; then
1386 return 0
1387 else
1388 return 1
1389 fi
1390}
1391
1392_python_initialize_prefix_variables() {
1393 if has "${EAPI:-0}" 0 1 2; then
1394 if [[ -n "${ROOT}" && -z "${EROOT}" ]]; then
1395 EROOT="${ROOT%/}${EPREFIX}/"
1396 fi
1397 if [[ -n "${D}" && -z "${ED}" ]]; then
1398 ED="${D%/}${EPREFIX}/"
1399 fi
1400 fi
1401}
1402
1403# @FUNCTION: python_convert_shebangs
1404# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_version> <file|directory> [files|directories]
1405# @DESCRIPTION:
1406# Convert shebangs in specified files. Directories can be specified only with --recursive option.
1407python_convert_shebangs() {
1408 local argument file files=() only_executables="0" python_version quiet="0" recursive="0"
1409
1410 while (($#)); do
1411 case "$1" in
1412 -r|--recursive)
1413 recursive="1"
1414 ;;
1415 -q|--quiet)
1416 quiet="1"
1417 ;;
1418 -x|--only-executables)
1419 only_executables="1"
1420 ;;
1421 --)
1422 shift
1423 break
1424 ;;
1425 -*)
1426 die "${FUNCNAME}(): Unrecognized option '$1'"
1427 ;;
1428 *)
1429 break
1430 ;;
1431 esac
1432 shift
1433 done
1434
1435 if [[ "$#" -eq 0 ]]; then
1436 die "${FUNCNAME}(): Missing Python version and files or directories"
1437 elif [[ "$#" -eq 1 ]]; then
1438 die "${FUNCNAME}(): Missing files or directories"
1439 fi
1440
1441 python_version="$1"
1442 shift
1443
1444 for argument in "$@"; do
1445 if [[ ! -e "${argument}" ]]; then
1446 die "${FUNCNAME}(): '${argument}' does not exist"
1447 elif [[ -f "${argument}" ]]; then
1448 files+=("${argument}")
1449 elif [[ -d "${argument}" ]]; then
1450 if [[ "${recursive}" == "1" ]]; then
1451 if [[ "${only_executables}" == "1" ]]; then
1452 files+=($(find "${argument}" -perm /111 -type f))
1453 else
1454 files+=($(find "${argument}" -type f))
1455 fi
1456 else
1457 die "${FUNCNAME}(): '${argument}' is not a regular file"
1458 fi
1459 else
1460 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory"
1461 fi
1462 done
1463
1464 for file in "${files[@]}"; do
1465 file="${file#./}"
1466 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
1467
1468 if [[ "$(head -n1 "${file}")" =~ ^'#!'.*python ]]; then
1469 if [[ "${quiet}" == "0" ]]; then
1470 einfo "Converting shebang in '${file}'"
1471 fi
1472 sed -e "1s/python\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?/python${python_version}/" -i "${file}" || die "Conversion of shebang in '${file}' failed"
1473
1474 # Delete potential whitespace after "#!".
1475 sed -e '1s/\(^#!\)[[:space:]]*/\1/' -i "${file}" || die "sed '${file}' failed"
1476 fi
1477 done
1478}
1479
1480# @FUNCTION: python_mod_exists
1481# @USAGE: <module>
1482# @DESCRIPTION:
1483# Run with the module name as an argument. It will check if a
1484# Python module is installed and loadable. It will return
1485# TRUE(0) if the module exists, and FALSE(1) if the module does
1486# not exist.
1487#
1488# Example:
1489# if python_mod_exists gtk; then
1490# echo "gtk support enabled"
1491# fi
1492python_mod_exists() {
1493 if [[ "$#" -ne 1 ]]; then
1494 die "${FUNCNAME}() requires 1 argument"
1495 fi
1496 "$(PYTHON "${PYTHON_ABI--A}")" -c "import $1" &> /dev/null
1497}
1498
1499# @FUNCTION: python_tkinter_exists
1500# @DESCRIPTION:
1501# Run without arguments, checks if Python was compiled with Tkinter
1502# support. If not, prints an error message and dies.
1503python_tkinter_exists() {
1504 if ! "$(PYTHON "${PYTHON_ABI--A}")" -c "from sys import version_info
1505if version_info[0] == 3:
1506 import tkinter
1507else:
1508 import Tkinter" &> /dev/null; then
1509 eerror "Python needs to be rebuilt with tkinter support enabled."
1510 eerror "Add the following line to '${EPREFIX}/etc/portage/package.use' and rebuild Python"
1511 eerror "dev-lang/python tk"
1512 die "Python installed without support for tkinter"
1513 fi 1867 fi
1514} 1868}
1515 1869
1516# ================================================================================================ 1870# ================================================================================================
1517# ================================ FUNCTIONS FOR RUNNING OF TESTS ================================ 1871# ================================ FUNCTIONS FOR RUNNING OF TESTS ================================
1521# @DESCRIPTION: 1875# @DESCRIPTION:
1522# User-configurable verbosity of tests of Python modules. 1876# User-configurable verbosity of tests of Python modules.
1523# Supported values: 0, 1, 2, 3, 4. 1877# Supported values: 0, 1, 2, 3, 4.
1524PYTHON_TEST_VERBOSITY="${PYTHON_TEST_VERBOSITY:-1}" 1878PYTHON_TEST_VERBOSITY="${PYTHON_TEST_VERBOSITY:-1}"
1525 1879
1880_python_test_hook() {
1881 if [[ "$#" -ne 1 ]]; then
1882 die "${FUNCNAME}() requires 1 argument"
1883 fi
1884
1885 if _python_package_supporting_installation_for_multiple_python_abis && [[ "$(type -t "${FUNCNAME[3]}_$1_hook")" == "function" ]]; then
1886 "${FUNCNAME[3]}_$1_hook"
1887 fi
1888}
1889
1526# @FUNCTION: python_execute_nosetests 1890# @FUNCTION: python_execute_nosetests
1527# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments] 1891# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1528# @DESCRIPTION: 1892# @DESCRIPTION:
1529# Execute nosetests for all enabled versions of Python. 1893# Execute nosetests for all enabled Python ABIs.
1894# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
1895# python_execute_nosetests_pre_hook() and python_execute_nosetests_post_hook(), if they are defined.
1530python_execute_nosetests() { 1896python_execute_nosetests() {
1897 _python_check_python_pkg_setup_execution
1898 _python_set_color_variables
1899
1531 local PYTHONPATH_template= separate_build_dirs= 1900 local PYTHONPATH_template= separate_build_dirs=
1532 1901
1533 while (($#)); do 1902 while (($#)); do
1534 case "$1" in 1903 case "$1" in
1535 -P|--PYTHONPATH) 1904 -P|--PYTHONPATH)
1552 esac 1921 esac
1553 shift 1922 shift
1554 done 1923 done
1555 1924
1556 python_test_function() { 1925 python_test_function() {
1557 local evaluated_PYTHONPATH= 1926 local evaluated_PYTHONPATH
1558 1927
1559 if [[ -n "${PYTHONPATH_template}" ]]; then
1560 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")" 1928 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
1561 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then 1929
1562 unset evaluated_PYTHONPATH 1930 _python_test_hook pre
1563 fi
1564 fi
1565 1931
1566 if [[ -n "${evaluated_PYTHONPATH}" ]]; then 1932 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1567 echo PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" 1933 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1568 PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" 1934 PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1569 else 1935 else
1570 echo nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" 1936 echo ${_BOLD}nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1571 nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" 1937 nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1572 fi 1938 fi
1939
1940 _python_test_hook post
1573 } 1941 }
1574 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 1942 if _python_package_supporting_installation_for_multiple_python_abis; then
1575 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@" 1943 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1576 else 1944 else
1577 if [[ -n "${separate_build_dirs}" ]]; then 1945 if [[ -n "${separate_build_dirs}" ]]; then
1578 die "${FUNCNAME}(): Invalid usage" 1946 die "${FUNCNAME}(): Invalid usage"
1579 fi 1947 fi
1584} 1952}
1585 1953
1586# @FUNCTION: python_execute_py.test 1954# @FUNCTION: python_execute_py.test
1587# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments] 1955# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1588# @DESCRIPTION: 1956# @DESCRIPTION:
1589# Execute py.test for all enabled versions of Python. 1957# Execute py.test for all enabled Python ABIs.
1958# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
1959# python_execute_py.test_pre_hook() and python_execute_py.test_post_hook(), if they are defined.
1590python_execute_py.test() { 1960python_execute_py.test() {
1961 _python_check_python_pkg_setup_execution
1962 _python_set_color_variables
1963
1591 local PYTHONPATH_template= separate_build_dirs= 1964 local PYTHONPATH_template= separate_build_dirs=
1592 1965
1593 while (($#)); do 1966 while (($#)); do
1594 case "$1" in 1967 case "$1" in
1595 -P|--PYTHONPATH) 1968 -P|--PYTHONPATH)
1612 esac 1985 esac
1613 shift 1986 shift
1614 done 1987 done
1615 1988
1616 python_test_function() { 1989 python_test_function() {
1617 local evaluated_PYTHONPATH= 1990 local evaluated_PYTHONPATH
1618 1991
1619 if [[ -n "${PYTHONPATH_template}" ]]; then
1620 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")" 1992 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
1621 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then 1993
1622 unset evaluated_PYTHONPATH 1994 _python_test_hook pre
1623 fi
1624 fi
1625 1995
1626 if [[ -n "${evaluated_PYTHONPATH}" ]]; then 1996 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1627 echo PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" 1997 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@"${_NORMAL}
1628 PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" 1998 PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" || return "$?"
1629 else 1999 else
1630 echo py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" 2000 echo ${_BOLD}py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@"${_NORMAL}
1631 py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" 2001 py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" || return "$?"
1632 fi 2002 fi
2003
2004 _python_test_hook post
1633 } 2005 }
1634 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2006 if _python_package_supporting_installation_for_multiple_python_abis; then
1635 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@" 2007 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1636 else 2008 else
1637 if [[ -n "${separate_build_dirs}" ]]; then 2009 if [[ -n "${separate_build_dirs}" ]]; then
1638 die "${FUNCNAME}(): Invalid usage" 2010 die "${FUNCNAME}(): Invalid usage"
1639 fi 2011 fi
1644} 2016}
1645 2017
1646# @FUNCTION: python_execute_trial 2018# @FUNCTION: python_execute_trial
1647# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments] 2019# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1648# @DESCRIPTION: 2020# @DESCRIPTION:
1649# Execute trial for all enabled versions of Python. 2021# Execute trial for all enabled Python ABIs.
2022# In ebuilds of packages supporting installation for multiple Python ABIs, this function
2023# calls python_execute_trial_pre_hook() and python_execute_trial_post_hook(), if they are defined.
1650python_execute_trial() { 2024python_execute_trial() {
2025 _python_check_python_pkg_setup_execution
2026 _python_set_color_variables
2027
1651 local PYTHONPATH_template= separate_build_dirs= 2028 local PYTHONPATH_template= separate_build_dirs=
1652 2029
1653 while (($#)); do 2030 while (($#)); do
1654 case "$1" in 2031 case "$1" in
1655 -P|--PYTHONPATH) 2032 -P|--PYTHONPATH)
1672 esac 2049 esac
1673 shift 2050 shift
1674 done 2051 done
1675 2052
1676 python_test_function() { 2053 python_test_function() {
1677 local evaluated_PYTHONPATH= 2054 local evaluated_PYTHONPATH
1678 2055
1679 if [[ -n "${PYTHONPATH_template}" ]]; then
1680 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")" 2056 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
1681 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then 2057
1682 unset evaluated_PYTHONPATH 2058 _python_test_hook pre
1683 fi
1684 fi
1685 2059
1686 if [[ -n "${evaluated_PYTHONPATH}" ]]; then 2060 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1687 echo PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" 2061 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
1688 PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" 2062 PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
1689 else 2063 else
1690 echo trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" 2064 echo ${_BOLD}trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
1691 trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" 2065 trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
1692 fi 2066 fi
2067
2068 _python_test_hook post
1693 } 2069 }
1694 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2070 if _python_package_supporting_installation_for_multiple_python_abis; then
1695 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@" 2071 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1696 else 2072 else
1697 if [[ -n "${separate_build_dirs}" ]]; then 2073 if [[ -n "${separate_build_dirs}" ]]; then
1698 die "${FUNCNAME}(): Invalid usage" 2074 die "${FUNCNAME}(): Invalid usage"
1699 fi 2075 fi
1710# @FUNCTION: python_enable_pyc 2086# @FUNCTION: python_enable_pyc
1711# @DESCRIPTION: 2087# @DESCRIPTION:
1712# Tell Python to automatically recompile modules to .pyc/.pyo if the 2088# Tell Python to automatically recompile modules to .pyc/.pyo if the
1713# timestamps/version stamps have changed. 2089# timestamps/version stamps have changed.
1714python_enable_pyc() { 2090python_enable_pyc() {
2091 _python_check_python_pkg_setup_execution
2092
2093 if [[ "$#" -ne 0 ]]; then
2094 die "${FUNCNAME}() does not accept arguments"
2095 fi
2096
1715 unset PYTHONDONTWRITEBYTECODE 2097 unset PYTHONDONTWRITEBYTECODE
1716} 2098}
1717 2099
1718# @FUNCTION: python_disable_pyc 2100# @FUNCTION: python_disable_pyc
1719# @DESCRIPTION: 2101# @DESCRIPTION:
1720# Tell Python not to automatically recompile modules to .pyc/.pyo 2102# Tell Python not to automatically recompile modules to .pyc/.pyo
1721# even if the timestamps/version stamps do not match. This is done 2103# even if the timestamps/version stamps do not match. This is done
1722# to protect sandbox. 2104# to protect sandbox.
1723python_disable_pyc() { 2105python_disable_pyc() {
2106 _python_check_python_pkg_setup_execution
2107
2108 if [[ "$#" -ne 0 ]]; then
2109 die "${FUNCNAME}() does not accept arguments"
2110 fi
2111
1724 export PYTHONDONTWRITEBYTECODE="1" 2112 export PYTHONDONTWRITEBYTECODE="1"
2113}
2114
2115_python_clean_compiled_modules() {
2116 _python_initialize_prefix_variables
2117 _python_set_color_variables
2118
2119 [[ "${FUNCNAME[1]}" =~ ^(python_mod_optimize|python_mod_compile|python_mod_cleanup)$ ]] || die "${FUNCNAME}(): Invalid usage"
2120
2121 local base_module_name compiled_file compiled_files=() dir path py_file root
2122
2123 # Strip trailing slash from EROOT.
2124 root="${EROOT%/}"
2125
2126 for path in "$@"; do
2127 compiled_files=()
2128 if [[ -d "${path}" ]]; then
2129 while read -d $'\0' -r compiled_file; do
2130 compiled_files+=("${compiled_file}")
2131 done < <(find "${path}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -print0)
2132
2133 if [[ "${EBUILD_PHASE}" == "postrm" ]]; then
2134 # Delete empty child directories.
2135 find "${path}" -type d | sort -r | while read -r dir; do
2136 if rmdir "${dir}" 2> /dev/null; then
2137 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2138 fi
2139 done
2140 fi
2141 elif [[ "${path}" == *.py ]]; then
2142 base_module_name="${path##*/}"
2143 base_module_name="${base_module_name%.py}"
2144 if [[ -d "${path%/*}/__pycache__" ]]; then
2145 while read -d $'\0' -r compiled_file; do
2146 compiled_files+=("${compiled_file}")
2147 done < <(find "${path%/*}/__pycache__" "(" -name "${base_module_name}.*.py[co]" -o -name "${base_module_name}\$py.class" ")" -print0)
2148 fi
2149 compiled_files+=("${path}c" "${path}o" "${path%.py}\$py.class")
2150 fi
2151
2152 for compiled_file in "${compiled_files[@]}"; do
2153 [[ ! -f "${compiled_file}" ]] && continue
2154 dir="${compiled_file%/*}"
2155 dir="${dir##*/}"
2156 if [[ "${compiled_file}" == *.py[co] ]]; then
2157 if [[ "${dir}" == "__pycache__" ]]; then
2158 base_module_name="${compiled_file##*/}"
2159 base_module_name="${base_module_name%.*py[co]}"
2160 base_module_name="${base_module_name%.*}"
2161 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2162 else
2163 py_file="${compiled_file%[co]}"
2164 fi
2165 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2166 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2167 else
2168 [[ -f "${py_file}" ]] && continue
2169 fi
2170 echo "${_BLUE}<<< ${compiled_file%[co]}[co]${_NORMAL}"
2171 rm -f "${compiled_file%[co]}"[co]
2172 elif [[ "${compiled_file}" == *\$py.class ]]; then
2173 if [[ "${dir}" == "__pycache__" ]]; then
2174 base_module_name="${compiled_file##*/}"
2175 base_module_name="${base_module_name%\$py.class}"
2176 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2177 else
2178 py_file="${compiled_file%\$py.class}"
2179 fi
2180 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2181 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2182 else
2183 [[ -f "${py_file}" ]] && continue
2184 fi
2185 echo "${_BLUE}<<< ${compiled_file}${_NORMAL}"
2186 rm -f "${compiled_file}"
2187 else
2188 die "${FUNCNAME}(): Unrecognized file type: '${compiled_file}'"
2189 fi
2190
2191 # Delete empty parent directories.
2192 dir="${compiled_file%/*}"
2193 while [[ "${dir}" != "${root}" ]]; do
2194 if rmdir "${dir}" 2> /dev/null; then
2195 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2196 else
2197 break
2198 fi
2199 dir="${dir%/*}"
2200 done
2201 done
2202 done
1725} 2203}
1726 2204
1727# @FUNCTION: python_mod_optimize 2205# @FUNCTION: python_mod_optimize
1728# @USAGE: [options] [directory|file] 2206# @USAGE: [options] [directory|file]
1729# @DESCRIPTION: 2207# @DESCRIPTION:
1730# If no arguments supplied, it will recompile not recursively all modules 2208# If no arguments supplied, it will recompile not recursively all modules
1731# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages). 2209# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages).
1732# 2210#
1733# If supplied with arguments, it will recompile all modules recursively 2211# If supplied with arguments, it will recompile all modules recursively
1734# in the supplied directory. 2212# in the supplied directory.
1735# This function should only be run in pkg_postinst().
1736# 2213#
1737# Options passed to this function are passed to compileall.py. 2214# Options passed to this function are passed to compileall.py.
1738# 2215#
1739# Example: 2216# This function can be used only in pkg_postinst() phase.
1740# python_mod_optimize ctypesgencore
1741python_mod_optimize() { 2217python_mod_optimize() {
2218 _python_check_python_pkg_setup_execution
1742 _python_initialize_prefix_variables 2219 _python_initialize_prefix_variables
1743 2220
1744 # Check if phase is pkg_postinst(). 2221 # Check if phase is pkg_postinst().
1745 [[ ${EBUILD_PHASE} != "postinst" ]] && die "${FUNCNAME}() should only be run in pkg_postinst()" 2222 [[ "${EBUILD_PHASE}" != "postinst" ]] && die "${FUNCNAME}() can be used only in pkg_postinst() phase"
1746 2223
2224 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2225 # PYTHON_ABI variable cannot be local in packages not supporting installation for multiple Python ABIs.
2226 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=()
2227
2228 if _python_package_supporting_installation_for_multiple_python_abis; then
1747 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2229 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
1748 local dir file options=() other_dirs=() other_files=() previous_PYTHON_ABI="${PYTHON_ABI}" PYTHON_ABI return_code root site_packages_absolute_dirs=() site_packages_dirs=() site_packages_absolute_files=() site_packages_files=() 2230 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
2231 fi
2232 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
2233 else
2234 if has "${EAPI:-0}" 0 1 2 3; then
2235 iterated_PYTHON_ABIS="${PYTHON_ABI:=$(PYTHON --ABI)}"
2236 else
2237 iterated_PYTHON_ABIS="${PYTHON_ABI}"
2238 fi
2239 fi
1749 2240
1750 # Strip trailing slash from ROOT. 2241 # Strip trailing slash from EROOT.
1751 root="${EROOT%/}" 2242 root="${EROOT%/}"
1752 2243
1753 # Respect ROOT and options passed to compileall.py.
1754 while (($#)); do 2244 while (($#)); do
1755 case "$1" in 2245 case "$1" in
2246 --allow-evaluated-non-sitedir-paths)
2247 allow_evaluated_non_sitedir_paths="1"
2248 ;;
1756 -l|-f|-q) 2249 -l|-f|-q)
1757 options+=("$1") 2250 options+=("$1")
1758 ;; 2251 ;;
1759 -d|-x) 2252 -d|-x)
1760 options+=("$1" "$2") 2253 options+=("$1" "$2")
1761 shift 2254 shift
1762 ;; 2255 ;;
2256 --)
2257 shift
2258 break
2259 ;;
1763 -*) 2260 -*)
1764 ewarn "${FUNCNAME}(): Ignoring option '$1'" 2261 die "${FUNCNAME}(): Unrecognized option '$1'"
1765 ;; 2262 ;;
1766 *) 2263 *)
1767 if ! _python_implementation && [[ "$1" =~ ^"${EPREFIX}"/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
1768 die "${FUNCNAME}() does not support absolute paths of directories/files in site-packages directories"
1769 elif [[ "$1" =~ ^/ ]]; then
1770 if [[ -d "${root}/$1" ]]; then
1771 other_dirs+=("${root}/$1")
1772 elif [[ -f "${root}/$1" ]]; then
1773 other_files+=("${root}/$1")
1774 elif [[ -e "${root}/$1" ]]; then
1775 ewarn "'${root}/$1' is not a file or a directory!"
1776 else
1777 ewarn "'${root}/$1' does not exist!"
1778 fi
1779 else
1780 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do
1781 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
1782 site_packages_dirs+=("$1")
1783 break 2264 break
1784 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
1785 site_packages_files+=("$1")
1786 break
1787 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
1788 ewarn "'$1' is not a file or a directory!"
1789 else
1790 ewarn "'$1' does not exist!"
1791 fi
1792 done
1793 fi
1794 ;; 2265 ;;
1795 esac 2266 esac
1796 shift 2267 shift
1797 done 2268 done
1798 2269
2270 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
2271 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2272 fi
2273
2274 if [[ "$#" -eq 0 ]]; then
2275 ewarn
2276 ewarn "Deprecation Warning: Not passing of paths to ${FUNCNAME}() is deprecated and will be"
2277 ewarn "disallowed on 2010-09-01. Call ${FUNCNAME}() with paths to Python modules."
2278 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2279 ewarn
2280 fi
2281
2282 while (($#)); do
2283 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2284 die "${FUNCNAME}(): Invalid argument '$1'"
2285 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
2286 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
2287 elif [[ "$1" =~ ^/ ]]; then
2288 if _python_package_supporting_installation_for_multiple_python_abis; then
2289 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
2290 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
2291 fi
2292 if [[ "$1" != *\$* ]]; then
2293 die "${FUNCNAME}(): '$1' has invalid syntax"
2294 fi
2295 if [[ "$1" == *.py ]]; then
2296 evaluated_files+=("$1")
2297 else
2298 evaluated_dirs+=("$1")
2299 fi
2300 else
2301 if [[ -d "${root}$1" ]]; then
2302 other_dirs+=("${root}$1")
2303 elif [[ -f "${root}$1" ]]; then
2304 other_files+=("${root}$1")
2305 elif [[ -e "${root}$1" ]]; then
2306 eerror "${FUNCNAME}(): '${root}$1' is not a regular file or a directory"
2307 else
2308 eerror "${FUNCNAME}(): '${root}$1' does not exist"
2309 fi
2310 fi
2311 else
2312 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2313 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
2314 site_packages_dirs+=("$1")
2315 break
2316 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
2317 site_packages_files+=("$1")
2318 break
2319 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
2320 eerror "${FUNCNAME}(): '$1' is not a regular file or a directory"
2321 else
2322 eerror "${FUNCNAME}(): '$1' does not exist"
2323 fi
2324 done
2325 fi
2326 shift
2327 done
2328
1799 # Set additional options. 2329 # Set additional options.
1800 options+=("-q") 2330 options+=("-q")
1801 2331
1802 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do 2332 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
1803 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})); then 2333 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})) || ((${#evaluated_dirs[@]})) || ((${#evaluated_files[@]})); then
1804 return_code="0" 2334 return_code="0"
1805 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)" 2335 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1806 if ((${#site_packages_dirs[@]})); then 2336 if ((${#site_packages_dirs[@]})) || ((${#evaluated_dirs[@]})); then
1807 for dir in "${site_packages_dirs[@]}"; do 2337 for dir in "${site_packages_dirs[@]}"; do
1808 site_packages_absolute_dirs+=("${root}$(python_get_sitedir)/${dir}") 2338 dirs+=("${root}$(python_get_sitedir)/${dir}")
1809 done 2339 done
2340 for dir in "${evaluated_dirs[@]}"; do
2341 eval "dirs+=(\"\${root}${dir}\")"
2342 done
1810 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" || return_code="1" 2343 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${dirs[@]}" || return_code="1"
1811 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then 2344 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1812 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" &> /dev/null || return_code="1" 2345 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${dirs[@]}" &> /dev/null || return_code="1"
1813 fi 2346 fi
2347 _python_clean_compiled_modules "${dirs[@]}"
1814 fi 2348 fi
1815 if ((${#site_packages_files[@]})); then 2349 if ((${#site_packages_files[@]})) || ((${#evaluated_files[@]})); then
1816 for file in "${site_packages_files[@]}"; do 2350 for file in "${site_packages_files[@]}"; do
1817 site_packages_absolute_files+=("${root}$(python_get_sitedir)/${file}") 2351 files+=("${root}$(python_get_sitedir)/${file}")
1818 done 2352 done
2353 for file in "${evaluated_files[@]}"; do
2354 eval "files+=(\"\${root}${file}\")"
2355 done
1819 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" || return_code="1" 2356 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${files[@]}" || return_code="1"
1820 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then 2357 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1821 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" &> /dev/null || return_code="1" 2358 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${files[@]}" &> /dev/null || return_code="1"
1822 fi 2359 fi
2360 _python_clean_compiled_modules "${files[@]}"
1823 fi 2361 fi
1824 eend "${return_code}" 2362 eend "${return_code}"
1825 fi 2363 fi
1826 unset site_packages_absolute_dirs site_packages_absolute_files 2364 unset dirs files
1827 done 2365 done
1828 2366
2367 if _python_package_supporting_installation_for_multiple_python_abis; then
1829 # Restore previous value of PYTHON_ABI. 2368 # Restore previous value of PYTHON_ABI.
1830 if [[ -n "${previous_PYTHON_ABI}" ]]; then 2369 if [[ -n "${previous_PYTHON_ABI}" ]]; then
1831 PYTHON_ABI="${previous_PYTHON_ABI}" 2370 PYTHON_ABI="${previous_PYTHON_ABI}"
1832 else 2371 else
1833 unset PYTHON_ABI 2372 unset PYTHON_ABI
2373 fi
1834 fi 2374 fi
1835 2375
1836 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then 2376 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then
1837 return_code="0" 2377 return_code="0"
1838 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for $(python_get_implementation) $(python_get_version)" 2378 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for $(python_get_implementation) $(python_get_version)"
1839 if ((${#other_dirs[@]})); then 2379 if ((${#other_dirs[@]})); then
1840 "$(PYTHON "${PYTHON_ABI--A}")" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1" 2380 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1"
1841 if [[ "$(_python_get_implementation "${PYTHON_ABI-$(PYTHON -A --ABI)}")" != "Jython" ]]; then 2381 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1842 "$(PYTHON "${PYTHON_ABI--A}")" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1" 2382 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
1843 fi 2383 fi
2384 _python_clean_compiled_modules "${other_dirs[@]}"
1844 fi 2385 fi
1845 if ((${#other_files[@]})); then 2386 if ((${#other_files[@]})); then
1846 "$(PYTHON "${PYTHON_ABI--A}")" "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1" 2387 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1"
1847 if [[ "$(_python_get_implementation "${PYTHON_ABI-$(PYTHON -A --ABI)}")" != "Jython" ]]; then 2388 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1848 "$(PYTHON "${PYTHON_ABI--A}")" -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1" 2389 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1"
1849 fi 2390 fi
2391 _python_clean_compiled_modules "${other_dirs[@]}"
1850 fi 2392 fi
1851 eend "${return_code}" 2393 eend "${return_code}"
1852 fi 2394 fi
1853 else 2395 else
2396 # Deprecated part of python_mod_optimize()
2397
1854 local myroot mydirs=() myfiles=() myopts=() return_code="0" 2398 local myroot mydirs=() myfiles=() myopts=() return_code="0"
1855 2399
1856 # strip trailing slash 2400 # strip trailing slash
1857 myroot="${EROOT%/}" 2401 myroot="${EROOT%/}"
1858 2402
1859 # respect ROOT and options passed to compileall.py 2403 # respect EROOT and options passed to compileall.py
1860 while (($#)); do 2404 while (($#)); do
1861 case "$1" in 2405 case "$1" in
1862 -l|-f|-q) 2406 -l|-f|-q)
1863 myopts+=("$1") 2407 myopts+=("$1")
1864 ;; 2408 ;;
1865 -d|-x) 2409 -d|-x)
1866 myopts+=("$1" "$2") 2410 myopts+=("$1" "$2")
1867 shift 2411 shift
1868 ;; 2412 ;;
2413 --)
2414 shift
2415 break
2416 ;;
1869 -*) 2417 -*)
1870 ewarn "${FUNCNAME}(): Ignoring option '$1'" 2418 die "${FUNCNAME}(): Unrecognized option '$1'"
1871 ;; 2419 ;;
1872 *) 2420 *)
1873 if [[ -d "${myroot}"/$1 ]]; then 2421 break
1874 mydirs+=("${myroot}/$1")
1875 elif [[ -f "${myroot}"/$1 ]]; then
1876 # Files are passed to python_mod_compile which is ROOT-aware
1877 myfiles+=("$1")
1878 elif [[ -e "${myroot}/$1" ]]; then
1879 ewarn "${myroot}/$1 is not a file or directory!"
1880 else
1881 ewarn "${myroot}/$1 does not exist!"
1882 fi
1883 ;; 2422 ;;
1884 esac 2423 esac
1885 shift 2424 shift
1886 done 2425 done
1887 2426
2427 if [[ "$#" -eq 0 ]]; then
2428 ewarn
2429 ewarn "Deprecation Warning: Not passing of paths to ${FUNCNAME}() is deprecated and will be"
2430 ewarn "disallowed on 2010-09-01. Call ${FUNCNAME}() with paths to Python modules."
2431 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2432 ewarn
2433 fi
2434
2435 while (($#)); do
2436 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2437 die "${FUNCNAME}(): Invalid argument '$1'"
2438 elif [[ -d "${myroot}/${1#/}" ]]; then
2439 mydirs+=("${myroot}/${1#/}")
2440 elif [[ -f "${myroot}/${1#/}" ]]; then
2441 # Files are passed to python_mod_compile which is EROOT-aware
2442 myfiles+=("$1")
2443 elif [[ -e "${myroot}/${1#/}" ]]; then
2444 eerror "${FUNCNAME}(): ${myroot}/${1#/} is not a regular file or directory"
2445 else
2446 eerror "${FUNCNAME}(): ${myroot}/${1#/} does not exist"
2447 fi
2448 shift
2449 done
2450
1888 # set additional opts 2451 # set additional opts
1889 myopts+=(-q) 2452 myopts+=(-q)
1890 2453
2454 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2455
1891 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)" 2456 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1892 if ((${#mydirs[@]})); then 2457 if ((${#mydirs[@]})); then
1893 "$(PYTHON "${PYTHON_ABI--A}")" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1" 2458 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1"
1894 "$(PYTHON "${PYTHON_ABI--A}")" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1" 2459 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
2460 _python_clean_compiled_modules "${mydirs[@]}"
1895 fi 2461 fi
1896 2462
1897 if ((${#myfiles[@]})); then 2463 if ((${#myfiles[@]})); then
1898 python_mod_compile "${myfiles[@]}" 2464 python_mod_compile "${myfiles[@]}"
1899 fi 2465 fi
1910# 2476#
1911# It will recursively scan all compiled Python modules in the directories and 2477# It will recursively scan all compiled Python modules in the directories and
1912# determine if they are orphaned (i.e. their corresponding .py files are missing.) 2478# determine if they are orphaned (i.e. their corresponding .py files are missing.)
1913# If they are, then it will remove their corresponding .pyc and .pyo files. 2479# If they are, then it will remove their corresponding .pyc and .pyo files.
1914# 2480#
1915# This function should only be run in pkg_postrm(). 2481# This function can be used only in pkg_postrm() phase.
1916python_mod_cleanup() { 2482python_mod_cleanup() {
2483 _python_check_python_pkg_setup_execution
1917 _python_initialize_prefix_variables 2484 _python_initialize_prefix_variables
1918 2485
1919 local path py_file PYTHON_ABI SEARCH_PATH=() root 2486 local allow_evaluated_non_sitedir_paths="0" dir iterated_PYTHON_ABIS PYTHON_ABI="${PYTHON_ABI}" root search_paths=() sitedir
1920 2487
1921 # Check if phase is pkg_postrm(). 2488 # Check if phase is pkg_postrm().
1922 [[ ${EBUILD_PHASE} != "postrm" ]] && die "${FUNCNAME}() should only be run in pkg_postrm()" 2489 [[ "${EBUILD_PHASE}" != "postrm" ]] && die "${FUNCNAME}() can be used only in pkg_postrm() phase"
1923 2490
2491 if _python_package_supporting_installation_for_multiple_python_abis; then
2492 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
2493 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
2494 fi
2495 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
2496 else
2497 if has "${EAPI:-0}" 0 1 2 3; then
2498 iterated_PYTHON_ABIS="${PYTHON_ABI:-$(PYTHON --ABI)}"
2499 else
2500 iterated_PYTHON_ABIS="${PYTHON_ABI}"
2501 fi
2502 fi
2503
1924 # Strip trailing slash from ROOT. 2504 # Strip trailing slash from EROOT.
1925 root="${EROOT%/}" 2505 root="${EROOT%/}"
1926 2506
1927 if (($#)); then 2507 while (($#)); do
1928 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2508 case "$1" in
2509 --allow-evaluated-non-sitedir-paths)
2510 allow_evaluated_non_sitedir_paths="1"
2511 ;;
2512 --)
2513 shift
2514 break
2515 ;;
2516 -*)
2517 die "${FUNCNAME}(): Unrecognized option '$1'"
2518 ;;
2519 *)
2520 break
2521 ;;
2522 esac
2523 shift
2524 done
2525
2526 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
2527 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2528 fi
2529
2530 if [[ "$#" -gt 0 ]]; then
2531 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
1929 while (($#)); do 2532 while (($#)); do
2533 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2534 die "${FUNCNAME}(): Invalid argument '$1'"
1930 if ! _python_implementation && [[ "$1" =~ ^"${EPREFIX}"/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then 2535 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
1931 die "${FUNCNAME}() does not support absolute paths of directories/files in site-packages directories" 2536 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
1932 elif [[ "$1" =~ ^/ ]]; then 2537 elif [[ "$1" =~ ^/ ]]; then
1933 SEARCH_PATH+=("${root}/${1#/}") 2538 if _python_package_supporting_installation_for_multiple_python_abis; then
2539 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
2540 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
2541 fi
2542 if [[ "$1" != *\$* ]]; then
2543 die "${FUNCNAME}(): '$1' has invalid syntax"
2544 fi
2545 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2546 eval "search_paths+=(\"\${root}$1\")"
2547 done
2548 else
2549 search_paths+=("${root}$1")
2550 fi
1934 else 2551 else
1935 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do 2552 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
1936 SEARCH_PATH+=("${root}$(python_get_sitedir)/$1") 2553 search_paths+=("${root}$(python_get_sitedir)/$1")
1937 done 2554 done
1938 fi 2555 fi
1939 shift 2556 shift
1940 done 2557 done
1941 else 2558 else
1942 SEARCH_PATH=("${@#/}") 2559 # Deprecated part of python_mod_cleanup()
1943 SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}") 2560
2561 search_paths=("${@#/}")
2562 search_paths=("${search_paths[@]/#/${root}/}")
1944 fi 2563 fi
1945 else 2564 else
1946 local dir sitedir 2565 ewarn
2566 ewarn "Deprecation Warning: Not passing of paths to ${FUNCNAME}() is deprecated and will be"
2567 ewarn "disallowed on 2010-09-01. Call ${FUNCNAME}() with paths to Python modules."
2568 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2569 ewarn
2570
1947 for dir in "${root}"/usr/lib*; do 2571 for dir in "${root}"/usr/lib*; do
1948 if [[ -d "${dir}" && ! -L "${dir}" ]]; then 2572 if [[ -d "${dir}" && ! -L "${dir}" ]]; then
1949 for sitedir in "${dir}"/python*/site-packages; do 2573 for sitedir in "${dir}"/python*/site-packages; do
1950 if [[ -d "${sitedir}" ]]; then 2574 if [[ -d "${sitedir}" ]]; then
1951 SEARCH_PATH+=("${sitedir}") 2575 search_paths+=("${sitedir}")
1952 fi 2576 fi
1953 done 2577 done
1954 fi 2578 fi
1955 done 2579 done
1956 for sitedir in "${root}"/usr/share/jython-*/Lib/site-packages; do 2580 for sitedir in "${root}"/usr/share/jython-*/Lib/site-packages; do
1957 if [[ -d "${sitedir}" ]]; then 2581 if [[ -d "${sitedir}" ]]; then
1958 SEARCH_PATH+=("${sitedir}") 2582 search_paths+=("${sitedir}")
1959 fi 2583 fi
1960 done 2584 done
1961 fi 2585 fi
1962 2586
1963 local BLUE CYAN NORMAL 2587 _python_clean_compiled_modules "${search_paths[@]}"
1964 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
1965 BLUE=$'\e[1;34m'
1966 CYAN=$'\e[1;36m'
1967 NORMAL=$'\e[0m'
1968 else
1969 BLUE=
1970 CYAN=
1971 NORMAL=
1972 fi
1973
1974 for path in "${SEARCH_PATH[@]}"; do
1975 if [[ -d "${path}" ]]; then
1976 find "${path}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -print0 | while read -rd ''; do
1977 if [[ "${REPLY}" == *[co] ]]; then
1978 py_file="${REPLY%[co]}"
1979 [[ -f "${py_file}" || (! -f "${py_file}c" && ! -f "${py_file}o") ]] && continue
1980 einfo "${BLUE}<<< ${py_file}[co]${NORMAL}"
1981 rm -f "${py_file}"[co]
1982 elif [[ "${REPLY}" == *\$py.class ]]; then
1983 py_file="${REPLY%\$py.class}.py"
1984 [[ -f "${py_file}" || ! -f "${py_file%.py}\$py.class" ]] && continue
1985 einfo "${BLUE}<<< ${py_file%.py}\$py.class${NORMAL}"
1986 rm -f "${py_file%.py}\$py.class"
1987 fi
1988 done
1989
1990 # Attempt to delete directories, which may be empty.
1991 find "${path}" -type d | sort -r | while read -r dir; do
1992 rmdir "${dir}" 2>/dev/null && einfo "${CYAN}<<< ${dir}${NORMAL}"
1993 done
1994 elif [[ "${path}" == *.py && ! -f "${path}" ]]; then
1995 if [[ (-f "${path}c" || -f "${path}o") ]]; then
1996 einfo "${BLUE}<<< ${path}[co]${NORMAL}"
1997 rm -f "${path}"[co]
1998 fi
1999 if [[ -f "${path%.py}\$py.class" ]]; then
2000 einfo "${BLUE}<<< ${path%.py}\$py.class${NORMAL}"
2001 rm -f "${path%.py}\$py.class"
2002 fi
2003 fi
2004 done
2005} 2588}
2006 2589
2007# ================================================================================================ 2590# ================================================================================================
2008# ===================================== DEPRECATED FUNCTIONS ===================================== 2591# ===================================== DEPRECATED FUNCTIONS =====================================
2009# ================================================================================================ 2592# ================================================================================================
2010 2593
2011# @FUNCTION: python_version 2594# Scheduled for deletion on 2011-01-01.
2012# @DESCRIPTION:
2013# Run without arguments and it will export the version of python
2014# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
2015python_version() { 2595python_version() {
2016 if ! has "${EAPI:-0}" 0 1 2; then 2596 eerror "Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables."
2597 die "${FUNCNAME}() is banned"
2598}
2599
2600# Scheduled for deletion on 2011-01-01.
2601python_mod_exists() {
2602 eerror "Use USE dependencies and/or has_version() instead of ${FUNCNAME}()."
2603 die "${FUNCNAME}() is banned"
2604}
2605
2606# Scheduled for deletion on 2011-01-01.
2607python_tkinter_exists() {
2017 eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()." 2608 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
2018 die "${FUNCNAME}() cannot be used in this EAPI" 2609 die "${FUNCNAME}() is banned"
2019 fi
2020
2021 [[ -n "${PYVER}" ]] && return 0
2022 local tmpstr
2023 python="${python:-${EPREFIX}/usr/bin/python}"
2024 tmpstr="$(EPYTHON= ${python} -V 2>&1 )"
2025 export PYVER_ALL="${tmpstr#Python }"
2026 export PYVER_MAJOR="${PYVER_ALL:0:1}"
2027 export PYVER_MINOR="${PYVER_ALL:2:1}"
2028 if [[ "${PYVER_ALL:3:1}" == "." ]]; then
2029 export PYVER_MICRO="${PYVER_ALL:4}"
2030 fi
2031 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
2032} 2610}
2033 2611
2034# @FUNCTION: python_mod_compile 2612# @FUNCTION: python_mod_compile
2035# @USAGE: <file> [more files ...] 2613# @USAGE: <file> [more files ...]
2036# @DESCRIPTION: 2614# @DESCRIPTION:
2037# Given filenames, it will pre-compile the module's .pyc and .pyo. 2615# Given filenames, it will pre-compile the module's .pyc and .pyo.
2038# This function should only be run in pkg_postinst() 2616# This function can be used only in pkg_postinst() phase.
2039# 2617#
2040# Example: 2618# Example:
2041# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py 2619# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
2042# 2620#
2043python_mod_compile() { 2621python_mod_compile() {
2044 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2622 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2045 eerror "Use python_mod_optimize() instead of ${FUNCNAME}()." 2623 eerror "Use python_mod_optimize() instead of ${FUNCNAME}()."
2046 die "${FUNCNAME}() cannot be used in this EAPI" 2624 die "${FUNCNAME}() cannot be used in this EAPI"
2047 fi 2625 fi
2048 2626
2049 _python_initialize_prefix_variables 2627 _python_initialize_prefix_variables
2628 _python_set_color_variables
2629
2630 if [[ "${FUNCNAME[1]}" != "python_mod_optimize" ]]; then
2631 ewarn
2632 ewarn "Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-09-01."
2633 ewarn "Use python_mod_optimize() instead of ${FUNCNAME}()."
2634 ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2635 ewarn
2636 fi
2050 2637
2051 local f myroot myfiles=() 2638 local f myroot myfiles=()
2052 2639
2053 # Check if phase is pkg_postinst() 2640 # Check if phase is pkg_postinst()
2054 [[ ${EBUILD_PHASE} != postinst ]] && die "${FUNCNAME}() should only be run in pkg_postinst()" 2641 [[ "${EBUILD_PHASE}" != "postinst" ]] && die "${FUNCNAME}() can be used only in pkg_postinst() phase"
2055 2642
2056 # strip trailing slash 2643 # strip trailing slash
2057 myroot="${EROOT%/}" 2644 myroot="${EROOT%/}"
2058 2645
2059 # respect ROOT 2646 # respect EROOT
2060 for f in "$@"; do 2647 for f in "$@"; do
2061 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}") 2648 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
2062 done 2649 done
2063 2650
2651 PYTHON_ABI="$(PYTHON --ABI)"
2652
2064 if ((${#myfiles[@]})); then 2653 if ((${#myfiles[@]})); then
2065 "$(PYTHON "${PYTHON_ABI--A}")" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" 2654 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}"
2066 "$(PYTHON "${PYTHON_ABI--A}")" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null 2655 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null
2656 _python_clean_compiled_modules "${myfiles[@]}"
2067 else 2657 else
2068 ewarn "No files to compile!" 2658 ewarn "No files to compile!"
2069 fi 2659 fi
2070} 2660}

Legend:
Removed from v.1.89  
changed lines
  Added in v.1.103

  ViewVC Help
Powered by ViewVC 1.1.20