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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.156

  ViewVC Help
Powered by ViewVC 1.1.20