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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.116

  ViewVC Help
Powered by ViewVC 1.1.20