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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.114

  ViewVC Help
Powered by ViewVC 1.1.20