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

Diff of /eclass/python.eclass

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

Revision 1.16 Revision 1.96
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2010 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.16 2005/04/20 15:43:37 liquidx Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.96 2010/03/26 15:23:17 arfrever 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_SUPPORTED_ABIS=(2.4 2.5 2.6 2.7)
19_CPYTHON3_SUPPORTED_ABIS=(3.0 3.1 3.2)
20_JYTHON_SUPPORTED_ABIS=(2.5-jython)
21
22# @ECLASS-VARIABLE: PYTHON_DEPEND
23# @DESCRIPTION:
24# Specification of dependency on dev-lang/python.
25# Syntax:
26# PYTHON_DEPEND: [[!]USE_flag? ]<version_components_group>[ version_components_group]
27# version_components_group: <major_version[:[minimal_version][:maximal_version]]>
28# major_version: <2|3|*>
29# minimal_version: <minimal_major_version.minimal_minor_version>
30# maximal_version: <maximal_major_version.maximal_minor_version>
31
32_parse_PYTHON_DEPEND() {
33 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
34
35 version_components_group_regex="(2|3|\*)(:([[:digit:]]+\.[[:digit:]]+)?(:([[:digit:]]+\.[[:digit:]]+)?)?)?"
36 version_components_groups="${PYTHON_DEPEND}"
37
38 if [[ "${version_components_groups}" =~ ^((\!)?[[:alnum:]_-]+\?\ )?${version_components_group_regex}(\ ${version_components_group_regex})?$ ]]; then
39 if [[ "${version_components_groups}" =~ ^(\!)?[[:alnum:]_-]+\? ]]; then
40 USE_flag="${version_components_groups%\? *}"
41 version_components_groups="${version_components_groups#* }"
42 fi
43 if [[ "${version_components_groups}" =~ ("*".*" "|" *"|^2.*\ (2|\*)|^3.*\ (3|\*)) ]]; then
44 die "Invalid syntax of PYTHON_DEPEND: Incorrectly specified groups of versions"
45 fi
46
47 version_components_groups="${version_components_groups// /$'\n'}"
48 while read version_components_group; do
49 major_version="${version_components_group:0:1}"
50 minimal_version="${version_components_group:2}"
51 minimal_version="${minimal_version%:*}"
52 maximal_version="${version_components_group:$((3 + ${#minimal_version}))}"
53
54 if [[ "${major_version}" =~ ^(2|3)$ ]]; then
55 if [[ -n "${minimal_version}" && "${major_version}" != "${minimal_version:0:1}" ]]; then
56 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' not in specified group of versions"
57 fi
58 if [[ -n "${maximal_version}" && "${major_version}" != "${maximal_version:0:1}" ]]; then
59 die "Invalid syntax of PYTHON_DEPEND: Maximal version '${maximal_version}' not in specified group of versions"
60 fi
61 fi
62
63 if [[ "${major_version}" == "2" ]]; then
64 python2="1"
65 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}")
66 python2_minimal_version="${minimal_version}"
67 python2_maximal_version="${maximal_version}"
68 elif [[ "${major_version}" == "3" ]]; then
69 python3="1"
70 python_versions=("${_CPYTHON3_SUPPORTED_ABIS[@]}")
71 python3_minimal_version="${minimal_version}"
72 python3_maximal_version="${maximal_version}"
73 else
74 python_all="1"
75 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}")
76 python_minimal_version="${minimal_version}"
77 python_maximal_version="${maximal_version}"
78 fi
79
80 if [[ -n "${minimal_version}" ]] && ! has "${minimal_version}" "${python_versions[@]}"; then
81 die "Invalid syntax of PYTHON_DEPEND: Unrecognized minimal version '${minimal_version}'"
82 fi
83 if [[ -n "${maximal_version}" ]] && ! has "${maximal_version}" "${python_versions[@]}"; then
84 die "Invalid syntax of PYTHON_DEPEND: Unrecognized maximal version '${maximal_version}'"
85 fi
86
87 if [[ -n "${minimal_version}" && -n "${maximal_version}" && "${minimal_version}" > "${maximal_version}" ]]; then
88 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' greater than maximal version '${maximal_version}'"
89 fi
90 done <<< "${version_components_groups}"
91
92 _PYTHON_ATOMS=()
93
94 _append_accepted_versions_range() {
95 local accepted_version="0" i
96 for ((i = "${#python_versions[@]}"; i >= 0; i--)); do
97 if [[ "${python_versions[${i}]}" == "${python_maximal_version}" ]]; then
98 accepted_version="1"
99 fi
100 if [[ "${accepted_version}" == "1" ]]; then
101 _PYTHON_ATOMS+=("=dev-lang/python-${python_versions[${i}]}*")
102 fi
103 if [[ "${python_versions[${i}]}" == "${python_minimal_version}" ]]; then
104 accepted_version="0"
105 fi
106 done
107 }
108
109 if [[ "${python_all}" == "1" ]]; then
110 if [[ -z "${python_minimal_version}" && -z "${python_maximal_version}" ]]; then
111 _PYTHON_ATOMS+=("dev-lang/python")
112 else
113 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}")
114 python_minimal_version="${python_minimal_version:-${python_versions[0]}}"
115 python_maximal_version="${python_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
116 _append_accepted_versions_range
117 fi
118 else
119 if [[ "${python3}" == "1" ]]; then
120 if [[ -z "${python3_minimal_version}" && -z "${python3_maximal_version}" ]]; then
121 _PYTHON_ATOMS+=("=dev-lang/python-3*")
122 else
123 python_versions=("${_CPYTHON3_SUPPORTED_ABIS[@]}")
124 python_minimal_version="${python3_minimal_version:-${python_versions[0]}}"
125 python_maximal_version="${python3_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
126 _append_accepted_versions_range
127 fi
128 fi
129 if [[ "${python2}" == "1" ]]; then
130 if [[ -z "${python2_minimal_version}" && -z "${python2_maximal_version}" ]]; then
131 _PYTHON_ATOMS+=("=dev-lang/python-2*")
132 else
133 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}")
134 python_minimal_version="${python2_minimal_version:-${python_versions[0]}}"
135 python_maximal_version="${python2_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
136 _append_accepted_versions_range
137 fi
138 fi
139 fi
140
141 unset -f _append_accepted_versions_range
142
143 if [[ "${#_PYTHON_ATOMS[@]}" -gt 1 ]]; then
144 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
145 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
146 else
147 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
148 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
149 fi
150 else
151 die "Invalid syntax of PYTHON_DEPEND"
152 fi
153}
154
155DEPEND=">=app-admin/eselect-python-20091230"
156RDEPEND="${DEPEND}"
157
158if [[ -n "${PYTHON_DEPEND}" && -n "${NEED_PYTHON}" ]]; then
159 die "PYTHON_DEPEND and NEED_PYTHON cannot be set simultaneously"
160elif [[ -n "${PYTHON_DEPEND}" ]]; then
161 _parse_PYTHON_DEPEND
162elif [[ -n "${NEED_PYTHON}" ]]; then
163 if ! has "${EAPI:-0}" 0 1 2; then
164 eerror "Use PYTHON_DEPEND instead of NEED_PYTHON."
165 die "NEED_PYTHON cannot be used in this EAPI"
166 fi
167 _PYTHON_ATOMS=(">=dev-lang/python-${NEED_PYTHON}")
168 DEPEND+="${DEPEND:+ }${_PYTHON_ATOMS[@]}"
169 RDEPEND+="${RDEPEND:+ }${_PYTHON_ATOMS[@]}"
170else
171 _PYTHON_ATOMS=("dev-lang/python")
172fi
173
174# @ECLASS-VARIABLE: PYTHON_USE_WITH
175# @DESCRIPTION:
176# Set this to a space separated list of USE flags the Python slot in use must be built with.
177
178# @ECLASS-VARIABLE: PYTHON_USE_WITH_OR
179# @DESCRIPTION:
180# Set this to a space separated list of USE flags of which one must be turned on for the slot in use.
181
182# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT
183# @DESCRIPTION:
184# Set this to a name of a USE flag if you need to make either PYTHON_USE_WITH or
185# PYTHON_USE_WITH_OR atoms conditional under a USE flag.
186
187# @FUNCTION: python_pkg_setup
188# @DESCRIPTION:
189# Makes sure PYTHON_USE_WITH or PYTHON_USE_WITH_OR listed use flags
190# are respected. Only exported if one of those variables is set.
191if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
192 python_pkg_setup() {
193 # Check if phase is pkg_setup().
194 [[ "${EBUILD_PHASE}" != "setup" ]] && die "${FUNCNAME}() can be used only in pkg_setup() phase"
195
196 python_pkg_setup_fail() {
197 eerror "${1}"
198 die "${1}"
199 }
200
201 if [[ "${PYTHON_USE_WITH_OPT}" ]]; then
202 if [[ "${PYTHON_USE_WITH_OPT}" == !* ]]; then
203 use ${PYTHON_USE_WITH_OPT#!} && return
204 else
205 use !${PYTHON_USE_WITH_OPT} && return
206 fi
207 fi
208
209 python_pkg_setup_check_USE_flags() {
210 local pyatom use
211 pyatom="$(python_get_implementational_package)"
212
213 for use in ${PYTHON_USE_WITH}; do
214 if ! has_version "${pyatom}[${use}]"; then
215 python_pkg_setup_fail "Please rebuild ${pyatom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
216 fi
217 done
218
219 for use in ${PYTHON_USE_WITH_OR}; do
220 if has_version "${pyatom}[${use}]"; then
221 return
222 fi
223 done
224
225 if [[ ${PYTHON_USE_WITH_OR} ]]; then
226 python_pkg_setup_fail "Please rebuild ${pyatom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
227 fi
228 }
229
230 if _python_package_supporting_installation_for_multiple_python_abis; then
231 python_execute_function -q python_pkg_setup_check_USE_flags
232 else
233 python_pkg_setup_check_USE_flags
234 fi
235
236 unset -f python_pkg_setup_check_USE_flags python_pkg_setup_fail
237 }
238
239 EXPORT_FUNCTIONS pkg_setup
240
241 _PYTHON_USE_WITH_ATOMS_ARRAY=()
242 if [[ -n "${PYTHON_USE_WITH}" ]]; then
243 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
244 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${PYTHON_USE_WITH/ /,}]")
245 done
246 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then
247 for _USE_flag in ${PYTHON_USE_WITH_OR}; do
248 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
249 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${_USE_flag}]")
250 done
251 done
252 unset _USE_flag
253 fi
254 if [[ "${#_PYTHON_USE_WITH_ATOMS_ARRAY[@]}" -gt 1 ]]; then
255 _PYTHON_USE_WITH_ATOMS="|| ( ${_PYTHON_USE_WITH_ATOMS_ARRAY[@]} )"
256 else
257 _PYTHON_USE_WITH_ATOMS="${_PYTHON_USE_WITH_ATOMS_ARRAY[@]}"
258 fi
259 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then
260 _PYTHON_USE_WITH_ATOMS="${PYTHON_USE_WITH_OPT}? ( ${_PYTHON_USE_WITH_ATOMS} )"
261 fi
262 DEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
263 RDEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
264 unset _PYTHON_ATOM _PYTHON_USE_WITH_ATOMS _PYTHON_USE_WITH_ATOMS_ARRAY
265fi
266
267unset _PYTHON_ATOMS
268
269# ================================================================================================
270# =========== FUNCTIONS FOR PACKAGES SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ============
271# ================================================================================================
272
273# @ECLASS-VARIABLE: SUPPORT_PYTHON_ABIS
274# @DESCRIPTION:
275# Set this in EAPI <= 4 to indicate that current package supports installation for
276# multiple Python ABIs.
277
278# @ECLASS-VARIABLE: PYTHON_EXPORT_PHASE_FUNCTIONS
279# @DESCRIPTION:
280# Set this to export phase functions for the following ebuild phases:
281# src_prepare, src_configure, src_compile, src_test, src_install.
282if ! has "${EAPI:-0}" 0 1; then
283 python_src_prepare() {
284 if ! _python_package_supporting_installation_for_multiple_python_abis; then
285 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
286 fi
287
288 python_copy_sources
289 }
290
291 for python_default_function in src_configure src_compile src_test src_install; do
292 eval "python_${python_default_function}() {
293 if ! _python_package_supporting_installation_for_multiple_python_abis; then
294 die \"\${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs\"
295 fi
296
297 python_execute_function -d -s \"\$@\"
298 }"
299 done
300 unset python_default_function
301
302 if [[ -n "${PYTHON_EXPORT_PHASE_FUNCTIONS}" ]]; then
303 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install
304 fi
305fi
306
307unset PYTHON_ABIS
308
309# @FUNCTION: validate_PYTHON_ABIS
310# @DESCRIPTION:
311# Ensure that PYTHON_ABIS variable has valid value.
312# This function usually should not be directly called in ebuilds.
313validate_PYTHON_ABIS() {
314 if ! _python_package_supporting_installation_for_multiple_python_abis; then
315 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
316 fi
317
318 _python_initial_sanity_checks
319
320 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 5.
321 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3 4; then
322 local PYTHON_ABI restricted_ABI support_ABI supported_PYTHON_ABIS=
323 PYTHON_ABI_SUPPORTED_VALUES="${_CPYTHON2_SUPPORTED_ABIS[@]} ${_CPYTHON3_SUPPORTED_ABIS[@]} ${_JYTHON_SUPPORTED_ABIS[@]}"
324
325 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
326 local cpython_enabled="0"
327
328 if [[ -z "${USE_PYTHON}" ]]; then
329 die "USE_PYTHON variable is empty"
330 fi
331
332 for PYTHON_ABI in ${USE_PYTHON}; do
333 if ! has "${PYTHON_ABI}" ${PYTHON_ABI_SUPPORTED_VALUES}; then
334 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'"
335 fi
336
337 if has "${PYTHON_ABI}" "${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}"; then
338 cpython_enabled="1"
339 fi
340
341 support_ABI="1"
342 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
343 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
344 support_ABI="0"
345 break
346 fi
347 done
348 [[ "${support_ABI}" == "1" ]] && export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}"
349 done
350
351 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then
352 die "USE_PYTHON variable does not enable any Python ABI supported by ${CATEGORY}/${PF}"
353 fi
354
355 if [[ "${cpython_enabled}" == "0" ]]; then
356 die "USE_PYTHON variable does not enable any CPython ABI"
357 fi
358 else
359 local python_version python2_version= python3_version= support_python_major_version
360
361 python_version="$("${EPREFIX}/usr/bin/python" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
362
363 if has_version "=dev-lang/python-2*"; then
364 if [[ "$(readlink "${EPREFIX}/usr/bin/python2")" != "python2."* ]]; then
365 die "'${EPREFIX}/usr/bin/python2' is not valid symlink"
366 fi
367
368 python2_version="$("${EPREFIX}/usr/bin/python2" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
369
370 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do
371 support_python_major_version="1"
372 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
373 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
374 support_python_major_version="0"
375 fi
376 done
377 [[ "${support_python_major_version}" == "1" ]] && break
378 done
379 if [[ "${support_python_major_version}" == "1" ]]; then
380 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
381 if [[ "${python2_version}" == ${restricted_ABI} ]]; then
382 die "Active version of Python 2 is not supported by ${CATEGORY}/${PF}"
383 fi
384 done
385 else
386 python2_version=""
387 fi
388 fi
389
390 if has_version "=dev-lang/python-3*"; then
391 if [[ "$(readlink "${EPREFIX}/usr/bin/python3")" != "python3."* ]]; then
392 die "'${EPREFIX}/usr/bin/python3' is not valid symlink"
393 fi
394
395 python3_version="$("${EPREFIX}/usr/bin/python3" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
396
397 for PYTHON_ABI in "${_CPYTHON3_SUPPORTED_ABIS[@]}"; do
398 support_python_major_version="1"
399 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
400 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
401 support_python_major_version="0"
402 fi
403 done
404 [[ "${support_python_major_version}" == "1" ]] && break
405 done
406 if [[ "${support_python_major_version}" == "1" ]]; then
407 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
408 if [[ "${python3_version}" == ${restricted_ABI} ]]; then
409 die "Active version of Python 3 is not supported by ${CATEGORY}/${PF}"
410 fi
411 done
412 else
413 python3_version=""
414 fi
415 fi
416
417 if [[ -n "${python2_version}" && "${python_version}" == "2."* && "${python_version}" != "${python2_version}" ]]; then
418 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python2' symlink"
419 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
420 die "Incorrect configuration of Python"
421 fi
422 if [[ -n "${python3_version}" && "${python_version}" == "3."* && "${python_version}" != "${python3_version}" ]]; then
423 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python3' symlink"
424 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
425 die "Incorrect configuration of Python"
426 fi
427
428 PYTHON_ABIS="${python2_version} ${python3_version}"
429 PYTHON_ABIS="${PYTHON_ABIS# }"
430 export PYTHON_ABIS="${PYTHON_ABIS% }"
431 fi
432 fi
433
434 _python_final_sanity_checks
435}
436
437# @FUNCTION: python_execute_function
438# @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]
439# @DESCRIPTION:
440# Execute specified function for each value of PYTHON_ABIS, optionally passing additional
441# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
442python_execute_function() {
443 if ! _python_package_supporting_installation_for_multiple_python_abis; then
444 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
445 fi
446
447 _python_set_color_variables
448
449 local action action_message action_message_template= default_function="0" failure_message failure_message_template= final_ABI="0" function i iterated_PYTHON_ABIS nonfatal="0" previous_directory previous_directory_stack previous_directory_stack_length PYTHON_ABI quiet="0" separate_build_dirs="0" source_dir=
450
451 while (($#)); do
452 case "$1" in
453 --action-message)
454 action_message_template="$2"
455 shift
456 ;;
457 -d|--default-function)
458 default_function="1"
459 ;;
460 --failure-message)
461 failure_message_template="$2"
462 shift
463 ;;
464 -f|--final-ABI)
465 final_ABI="1"
466 ;;
467 --nonfatal)
468 nonfatal="1"
469 ;;
470 -q|--quiet)
471 quiet="1"
472 ;;
473 -s|--separate-build-dirs)
474 separate_build_dirs="1"
475 ;;
476 --source-dir)
477 source_dir="$2"
478 shift
479 ;;
480 --)
481 shift
482 break
483 ;;
484 -*)
485 die "${FUNCNAME}(): Unrecognized option '$1'"
486 ;;
487 *)
488 break
489 ;;
490 esac
491 shift
492 done
493
494 if [[ -n "${source_dir}" && "${separate_build_dirs}" == 0 ]]; then
495 die "${FUNCNAME}(): '--source-dir' option can be specified only with '--separate-build-dirs' option"
496 fi
497
498 if [[ "${default_function}" == "0" ]]; then
499 if [[ "$#" -eq 0 ]]; then
500 die "${FUNCNAME}(): Missing function name"
501 fi
502 function="$1"
503 shift
504
505 if [[ -z "$(type -t "${function}")" ]]; then
506 die "${FUNCNAME}(): '${function}' function is not defined"
507 fi
508 else
509 if has "${EAPI:-0}" 0 1; then
510 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
511 fi
512
513 if [[ "${EBUILD_PHASE}" == "configure" ]]; then
514 if has "${EAPI}" 2 3; then
515 python_default_function() {
516 econf "$@"
517 }
518 else
519 python_default_function() {
520 nonfatal econf "$@"
521 }
522 fi
523 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then
524 python_default_function() {
525 emake "$@"
526 }
527 elif [[ "${EBUILD_PHASE}" == "test" ]]; then
528 python_default_function() {
529 if emake -j1 -n check &> /dev/null; then
530 emake -j1 check "$@"
531 elif emake -j1 -n test &> /dev/null; then
532 emake -j1 test "$@"
533 fi
534 }
535 elif [[ "${EBUILD_PHASE}" == "install" ]]; then
536 python_default_function() {
537 emake DESTDIR="${D}" install "$@"
538 }
539 else
540 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase"
541 fi
542 function="python_default_function"
543 fi
544
545 # Ensure that python_execute_function() cannot be directly or indirectly called by python_execute_function().
546 for ((i = 1; i < "${#FUNCNAME[@]}"; i++)); do
547 if [[ "${FUNCNAME[${i}]}" == "${FUNCNAME}" ]]; then
548 die "${FUNCNAME}(): Invalid call stack"
549 fi
550 done
551
552 if [[ "${quiet}" == "0" ]]; then
553 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up"
554 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking"
555 [[ "${EBUILD_PHASE}" == "prepare" ]] && action="Preparation"
556 [[ "${EBUILD_PHASE}" == "configure" ]] && action="Configuration"
557 [[ "${EBUILD_PHASE}" == "compile" ]] && action="Building"
558 [[ "${EBUILD_PHASE}" == "test" ]] && action="Testing"
559 [[ "${EBUILD_PHASE}" == "install" ]] && action="Installation"
560 [[ "${EBUILD_PHASE}" == "preinst" ]] && action="Preinstallation"
561 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation"
562 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation"
563 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation"
564 fi
565
566 validate_PYTHON_ABIS
567 if [[ "${final_ABI}" == "1" ]]; then
568 iterated_PYTHON_ABIS="$(PYTHON -f --ABI)"
569 else
570 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
571 fi
572 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
573 if [[ "${quiet}" == "0" ]]; then
574 if [[ -n "${action_message_template}" ]]; then
575 action_message="$(eval echo -n "${action_message_template}")"
576 else
577 action_message="${action} of ${CATEGORY}/${PF} with $(python_get_implementation) $(python_get_version)..."
578 fi
579 echo " ${_GREEN}*${_NORMAL} ${_BLUE}${action_message}${_NORMAL}"
580 fi
581
582 if [[ "${separate_build_dirs}" == "1" ]]; then
583 if [[ -n "${source_dir}" ]]; then
584 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}"
585 else
586 export BUILDDIR="${S}-${PYTHON_ABI}"
587 fi
588 pushd "${BUILDDIR}" > /dev/null || die "pushd failed"
589 else
590 export BUILDDIR="${S}"
591 fi
592
593 previous_directory="$(pwd)"
594 previous_directory_stack="$(dirs -p)"
595 previous_directory_stack_length="$(dirs -p | wc -l)"
596
597 if ! has "${EAPI}" 0 1 2 3 && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
598 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@"
599 else
600 EPYTHON="$(PYTHON)" "${function}" "$@"
601 fi
602
603 if [[ "$?" != "0" ]]; then
604 if [[ -n "${failure_message_template}" ]]; then
605 failure_message="$(eval echo -n "${failure_message_template}")"
606 else
607 failure_message="${action} failed with $(python_get_implementation) $(python_get_version) in ${function}() function"
608 fi
609
610 if [[ "${nonfatal}" == "1" ]]; then
611 if [[ "${quiet}" == "0" ]]; then
612 ewarn "${_RED}${failure_message}${_NORMAL}"
613 fi
614 elif [[ "${final_ABI}" == "0" ]] && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
615 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then
616 local enabled_PYTHON_ABIS= other_PYTHON_ABI
617 for other_PYTHON_ABI in ${PYTHON_ABIS}; do
618 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}"
619 done
620 export PYTHON_ABIS="${enabled_PYTHON_ABIS}"
621 fi
622 if [[ "${quiet}" == "0" ]]; then
623 ewarn "${_RED}${failure_message}${_NORMAL}"
624 fi
625 if [[ -z "${PYTHON_ABIS}" ]]; then
626 die "${function}() function failed with all enabled Python ABIs"
627 fi
628 else
629 die "${failure_message}"
630 fi
631 fi
632
633 # Ensure that directory stack has not been decreased.
634 if [[ "$(dirs -p | wc -l)" -lt "${previous_directory_stack_length}" ]]; then
635 die "Directory stack decreased illegally"
636 fi
637
638 # Avoid side effects of earlier returning from the specified function.
639 while [[ "$(dirs -p | wc -l)" -gt "${previous_directory_stack_length}" ]]; do
640 popd > /dev/null || die "popd failed"
641 done
642
643 # Ensure that the bottom part of directory stack has not been changed. Restore
644 # previous directory (from before running of the specified function) before
645 # comparison of directory stacks to avoid mismatch of directory stacks after
646 # potential using of 'cd' to change current directory. Restoration of previous
647 # directory allows to safely use 'cd' to change current directory in the
648 # specified function without changing it back to original directory.
649 cd "${previous_directory}"
650 if [[ "$(dirs -p)" != "${previous_directory_stack}" ]]; then
651 die "Directory stack changed illegally"
652 fi
653
654 if [[ "${separate_build_dirs}" == "1" ]]; then
655 popd > /dev/null || die "popd failed"
656 fi
657 unset BUILDDIR
658 done
659
660 if [[ "${default_function}" == "1" ]]; then
661 unset -f python_default_function
662 fi
663}
664
665# @FUNCTION: python_copy_sources
666# @USAGE: <directory="${S}"> [directory]
667# @DESCRIPTION:
668# Copy unpacked sources of current package to separate build directory for each Python ABI.
669python_copy_sources() {
670 if ! _python_package_supporting_installation_for_multiple_python_abis; then
671 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
672 fi
673
674 local dir dirs=() PYTHON_ABI
675
676 if [[ "$#" -eq 0 ]]; then
677 if [[ "${WORKDIR}" == "${S}" ]]; then
678 die "${FUNCNAME}() cannot be used"
679 fi
680 dirs=("${S%/}")
681 else
682 dirs=("$@")
683 fi
684
685 validate_PYTHON_ABIS
686 for PYTHON_ABI in ${PYTHON_ABIS}; do
687 for dir in "${dirs[@]}"; do
688 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
689 done
690 done
691}
692
693# @FUNCTION: python_generate_wrapper_scripts
694# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files]
695# @DESCRIPTION:
696# Generate wrapper scripts. Existing files are overwritten only with --force option.
697# If --respect-EPYTHON option is specified, then generated wrapper scripts will
698# respect EPYTHON variable at run time.
699python_generate_wrapper_scripts() {
700 if ! _python_package_supporting_installation_for_multiple_python_abis; then
701 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
702 fi
703
704 _python_initialize_prefix_variables
705
706 local eselect_python_option file force="0" quiet="0" PYTHON_ABI python2_enabled="0" python3_enabled="0" respect_EPYTHON="0"
707
708 while (($#)); do
709 case "$1" in
710 -E|--respect-EPYTHON)
711 respect_EPYTHON="1"
712 ;;
713 -f|--force)
714 force="1"
715 ;;
716 -q|--quiet)
717 quiet="1"
718 ;;
719 --)
720 shift
721 break
722 ;;
723 -*)
724 die "${FUNCNAME}(): Unrecognized option '$1'"
725 ;;
726 *)
727 break
728 ;;
729 esac
730 shift
731 done
732
733 if [[ "$#" -eq 0 ]]; then
734 die "${FUNCNAME}(): Missing arguments"
735 fi
736
737 validate_PYTHON_ABIS
738 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do
739 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
740 python2_enabled="1"
741 fi
742 done
743 for PYTHON_ABI in "${_CPYTHON3_SUPPORTED_ABIS[@]}"; do
744 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
745 python3_enabled="1"
746 fi
747 done
748
749 if [[ "${python2_enabled}" == "1" && "${python3_enabled}" == "1" ]]; then
750 eselect_python_option=
751 elif [[ "${python2_enabled}" == "1" && "${python3_enabled}" == "0" ]]; then
752 eselect_python_option="--python2"
753 elif [[ "${python2_enabled}" == "0" && "${python3_enabled}" == "1" ]]; then
754 eselect_python_option="--python3"
755 else
756 die "${FUNCNAME}(): Unsupported environment"
757 fi
758
759 for file in "$@"; do
760 if [[ -f "${file}" && "${force}" == "0" ]]; then
761 die "${FUNCNAME}(): '$1' already exists"
762 fi
763
764 if [[ "${quiet}" == "0" ]]; then
765 einfo "Generating '${file#${ED%/}}' wrapper script"
766 fi
767
768 cat << EOF > "${file}"
769#!/usr/bin/env python
770# Gentoo '${file##*/}' wrapper script generated by python_generate_wrapper_scripts()
771
772import os
773import re
774import subprocess
775import sys
776
777EPYTHON_re = re.compile(r"^python(\d+\.\d+)$")
778python_shebang_re = re.compile(r"^#! *(${EPREFIX}/usr/bin/python|(${EPREFIX})?/usr/bin/env +(${EPREFIX}/usr/bin/)?python)")
779python_verification_output_re = re.compile("^GENTOO_PYTHON_TARGET_SCRIPT_PATH supported\n$")
780
781EOF
782 if [[ "$?" != "0" ]]; then
783 die "${FUNCNAME}(): Generation of '$1' failed"
784 fi
785 if [[ "${respect_EPYTHON}" == "1" ]]; then
786 cat << EOF >> "${file}"
787EPYTHON = os.environ.get("EPYTHON")
788if EPYTHON:
789 EPYTHON_matched = EPYTHON_re.match(EPYTHON)
790 if EPYTHON_matched:
791 PYTHON_ABI = EPYTHON_matched.group(1)
792 else:
793 sys.stderr.write("EPYTHON variable has unrecognized value '%s'\n" % EPYTHON)
794 sys.exit(1)
795else:
796 try:
797 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE)
798 if eselect_process.wait() != 0:
799 raise ValueError
800 except (OSError, ValueError):
801 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
802 sys.exit(1)
803
804 EPYTHON = eselect_process.stdout.read()
805 if not isinstance(EPYTHON, str):
806 # Python 3
807 EPYTHON = EPYTHON.decode()
808 EPYTHON = EPYTHON.rstrip("\n")
809
810 EPYTHON_matched = EPYTHON_re.match(EPYTHON)
811 if EPYTHON_matched:
812 PYTHON_ABI = EPYTHON_matched.group(1)
813 else:
814 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
815 sys.exit(1)
816EOF
817 if [[ "$?" != "0" ]]; then
818 die "${FUNCNAME}(): Generation of '$1' failed"
819 fi
820 else
821 cat << EOF >> "${file}"
822try:
823 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE)
824 if eselect_process.wait() != 0:
825 raise ValueError
826except (OSError, ValueError):
827 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
828 sys.exit(1)
829
830EPYTHON = eselect_process.stdout.read()
831if not isinstance(EPYTHON, str):
832 # Python 3
833 EPYTHON = EPYTHON.decode()
834EPYTHON = EPYTHON.rstrip("\n")
835
836EPYTHON_matched = EPYTHON_re.match(EPYTHON)
837if EPYTHON_matched:
838 PYTHON_ABI = EPYTHON_matched.group(1)
839else:
840 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
841 sys.exit(1)
842EOF
843 if [[ "$?" != "0" ]]; then
844 die "${FUNCNAME}(): Generation of '$1' failed"
845 fi
846 fi
847 cat << EOF >> "${file}"
848
849wrapper_script_path = os.path.realpath(sys.argv[0])
850target_executable_path = "%s-%s" % (wrapper_script_path, PYTHON_ABI)
851os.environ["GENTOO_PYTHON_PROCESS_NAME"] = os.path.basename(sys.argv[0])
852os.environ["GENTOO_PYTHON_WRAPPER_SCRIPT_PATH"] = sys.argv[0]
853os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH"] = target_executable_path
854if not os.path.exists(target_executable_path):
855 sys.stderr.write("'%s' does not exist\n" % target_executable_path)
856 sys.exit(1)
857
858target_executable = open(target_executable_path, "rb")
859target_executable_first_line = target_executable.readline()
860if not isinstance(target_executable_first_line, str):
861 # Python 3
862 target_executable_first_line = target_executable_first_line.decode("utf_8", "replace")
863
864python_shebang_matched = python_shebang_re.match(target_executable_first_line)
865target_executable.close()
866
867if python_shebang_matched:
868 try:
869 python_interpreter_path = "${EPREFIX}/usr/bin/%s" % EPYTHON
870 os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"] = "1"
871 python_verification_process = subprocess.Popen([python_interpreter_path, "-c", "pass"], stdout=subprocess.PIPE)
872 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
873 if python_verification_process.wait() != 0:
874 raise ValueError
875
876 python_verification_output = python_verification_process.stdout.read()
877 if not isinstance(python_verification_output, str):
878 # Python 3
879 python_verification_output = python_verification_output.decode()
880
881 if not python_verification_output_re.match(python_verification_output):
882 raise ValueError
883
884 os.execv(python_interpreter_path, [python_interpreter_path] + sys.argv)
885 except:
886 pass
887 if "GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION" in os.environ:
888 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
889
890os.execv(target_executable_path, sys.argv)
891EOF
892 if [[ "$?" != "0" ]]; then
893 die "${FUNCNAME}(): Generation of '$1' failed"
894 fi
895 fperms +x "${file#${ED%/}}" || die "fperms '${file}' failed"
896 done
897}
898
899# ================================================================================================
900# ========= FUNCTIONS FOR PACKAGES NOT SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ==========
901# ================================================================================================
902
903# @FUNCTION: python_set_active_version
904# @USAGE: <CPython_ABI|2|3>
905# @DESCRIPTION:
906# Set specified version of CPython as active version of Python.
907python_set_active_version() {
908 if _python_package_supporting_installation_for_multiple_python_abis; then
909 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
910 fi
911
912 if [[ "$#" -ne 1 ]]; then
913 die "${FUNCNAME}() requires 1 argument"
914 fi
915
916 _python_initial_sanity_checks
917
918 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
919 if ! _python_implementation && ! has_version "dev-lang/python:$1"; then
920 die "${FUNCNAME}(): 'dev-lang/python:$1' is not installed"
921 fi
922 export EPYTHON="$(PYTHON "$1")"
923 elif [[ "$1" == "2" ]]; then
924 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then
925 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed"
926 fi
927 export EPYTHON="$(PYTHON -2)"
928 elif [[ "$1" == "3" ]]; then
929 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then
930 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed"
931 fi
932 export EPYTHON="$(PYTHON -3)"
933 else
934 die "${FUNCNAME}(): Unrecognized argument '$1'"
935 fi
936
937 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses,
938 # so it does not need to be exported to subprocesses.
939 PYTHON_ABI="${EPYTHON#python}"
940 PYTHON_ABI="${PYTHON_ABI%%-*}"
941
942 _python_final_sanity_checks
943
944 # python-updater checks PYTHON_REQUESTED_ACTIVE_VERSION variable.
945 PYTHON_REQUESTED_ACTIVE_VERSION="$1"
946}
947
948# @FUNCTION: python_need_rebuild
949# @DESCRIPTION: Mark current package for rebuilding by python-updater after
950# switching of active version of Python.
951python_need_rebuild() {
952 if _python_package_supporting_installation_for_multiple_python_abis; then
953 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
954 fi
955
956 export PYTHON_NEED_REBUILD="$(PYTHON --ABI)"
957}
958
959# ================================================================================================
960# ======================================= GETTER FUNCTIONS =======================================
961# ================================================================================================
962
963_PYTHON_ABI_EXTRACTION_COMMAND='import platform
964import sys
965sys.stdout.write(".".join(str(x) for x in sys.version_info[:2]))
966if platform.system()[:4] == "Java":
967 sys.stdout.write("-jython")'
968
969_python_get_implementation() {
970 if [[ "$#" -ne 1 ]]; then
971 die "${FUNCNAME}() requires 1 argument"
972 fi
973
974 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
975 echo "CPython"
976 elif [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+-jython$ ]]; then
977 echo "Jython"
978 else
979 die "${FUNCNAME}(): Unrecognized Python ABI '$1'"
980 fi
981}
982
983# @FUNCTION: PYTHON
984# @USAGE: [-2] [-3] [--ABI] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}">
985# @DESCRIPTION:
986# Print filename of Python interpreter for specified Python ABI. If Python_ABI argument
987# is ommitted, then PYTHON_ABI environment variable must be set and is used.
988# If -2 option is specified, then active version of Python 2 is used.
989# If -3 option is specified, then active version of Python 3 is used.
990# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
991# -2, -3 and --final-ABI options and Python_ABI argument cannot be specified simultaneously.
992# If --ABI option is specified, then only specified Python ABI is printed instead of
993# filename of Python interpreter.
994# If --absolute-path option is specified, then absolute path to Python interpreter is printed.
995# --ABI and --absolute-path options cannot be specified simultaneously.
996PYTHON() {
997 local ABI_output="0" absolute_path_output="0" final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" python_interpreter python2="0" python3="0"
998
999 while (($#)); do
1000 case "$1" in
1001 -2)
1002 python2="1"
1003 ;;
1004 -3)
1005 python3="1"
1006 ;;
1007 --ABI)
1008 ABI_output="1"
1009 ;;
1010 -a|--absolute-path)
1011 absolute_path_output="1"
1012 ;;
1013 -f|--final-ABI)
1014 final_ABI="1"
1015 ;;
1016 --)
1017 shift
1018 break
1019 ;;
1020 -*)
1021 die "${FUNCNAME}(): Unrecognized option '$1'"
1022 ;;
1023 *)
1024 break
1025 ;;
1026 esac
1027 shift
1028 done
1029
1030 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then
1031 die "${FUNCNAME}(): '--ABI and '--absolute-path' options cannot be specified simultaneously"
1032 fi
1033
1034 if [[ "$((${python2} + ${python3} + ${final_ABI}))" -gt 1 ]]; then
1035 die "${FUNCNAME}(): '-2', '-3' or '--final-ABI' options cannot be specified simultaneously"
1036 fi
1037
1038 if [[ "$#" -eq 0 ]]; then
1039 if [[ "${final_ABI}" == "1" ]]; then
1040 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1041 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1042 fi
1043 validate_PYTHON_ABIS
1044 PYTHON_ABI="${PYTHON_ABIS##* }"
1045 elif [[ "${python2}" == "1" ]]; then
1046 PYTHON_ABI="$(eselect python show --python2 --ABI)"
1047 if [[ -z "${PYTHON_ABI}" ]]; then
1048 die "${FUNCNAME}(): Active Python 2 interpreter not set"
1049 elif [[ "${PYTHON_ABI}" != "2."* ]]; then
1050 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`"
1051 fi
1052 elif [[ "${python3}" == "1" ]]; then
1053 PYTHON_ABI="$(eselect python show --python3 --ABI)"
1054 if [[ -z "${PYTHON_ABI}" ]]; then
1055 die "${FUNCNAME}(): Active Python 3 interpreter not set"
1056 elif [[ "${PYTHON_ABI}" != "3."* ]]; then
1057 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`"
1058 fi
1059 elif ! _python_package_supporting_installation_for_multiple_python_abis; then
1060 PYTHON_ABI="$("${EPREFIX}/usr/bin/python" -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")"
1061 elif [[ -z "${PYTHON_ABI}" ]]; then
1062 die "${FUNCNAME}(): Invalid usage: ${FUNCNAME}() should be used in ABI-specific local scope"
1063 fi
1064 elif [[ "$#" -eq 1 ]]; then
1065 if [[ "${final_ABI}" == "1" ]]; then
1066 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously"
1067 fi
1068 if [[ "${python2}" == "1" ]]; then
1069 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously"
1070 fi
1071 if [[ "${python3}" == "1" ]]; then
1072 die "${FUNCNAME}(): '-3' option and Python ABI cannot be specified simultaneously"
1073 fi
1074 PYTHON_ABI="$1"
1075 else
1076 die "${FUNCNAME}(): Invalid usage"
1077 fi
1078
1079 if [[ "${ABI_output}" == "1" ]]; then
1080 echo -n "${PYTHON_ABI}"
1081 return
1082 else
1083 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1084 python_interpreter="python${PYTHON_ABI}"
1085 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1086 python_interpreter="jython-${PYTHON_ABI%-jython}"
1087 fi
1088
1089 if [[ "${absolute_path_output}" == "1" ]]; then
1090 echo -n "${EPREFIX}/usr/bin/${python_interpreter}"
1091 else
1092 echo -n "${python_interpreter}"
1093 fi
1094 fi
1095
1096 if [[ -n "${ABI}" && "${ABI}" != "${DEFAULT_ABI}" && "${DEFAULT_ABI}" != "default" ]]; then
1097 echo -n "-${ABI}"
1098 fi
1099}
1100
1101# @FUNCTION: python_get_implementation
1102# @USAGE: [-f|--final-ABI]
1103# @DESCRIPTION:
1104# Print name of Python implementation.
1105# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1106python_get_implementation() {
1107 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1108
1109 while (($#)); do
1110 case "$1" in
1111 -f|--final-ABI)
1112 final_ABI="1"
1113 ;;
1114 -*)
1115 die "${FUNCNAME}(): Unrecognized option '$1'"
1116 ;;
1117 *)
1118 die "${FUNCNAME}(): Invalid usage"
1119 ;;
1120 esac
1121 shift
1122 done
1123
1124 if [[ "${final_ABI}" == "1" ]]; then
1125 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1126 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1127 fi
1128 PYTHON_ABI="$(PYTHON -f --ABI)"
1129 elif [[ -z "${PYTHON_ABI}" ]]; then
1130 PYTHON_ABI="$(PYTHON --ABI)"
1131 fi
1132
1133 echo "$(_python_get_implementation "${PYTHON_ABI}")"
1134}
1135
1136# @FUNCTION: python_get_implementational_package
1137# @USAGE: [-f|--final-ABI]
1138# @DESCRIPTION:
1139# Print category, name and slot of package providing Python implementation.
1140# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1141python_get_implementational_package() {
1142 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1143
1144 while (($#)); do
1145 case "$1" in
1146 -f|--final-ABI)
1147 final_ABI="1"
1148 ;;
1149 -*)
1150 die "${FUNCNAME}(): Unrecognized option '$1'"
1151 ;;
1152 *)
1153 die "${FUNCNAME}(): Invalid usage"
1154 ;;
1155 esac
1156 shift
1157 done
1158
1159 if [[ "${final_ABI}" == "1" ]]; then
1160 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1161 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1162 fi
1163 PYTHON_ABI="$(PYTHON -f --ABI)"
1164 elif [[ -z "${PYTHON_ABI}" ]]; then
1165 PYTHON_ABI="$(PYTHON --ABI)"
1166 fi
1167
1168 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1169 echo "dev-lang/python:${PYTHON_ABI}"
1170 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1171 echo "dev-java/jython:${PYTHON_ABI%-jython}"
1172 fi
1173}
1174
1175# @FUNCTION: python_get_includedir
1176# @USAGE: [-f|--final-ABI]
1177# @DESCRIPTION:
1178# Print path to Python include directory.
1179# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1180python_get_includedir() {
1181 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1182
1183 while (($#)); do
1184 case "$1" in
1185 -f|--final-ABI)
1186 final_ABI="1"
1187 ;;
1188 -*)
1189 die "${FUNCNAME}(): Unrecognized option '$1'"
1190 ;;
1191 *)
1192 die "${FUNCNAME}(): Invalid usage"
1193 ;;
1194 esac
1195 shift
1196 done
1197
1198 if [[ "${final_ABI}" == "1" ]]; then
1199 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1200 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1201 fi
1202 PYTHON_ABI="$(PYTHON -f --ABI)"
1203 elif [[ -z "${PYTHON_ABI}" ]]; then
1204 PYTHON_ABI="$(PYTHON --ABI)"
1205 fi
1206
1207 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1208 echo "/usr/include/python${PYTHON_ABI}"
1209 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1210 echo "/usr/share/jython-${PYTHON_ABI%-jython}/Include"
1211 fi
1212}
1213
1214# @FUNCTION: python_get_libdir
1215# @USAGE: [-f|--final-ABI]
1216# @DESCRIPTION:
1217# Print path to Python library directory.
1218# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1219python_get_libdir() {
1220 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1221
1222 while (($#)); do
1223 case "$1" in
1224 -f|--final-ABI)
1225 final_ABI="1"
1226 ;;
1227 -*)
1228 die "${FUNCNAME}(): Unrecognized option '$1'"
1229 ;;
1230 *)
1231 die "${FUNCNAME}(): Invalid usage"
1232 ;;
1233 esac
1234 shift
1235 done
1236
1237 if [[ "${final_ABI}" == "1" ]]; then
1238 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1239 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1240 fi
1241 PYTHON_ABI="$(PYTHON -f --ABI)"
1242 elif [[ -z "${PYTHON_ABI}" ]]; then
1243 PYTHON_ABI="$(PYTHON --ABI)"
1244 fi
1245
1246 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1247 echo "/usr/$(get_libdir)/python${PYTHON_ABI}"
1248 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1249 echo "/usr/share/jython-${PYTHON_ABI%-jython}/Lib"
1250 fi
1251}
1252
1253# @FUNCTION: python_get_sitedir
1254# @USAGE: [-f|--final-ABI]
1255# @DESCRIPTION:
1256# Print path to Python site-packages directory.
1257# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1258python_get_sitedir() {
1259 local options=()
1260
1261 while (($#)); do
1262 case "$1" in
1263 -f|--final-ABI)
1264 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1265 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1266 fi
1267 options+=("$1")
1268 ;;
1269 -*)
1270 die "${FUNCNAME}(): Unrecognized option '$1'"
1271 ;;
1272 *)
1273 die "${FUNCNAME}(): Invalid usage"
1274 ;;
1275 esac
1276 shift
1277 done
1278
1279 echo "$(python_get_libdir "${options[@]}")/site-packages"
1280}
1281
1282# @FUNCTION: python_get_library
1283# @USAGE: [-f|--final-ABI] [-l|--linker-option]
1284# @DESCRIPTION:
1285# Print path to Python library.
1286# If --linker-option is specified, then "-l${library}" linker option is printed.
1287# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1288python_get_library() {
1289 local final_ABI="0" linker_option="0" PYTHON_ABI="${PYTHON_ABI}"
1290
1291 while (($#)); do
1292 case "$1" in
1293 -f|--final-ABI)
1294 final_ABI="1"
1295 ;;
1296 -l|--linker-option)
1297 linker_option="1"
1298 ;;
1299 -*)
1300 die "${FUNCNAME}(): Unrecognized option '$1'"
1301 ;;
1302 *)
1303 die "${FUNCNAME}(): Invalid usage"
1304 ;;
1305 esac
1306 shift
1307 done
1308
1309 if [[ "${final_ABI}" == "1" ]]; then
1310 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1311 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1312 fi
1313 PYTHON_ABI="$(PYTHON -f --ABI)"
1314 elif [[ -z "${PYTHON_ABI}" ]]; then
1315 PYTHON_ABI="$(PYTHON --ABI)"
1316 fi
1317
1318 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1319 if [[ "${linker_option}" == "1" ]]; then
1320 echo "-lpython${PYTHON_ABI}"
1321 else
1322 echo "/usr/$(get_libdir)/libpython${PYTHON_ABI}$(get_libname)"
1323 fi
1324 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1325 die "${FUNCNAME}(): Jython does not have shared library"
1326 fi
1327}
1328
1329# @FUNCTION: python_get_version
1330# @USAGE: [-f|--final-ABI] [--full] [--major] [--minor] [--micro]
1331# @DESCRIPTION:
1332# Print Python version.
1333# --full, --major, --minor and --micro options cannot be specified simultaneously.
1334# If --full, --major, --minor and --micro options are not specified, then "${major_version}.${minor_version}" is printed.
1335# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1336python_get_version() {
1337 local final_ABI="0" full="0" major="0" minor="0" micro="0" python_command
1338
1339 while (($#)); do
1340 case "$1" in
1341 -f|--final-ABI)
1342 final_ABI="1"
1343 ;;
1344 --full)
1345 full="1"
1346 ;;
1347 --major)
1348 major="1"
1349 ;;
1350 --minor)
1351 minor="1"
1352 ;;
1353 --micro)
1354 micro="1"
1355 ;;
1356 -*)
1357 die "${FUNCNAME}(): Unrecognized option '$1'"
1358 ;;
1359 *)
1360 die "${FUNCNAME}(): Invalid usage"
1361 ;;
1362 esac
1363 shift
1364 done
1365
1366 if [[ "$((${full} + ${major} + ${minor} + ${micro}))" -gt 1 ]]; then
1367 die "${FUNCNAME}(): '--full', '--major', '--minor' or '--micro' options cannot be specified simultaneously"
1368 fi
1369
1370 if [[ "${full}" == "1" ]]; then
1371 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:3]))"
1372 elif [[ "${major}" == "1" ]]; then
1373 python_command="from sys import version_info; print(version_info[0])"
1374 elif [[ "${minor}" == "1" ]]; then
1375 python_command="from sys import version_info; print(version_info[1])"
1376 elif [[ "${micro}" == "1" ]]; then
1377 python_command="from sys import version_info; print(version_info[2])"
1378 else
1379 if [[ -n "${PYTHON_ABI}" && "${final_ABI}" == "0" ]]; then
1380 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1381 echo "${PYTHON_ABI}"
1382 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1383 echo "${PYTHON_ABI%-jython}"
1384 fi
1385 return
1386 fi
1387 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:2]))"
1388 fi
1389
1390 if [[ "${final_ABI}" == "1" ]]; then
1391 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1392 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1393 fi
1394 "$(PYTHON -f)" -c "${python_command}"
1395 else
1396 "$(PYTHON ${PYTHON_ABI})" -c "${python_command}"
1397 fi
1398}
1399
1400# ================================================================================================
1401# =================================== MISCELLANEOUS FUNCTIONS ====================================
1402# ================================================================================================
1403
1404_python_implementation() {
1405 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then
1406 return 0
1407 elif [[ "${CATEGORY}/${PN}" == "dev-java/jython" ]]; then
1408 return 0
1409 else
1410 return 1
1411 fi
1412}
1413
1414_python_package_supporting_installation_for_multiple_python_abis() {
1415 if [[ "${EBUILD_PHASE}" == "depend" ]]; then
1416 die "${FUNCNAME}() cannot be used in global scope"
1417 fi
1418
1419 if has "${EAPI:-0}" 0 1 2 3 4; then
1420 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
1421 return 0
1422 else
1423 return 1
1424 fi
1425 else
1426 die "${FUNCNAME}(): Support for EAPI=\"${EAPI}\" not implemented"
1427 fi
1428}
1429
1430_python_initialize_prefix_variables() {
1431 if has "${EAPI:-0}" 0 1 2; then
1432 if [[ -n "${ROOT}" && -z "${EROOT}" ]]; then
1433 EROOT="${ROOT%/}${EPREFIX}/"
1434 fi
1435 if [[ -n "${D}" && -z "${ED}" ]]; then
1436 ED="${D%/}${EPREFIX}/"
1437 fi
1438 fi
1439}
1440
1441unset PYTHON_SANITY_CHECKS
1442
1443_python_initial_sanity_checks() {
1444 if [[ "$(declare -p PYTHON_SANITY_CHECKS 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS="* ]]; then
1445 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
1446 if [[ "$(readlink "${EPREFIX}/usr/bin/python")" != "python-wrapper" ]]; then
1447 eerror "'${EPREFIX}/usr/bin/python' is not valid symlink."
1448 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
1449 die "'${EPREFIX}/usr/bin/python' is not valid symlink"
1450 fi
1451 if [[ "$(<"${EPREFIX}/usr/bin/python-config")" != *"Gentoo python-config wrapper script"* ]]; then
1452 eerror "'${EPREFIX}/usr/bin/python-config' is not valid script"
1453 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
1454 die "'${EPREFIX}/usr/bin/python-config' is not valid script"
1455 fi
1456 fi
1457}
1458
1459_python_final_sanity_checks() {
1460 if ! _python_implementation && [[ "$(declare -p PYTHON_SANITY_CHECKS 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS="* ]]; then
1461 local PYTHON_ABI="${PYTHON_ABI}"
1462 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI}}; do
1463 # Ensure that appropriate version of Python is installed.
1464 if ! has_version "$(python_get_implementational_package)"; then
1465 die "$(python_get_implementational_package) is not installed"
1466 fi
1467
1468 # Ensure that EPYTHON variable is respected.
1469 if [[ "$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")" != "${PYTHON_ABI}" ]]; then
1470 eerror "python: '$(type -p python)'"
1471 eerror "ABI: '${ABI}'"
1472 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
1473 eerror "EPYTHON: '$(PYTHON)'"
1474 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
1475 eerror "Version of enabled Python: '$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")'"
1476 die "'python' does not respect EPYTHON variable"
1477 fi
1478 done
1479 fi
1480 PYTHON_SANITY_CHECKS="1"
1481}
1482
1483_python_set_color_variables() {
1484 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
1485 _BOLD=$'\e[1m'
1486 _RED=$'\e[1;31m'
1487 _GREEN=$'\e[1;32m'
1488 _BLUE=$'\e[1;34m'
1489 _CYAN=$'\e[1;36m'
1490 _NORMAL=$'\e[0m'
1491 else
1492 _BOLD=
1493 _RED=
1494 _GREEN=
1495 _BLUE=
1496 _CYAN=
1497 _NORMAL=
1498 fi
1499}
1500
1501# @FUNCTION: python_convert_shebangs
1502# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_version> <file|directory> [files|directories]
1503# @DESCRIPTION:
1504# Convert shebangs in specified files. Directories can be specified only with --recursive option.
1505python_convert_shebangs() {
1506 local argument file files=() only_executables="0" python_version quiet="0" recursive="0"
1507
1508 while (($#)); do
1509 case "$1" in
1510 -r|--recursive)
1511 recursive="1"
1512 ;;
1513 -q|--quiet)
1514 quiet="1"
1515 ;;
1516 -x|--only-executables)
1517 only_executables="1"
1518 ;;
1519 --)
1520 shift
1521 break
1522 ;;
1523 -*)
1524 die "${FUNCNAME}(): Unrecognized option '$1'"
1525 ;;
1526 *)
1527 break
1528 ;;
1529 esac
1530 shift
1531 done
1532
1533 if [[ "$#" -eq 0 ]]; then
1534 die "${FUNCNAME}(): Missing Python version and files or directories"
1535 elif [[ "$#" -eq 1 ]]; then
1536 die "${FUNCNAME}(): Missing files or directories"
1537 fi
1538
1539 python_version="$1"
1540 shift
1541
1542 for argument in "$@"; do
1543 if [[ ! -e "${argument}" ]]; then
1544 die "${FUNCNAME}(): '${argument}' does not exist"
1545 elif [[ -f "${argument}" ]]; then
1546 files+=("${argument}")
1547 elif [[ -d "${argument}" ]]; then
1548 if [[ "${recursive}" == "1" ]]; then
1549 while read -d $'\0' -r file; do
1550 files+=("${file}")
1551 done < <(find "${argument}" $([[ "${only_executables}" == "1" ]] && echo -perm /111) -type f -print0)
1552 else
1553 die "${FUNCNAME}(): '${argument}' is not a regular file"
1554 fi
1555 else
1556 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory"
1557 fi
1558 done
1559
1560 for file in "${files[@]}"; do
1561 file="${file#./}"
1562 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
1563
1564 if [[ "$(head -n1 "${file}")" =~ ^'#!'.*python ]]; then
1565 [[ "$(sed -ne "2p" "${file}")" =~ ^"# Gentoo '".*"' wrapper script generated by python_generate_wrapper_scripts()"$ ]] && continue
1566
1567 if [[ "${quiet}" == "0" ]]; then
1568 einfo "Converting shebang in '${file}'"
1569 fi
1570
1571 sed -e "1s/python\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?/python${python_version}/" -i "${file}" || die "Conversion of shebang in '${file}' failed"
1572
1573 # Delete potential whitespace after "#!".
1574 sed -e '1s/\(^#!\)[[:space:]]*/\1/' -i "${file}" || die "sed '${file}' failed"
1575 fi
1576 done
1577}
1578
1579# @FUNCTION: python_clean_sitedirs
1580# @DESCRIPTION:
1581# Delete needless files in site-packages directories in ${ED}.
1582python_clean_sitedirs() {
1583 _python_initialize_prefix_variables
1584
1585 find "${ED}"usr/$(get_libdir)/python*/site-packages "(" -name "*.c" -o -name "*.h" -o -name "*.la" ")" -type f -print0 | xargs -0 rm -f
1586}
1587
1588# ================================================================================================
1589# ================================ FUNCTIONS FOR RUNNING OF TESTS ================================
1590# ================================================================================================
1591
1592# @ECLASS-VARIABLE: PYTHON_TEST_VERBOSITY
1593# @DESCRIPTION:
1594# User-configurable verbosity of tests of Python modules.
1595# Supported values: 0, 1, 2, 3, 4.
1596PYTHON_TEST_VERBOSITY="${PYTHON_TEST_VERBOSITY:-1}"
1597
1598_python_test_hook() {
1599 if [[ "$#" -ne 1 ]]; then
1600 die "${FUNCNAME}() requires 1 argument"
1601 fi
1602
1603 if _python_package_supporting_installation_for_multiple_python_abis && [[ "$(type -t "${FUNCNAME[3]}_$1_hook")" == "function" ]]; then
1604 "${FUNCNAME[3]}_$1_hook"
1605 fi
1606}
1607
1608# @FUNCTION: python_execute_nosetests
1609# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1610# @DESCRIPTION:
1611# Execute nosetests for all enabled Python ABIs.
1612# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
1613# python_execute_nosetests_pre_hook() and python_execute_nosetests_post_hook(), if they are defined.
1614python_execute_nosetests() {
1615 _python_set_color_variables
1616
1617 local PYTHONPATH_template= separate_build_dirs=
1618
1619 while (($#)); do
1620 case "$1" in
1621 -P|--PYTHONPATH)
1622 PYTHONPATH_template="$2"
1623 shift
1624 ;;
1625 -s|--separate-build-dirs)
1626 separate_build_dirs="1"
1627 ;;
1628 --)
1629 shift
1630 break
1631 ;;
1632 -*)
1633 die "${FUNCNAME}(): Unrecognized option '$1'"
1634 ;;
1635 *)
1636 break
1637 ;;
1638 esac
1639 shift
1640 done
1641
1642 python_test_function() {
1643 local evaluated_PYTHONPATH=
1644
1645 if [[ -n "${PYTHONPATH_template}" ]]; then
1646 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")"
1647 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then
1648 unset evaluated_PYTHONPATH
1649 fi
1650 fi
1651
1652 _python_test_hook pre
1653
1654 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1655 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1656 PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1657 else
1658 echo ${_BOLD}nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1659 nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1660 fi
1661
1662 _python_test_hook post
1663 }
1664 if _python_package_supporting_installation_for_multiple_python_abis; then
1665 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1666 else
1667 if [[ -n "${separate_build_dirs}" ]]; then
1668 die "${FUNCNAME}(): Invalid usage"
1669 fi
1670 python_test_function "$@" || die "Testing failed"
1671 fi
1672
1673 unset -f python_test_function
1674}
1675
1676# @FUNCTION: python_execute_py.test
1677# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1678# @DESCRIPTION:
1679# Execute py.test for all enabled Python ABIs.
1680# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
1681# python_execute_py.test_pre_hook() and python_execute_py.test_post_hook(), if they are defined.
1682python_execute_py.test() {
1683 _python_set_color_variables
1684
1685 local PYTHONPATH_template= separate_build_dirs=
1686
1687 while (($#)); do
1688 case "$1" in
1689 -P|--PYTHONPATH)
1690 PYTHONPATH_template="$2"
1691 shift
1692 ;;
1693 -s|--separate-build-dirs)
1694 separate_build_dirs="1"
1695 ;;
1696 --)
1697 shift
1698 break
1699 ;;
1700 -*)
1701 die "${FUNCNAME}(): Unrecognized option '$1'"
1702 ;;
1703 *)
1704 break
1705 ;;
1706 esac
1707 shift
1708 done
1709
1710 python_test_function() {
1711 local evaluated_PYTHONPATH=
1712
1713 if [[ -n "${PYTHONPATH_template}" ]]; then
1714 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")"
1715 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then
1716 unset evaluated_PYTHONPATH
1717 fi
1718 fi
1719
1720 _python_test_hook pre
1721
1722 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1723 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@"${_NORMAL}
1724 PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" || return "$?"
1725 else
1726 echo ${_BOLD}py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@"${_NORMAL}
1727 py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" || return "$?"
1728 fi
1729
1730 _python_test_hook post
1731 }
1732 if _python_package_supporting_installation_for_multiple_python_abis; then
1733 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1734 else
1735 if [[ -n "${separate_build_dirs}" ]]; then
1736 die "${FUNCNAME}(): Invalid usage"
1737 fi
1738 python_test_function "$@" || die "Testing failed"
1739 fi
1740
1741 unset -f python_test_function
1742}
1743
1744# @FUNCTION: python_execute_trial
1745# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1746# @DESCRIPTION:
1747# Execute trial for all enabled Python ABIs.
1748# In ebuilds of packages supporting installation for multiple Python ABIs, this function
1749# calls python_execute_trial_pre_hook() and python_execute_trial_post_hook(), if they are defined.
1750python_execute_trial() {
1751 _python_set_color_variables
1752
1753 local PYTHONPATH_template= separate_build_dirs=
1754
1755 while (($#)); do
1756 case "$1" in
1757 -P|--PYTHONPATH)
1758 PYTHONPATH_template="$2"
1759 shift
1760 ;;
1761 -s|--separate-build-dirs)
1762 separate_build_dirs="1"
1763 ;;
1764 --)
1765 shift
1766 break
1767 ;;
1768 -*)
1769 die "${FUNCNAME}(): Unrecognized option '$1'"
1770 ;;
1771 *)
1772 break
1773 ;;
1774 esac
1775 shift
1776 done
1777
1778 python_test_function() {
1779 local evaluated_PYTHONPATH=
1780
1781 if [[ -n "${PYTHONPATH_template}" ]]; then
1782 evaluated_PYTHONPATH="$(eval echo -n "${PYTHONPATH_template}")"
1783 if [[ ! -e "${evaluated_PYTHONPATH}" ]]; then
1784 unset evaluated_PYTHONPATH
1785 fi
1786 fi
1787
1788 _python_test_hook pre
1789
1790 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1791 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
1792 PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
1793 else
1794 echo ${_BOLD}trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
1795 trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
1796 fi
1797
1798 _python_test_hook post
1799 }
1800 if _python_package_supporting_installation_for_multiple_python_abis; then
1801 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1802 else
1803 if [[ -n "${separate_build_dirs}" ]]; then
1804 die "${FUNCNAME}(): Invalid usage"
1805 fi
1806 python_test_function "$@" || die "Testing failed"
1807 fi
1808
1809 unset -f python_test_function
1810}
1811
1812# ================================================================================================
1813# ======================= FUNCTIONS FOR HANDLING OF BYTE-COMPILED MODULES ========================
1814# ================================================================================================
1815
1816# @FUNCTION: python_enable_pyc
1817# @DESCRIPTION:
1818# Tell Python to automatically recompile modules to .pyc/.pyo if the
1819# timestamps/version stamps have changed.
1820python_enable_pyc() {
1821 unset PYTHONDONTWRITEBYTECODE
1822}
1823
1824# @FUNCTION: python_disable_pyc
1825# @DESCRIPTION:
1826# Tell Python not to automatically recompile modules to .pyc/.pyo
1827# even if the timestamps/version stamps do not match. This is done
1828# to protect sandbox.
1829python_disable_pyc() {
1830 export PYTHONDONTWRITEBYTECODE="1"
1831}
1832
1833# @FUNCTION: python_mod_optimize
1834# @USAGE: [options] [directory|file]
1835# @DESCRIPTION:
1836# If no arguments supplied, it will recompile not recursively all modules
1837# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages).
4# 1838#
5# Author: Alastair Tse <liquidx@gentoo.org> 1839# If supplied with arguments, it will recompile all modules recursively
1840# in the supplied directory.
6# 1841#
7# A Utility Eclass that should be inherited by anything that deals with 1842# Options passed to this function are passed to compileall.py.
8# Python or Python modules.
9# 1843#
10# - Features: 1844# This function can be used only in pkg_postinst() phase.
11# python_version() - sets PYVER/PYVER_MAJOR/PYVER_MINOR 1845python_mod_optimize() {
12# python_tkinter_exists() - Checks for tkinter support in python 1846 _python_initialize_prefix_variables
13# python_mod_exists() - Checks if a python module exists
14# python_mod_compile() - Compiles a .py file to a .pyc/.pyo
15# python_mod_optimize() - Generates .pyc/.pyo precompiled scripts
16# python_mod_cleanup() - Goes through /usr/lib*/python* to remove
17# orphaned *.pyc *.pyo
18# python_makesym() - Makes /usr/bin/python symlinks
19 1847
20inherit alternatives 1848 # Check if phase is pkg_postinst().
1849 [[ "${EBUILD_PHASE}" != "postinst" ]] && die "${FUNCNAME}() can be used only in pkg_postinst() phase"
21 1850
22ECLASS="python" 1851 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
23INHERITED="$INHERITED $ECLASS" 1852 local dir file options=() other_dirs=() other_files=() previous_PYTHON_ABI="${PYTHON_ABI}" PYTHON_ABI="${PYTHON_ABI}" return_code root site_packages_absolute_dirs=() site_packages_dirs=() site_packages_absolute_files=() site_packages_files=()
24 1853
1854 # Strip trailing slash from ROOT.
1855 root="${EROOT%/}"
1856
1857 # Respect ROOT and options passed to compileall.py.
1858 while (($#)); do
1859 case "$1" in
1860 -l|-f|-q)
1861 options+=("$1")
1862 ;;
1863 -d|-x)
1864 options+=("$1" "$2")
1865 shift
1866 ;;
1867 -*)
1868 ewarn "${FUNCNAME}(): Ignoring option '$1'"
1869 ;;
1870 *)
1871 if ! _python_implementation && [[ "$1" =~ ^"${EPREFIX}"/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
1872 die "${FUNCNAME}() does not support absolute paths of directories/files in site-packages directories"
1873 elif [[ "$1" =~ ^/ ]]; then
1874 if [[ -d "${root}/$1" ]]; then
1875 other_dirs+=("${root}/$1")
1876 elif [[ -f "${root}/$1" ]]; then
1877 other_files+=("${root}/$1")
1878 elif [[ -e "${root}/$1" ]]; then
1879 ewarn "'${root}/$1' is not a file or a directory!"
1880 else
1881 ewarn "'${root}/$1' does not exist!"
1882 fi
1883 else
1884 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI:-$(PYTHON --ABI)}}; do
1885 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
1886 site_packages_dirs+=("$1")
1887 break
1888 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
1889 site_packages_files+=("$1")
1890 break
1891 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
1892 ewarn "'$1' is not a file or a directory!"
1893 else
1894 ewarn "'$1' does not exist!"
1895 fi
1896 done
1897 fi
1898 ;;
1899 esac
1900 shift
1901 done
1902
1903 # Set additional options.
1904 options+=("-q")
1905
1906 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI:-$(PYTHON --ABI)}}; do
1907 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})); then
1908 return_code="0"
1909 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1910 if ((${#site_packages_dirs[@]})); then
1911 for dir in "${site_packages_dirs[@]}"; do
1912 site_packages_absolute_dirs+=("${root}$(python_get_sitedir)/${dir}")
1913 done
1914 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" || return_code="1"
1915 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1916 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" &> /dev/null || return_code="1"
1917 fi
1918 fi
1919 if ((${#site_packages_files[@]})); then
1920 for file in "${site_packages_files[@]}"; do
1921 site_packages_absolute_files+=("${root}$(python_get_sitedir)/${file}")
1922 done
1923 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" || return_code="1"
1924 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1925 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" &> /dev/null || return_code="1"
1926 fi
1927 fi
1928 eend "${return_code}"
1929 fi
1930 unset site_packages_absolute_dirs site_packages_absolute_files
1931 done
1932
1933 # Restore previous value of PYTHON_ABI.
1934 if [[ -n "${previous_PYTHON_ABI}" ]]; then
1935 PYTHON_ABI="${previous_PYTHON_ABI}"
1936 else
1937 unset PYTHON_ABI
1938 fi
1939
1940 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then
1941 return_code="0"
1942 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for $(python_get_implementation) $(python_get_version)"
1943 if ((${#other_dirs[@]})); then
1944 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1"
1945 if [[ "$(_python_get_implementation "${PYTHON_ABI-$(PYTHON --ABI)}")" != "Jython" ]]; then
1946 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
1947 fi
1948 fi
1949 if ((${#other_files[@]})); then
1950 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1"
1951 if [[ "$(_python_get_implementation "${PYTHON_ABI-$(PYTHON --ABI)}")" != "Jython" ]]; then
1952 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1"
1953 fi
1954 fi
1955 eend "${return_code}"
1956 fi
1957 else
1958 local myroot mydirs=() myfiles=() myopts=() return_code="0"
1959
1960 # strip trailing slash
1961 myroot="${EROOT%/}"
1962
1963 # respect ROOT and options passed to compileall.py
1964 while (($#)); do
1965 case "$1" in
1966 -l|-f|-q)
1967 myopts+=("$1")
1968 ;;
1969 -d|-x)
1970 myopts+=("$1" "$2")
1971 shift
1972 ;;
1973 -*)
1974 ewarn "${FUNCNAME}(): Ignoring option '$1'"
1975 ;;
1976 *)
1977 if [[ -d "${myroot}"/$1 ]]; then
1978 mydirs+=("${myroot}/$1")
1979 elif [[ -f "${myroot}"/$1 ]]; then
1980 # Files are passed to python_mod_compile which is ROOT-aware
1981 myfiles+=("$1")
1982 elif [[ -e "${myroot}/$1" ]]; then
1983 ewarn "${myroot}/$1 is not a file or directory!"
1984 else
1985 ewarn "${myroot}/$1 does not exist!"
1986 fi
1987 ;;
1988 esac
1989 shift
1990 done
1991
1992 # set additional opts
1993 myopts+=(-q)
1994
1995 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1996 if ((${#mydirs[@]})); then
1997 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1"
1998 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
1999 fi
2000
2001 if ((${#myfiles[@]})); then
2002 python_mod_compile "${myfiles[@]}"
2003 fi
2004
2005 eend "${return_code}"
2006 fi
2007}
2008
2009# @FUNCTION: python_mod_cleanup
2010# @USAGE: [directory|file]
2011# @DESCRIPTION:
2012# Run with optional arguments, where arguments are Python modules. If none given,
2013# it will look in /usr/lib/python[0-9].[0-9].
25# 2014#
26# name: python_disable/enable_pyc 2015# It will recursively scan all compiled Python modules in the directories and
27# desc: tells python not to automatically recompile modules to .pyc/.pyo 2016# determine if they are orphaned (i.e. their corresponding .py files are missing.)
28# even if the timestamps/version stamps don't match. this is 2017# If they are, then it will remove their corresponding .pyc and .pyo files.
29# done to protect sandbox.
30# 2018#
31# note: supported by >=dev-lang/python-2.2.3-r3 only. 2019# This function can be used only in pkg_postrm() phase.
2020python_mod_cleanup() {
2021 _python_initialize_prefix_variables
2022 _python_set_color_variables
2023
2024 local path py_file PYTHON_ABI="${PYTHON_ABI}" SEARCH_PATH=() root
2025
2026 # Check if phase is pkg_postrm().
2027 [[ "${EBUILD_PHASE}" != "postrm" ]] && die "${FUNCNAME}() can be used only in pkg_postrm() phase"
2028
2029 # Strip trailing slash from ROOT.
2030 root="${EROOT%/}"
2031
2032 if (($#)); then
2033 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2034 while (($#)); do
2035 if ! _python_implementation && [[ "$1" =~ ^"${EPREFIX}"/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
2036 die "${FUNCNAME}() does not support absolute paths of directories/files in site-packages directories"
2037 elif [[ "$1" =~ ^/ ]]; then
2038 SEARCH_PATH+=("${root}/${1#/}")
2039 else
2040 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI:-$(PYTHON --ABI)}}; do
2041 SEARCH_PATH+=("${root}$(python_get_sitedir)/$1")
2042 done
2043 fi
2044 shift
2045 done
2046 else
2047 SEARCH_PATH=("${@#/}")
2048 SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}")
2049 fi
2050 else
2051 local dir sitedir
2052 for dir in "${root}"/usr/lib*; do
2053 if [[ -d "${dir}" && ! -L "${dir}" ]]; then
2054 for sitedir in "${dir}"/python*/site-packages; do
2055 if [[ -d "${sitedir}" ]]; then
2056 SEARCH_PATH+=("${sitedir}")
2057 fi
2058 done
2059 fi
2060 done
2061 for sitedir in "${root}"/usr/share/jython-*/Lib/site-packages; do
2062 if [[ -d "${sitedir}" ]]; then
2063 SEARCH_PATH+=("${sitedir}")
2064 fi
2065 done
2066 fi
2067
2068 for path in "${SEARCH_PATH[@]}"; do
2069 if [[ -d "${path}" ]]; then
2070 find "${path}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -print0 | while read -rd ''; do
2071 if [[ "${REPLY}" == *[co] ]]; then
2072 py_file="${REPLY%[co]}"
2073 [[ -f "${py_file}" || (! -f "${py_file}c" && ! -f "${py_file}o") ]] && continue
2074 echo "${_BLUE}<<< ${py_file}[co]${_NORMAL}"
2075 rm -f "${py_file}"[co]
2076 elif [[ "${REPLY}" == *\$py.class ]]; then
2077 py_file="${REPLY%\$py.class}.py"
2078 [[ -f "${py_file}" || ! -f "${py_file%.py}\$py.class" ]] && continue
2079 echo "${_BLUE}<<< ${py_file%.py}\$py.class${_NORMAL}"
2080 rm -f "${py_file%.py}\$py.class"
2081 fi
2082 done
2083
2084 # Attempt to delete directories, which may be empty.
2085 find "${path}" -type d | sort -r | while read -r dir; do
2086 rmdir "${dir}" 2>/dev/null && echo "${_CYAN}<<< ${dir}${_NORMAL}"
2087 done
2088 elif [[ "${path}" == *.py && ! -f "${path}" ]]; then
2089 if [[ (-f "${path}c" || -f "${path}o") ]]; then
2090 echo "${_BLUE}<<< ${path}[co]${_NORMAL}"
2091 rm -f "${path}"[co]
2092 fi
2093 if [[ -f "${path%.py}\$py.class" ]]; then
2094 echo "${_BLUE}<<< ${path%.py}\$py.class${_NORMAL}"
2095 rm -f "${path%.py}\$py.class"
2096 fi
2097 fi
2098 done
2099}
2100
2101# ================================================================================================
2102# ===================================== DEPRECATED FUNCTIONS =====================================
2103# ================================================================================================
2104
2105# @FUNCTION: python_version
2106# @DESCRIPTION:
2107# Run without arguments and it will export the version of python
2108# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
2109python_version() {
2110 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2111 eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
2112 die "${FUNCNAME}() cannot be used in this EAPI"
2113 fi
2114
2115 _python_set_color_variables
2116
2117 if [[ "${FUNCNAME[1]}" != "distutils_python_version" ]]; then
2118 echo
2119 echo " ${_RED}*${_NORMAL} ${_RED}Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01.${_NORMAL}"
2120 echo " ${_RED}*${_NORMAL} ${_RED}Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables.${_NORMAL}"
2121 echo " ${_RED}*${_NORMAL} ${_RED}The ebuild needs to be fixed. Please report a bug, if it has not been already reported.${_NORMAL}"
2122 echo
2123
2124 einfo &> /dev/null
2125 einfo "Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01." &> /dev/null
2126 einfo "Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables." &> /dev/null
2127 einfo "The ebuild needs to be fixed. Please report a bug, if it has not been already reported." &> /dev/null
2128 einfo &> /dev/null
2129 fi
2130
2131 [[ -n "${PYVER}" ]] && return 0
2132 local tmpstr
2133 python="${python:-${EPREFIX}/usr/bin/python}"
2134 tmpstr="$(EPYTHON= ${python} -V 2>&1 )"
2135 export PYVER_ALL="${tmpstr#Python }"
2136 export PYVER_MAJOR="${PYVER_ALL:0:1}"
2137 export PYVER_MINOR="${PYVER_ALL:2:1}"
2138 if [[ "${PYVER_ALL:3:1}" == "." ]]; then
2139 export PYVER_MICRO="${PYVER_ALL:4}"
2140 fi
2141 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
2142}
2143
2144# @FUNCTION: python_mod_exists
2145# @USAGE: <module>
2146# @DESCRIPTION:
2147# Run with the module name as an argument. It will check if a
2148# Python module is installed and loadable. It will return
2149# TRUE(0) if the module exists, and FALSE(1) if the module does
2150# not exist.
32# 2151#
33python_disable_pyc() { 2152# Example:
34 export PYTHON_DONTCOMPILE=1 2153# if python_mod_exists gtk; then
35} 2154# echo "gtk support enabled"
2155# fi
2156python_mod_exists() {
2157 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2158 eerror "Use USE dependencies and/or has_version() instead of ${FUNCNAME}()."
2159 die "${FUNCNAME}() cannot be used in this EAPI"
2160 fi
36 2161
37python_enable_pyc() { 2162 echo
38 unset PYTHON_DONTCOMPILE 2163 echo " ${_RED}*${_NORMAL} ${_RED}Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01.${_NORMAL}"
39} 2164 echo " ${_RED}*${_NORMAL} ${_RED}Use USE dependencies and/or has_version() instead of ${FUNCNAME}().${_NORMAL}"
2165 echo " ${_RED}*${_NORMAL} ${_RED}The ebuild needs to be fixed. Please report a bug, if it has not been already reported.${_NORMAL}"
2166 echo
40 2167
41python_disable_pyc 2168 einfo &> /dev/null
2169 einfo "Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01." &> /dev/null
2170 einfo "Use USE dependencies and/or has_version() instead of ${FUNCNAME}()." &> /dev/null
2171 einfo "The ebuild needs to be fixed. Please report a bug, if it has not been already reported." &> /dev/null
2172 einfo &> /dev/null
42 2173
2174 if [[ "$#" -ne 1 ]]; then
2175 die "${FUNCNAME}() requires 1 argument"
2176 fi
2177 "$(PYTHON ${PYTHON_ABI})" -c "import $1" &> /dev/null
2178}
2179
2180# @FUNCTION: python_tkinter_exists
2181# @DESCRIPTION:
2182# Run without arguments, checks if Python was compiled with Tkinter
2183# support. If not, prints an error message and dies.
2184python_tkinter_exists() {
2185 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
2186 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
2187 die "${FUNCNAME}() cannot be used in this EAPI"
2188 fi
2189
2190 if [[ "${FUNCNAME[1]}" != "distutils_python_tkinter" ]]; then
2191 echo
2192 echo " ${_RED}*${_NORMAL} ${_RED}Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01.${_NORMAL}"
2193 echo " ${_RED}*${_NORMAL} ${_RED}Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}().${_NORMAL}"
2194 echo " ${_RED}*${_NORMAL} ${_RED}The ebuild needs to be fixed. Please report a bug, if it has not been already reported.${_NORMAL}"
2195 echo
2196
2197 einfo &> /dev/null
2198 einfo "Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01." &> /dev/null
2199 einfo "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()." &> /dev/null
2200 einfo "The ebuild needs to be fixed. Please report a bug, if it has not been already reported." &> /dev/null
2201 einfo &> /dev/null
2202 fi
2203
2204 if ! "$(PYTHON ${PYTHON_ABI})" -c "from sys import version_info
2205if version_info[0] == 3:
2206 import tkinter
2207else:
2208 import Tkinter" &> /dev/null; then
2209 eerror "Python needs to be rebuilt with tkinter support enabled."
2210 eerror "Add the following line to '${EPREFIX}/etc/portage/package.use' and rebuild Python"
2211 eerror "dev-lang/python tk"
2212 die "Python installed without support for tkinter"
2213 fi
2214}
2215
2216# @FUNCTION: python_mod_compile
2217# @USAGE: <file> [more files ...]
2218# @DESCRIPTION:
2219# Given filenames, it will pre-compile the module's .pyc and .pyo.
2220# This function can be used only in pkg_postinst() phase.
43# 2221#
44# name: python_version 2222# Example:
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="${PYVER_ALL%.*}"
55 export PYVER_MAJOR="${PYVER%.*}"
56 export PYVER_MINOR="${PYVER##*.}"
57 export PYVER_MICRO="${PYVER_ALL##*.}"
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" "python[0-9].[0-9]"
67 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
68}
69
70#
71# name: python_tkinter_exists
72# desc: run without arguments, checks if python was compiled with Tkinter
73# support. If not, prints an error message and dies.
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 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
97 if ! python -c "import $1" >/dev/null 2>&1; then
98 return 1
99 fi
100 return 0
101}
102
103#
104# name: python_mod_compile
105# desc: given a filename, it will pre-compile the module's .pyc and .pyo.
106# should only be run in pkg_postinst()
107# exam:
108# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 2223# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
109# 2224#
110python_mod_compile() { 2225python_mod_compile() {
111 # allow compiling for older python versions 2226 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis; then
112 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 2227 eerror "Use python_mod_optimize() instead of ${FUNCNAME}()."
113 PYVER=${PYTHON_OVERRIDE_PYVER} 2228 die "${FUNCNAME}() cannot be used in this EAPI"
2229 fi
2230
2231 _python_initialize_prefix_variables
2232
2233 local f myroot myfiles=()
2234
2235 # Check if phase is pkg_postinst()
2236 [[ "${EBUILD_PHASE}" != "postinst" ]] && die "${FUNCNAME}() can be used only in pkg_postinst() phase"
2237
2238 # strip trailing slash
2239 myroot="${EROOT%/}"
2240
2241 # respect ROOT
2242 for f in "$@"; do
2243 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
2244 done
2245
2246 if ((${#myfiles[@]})); then
2247 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}"
2248 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null
114 else 2249 else
115 python_version
116 fi
117
118 if [ -f "$1" ]; then
119 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
120 ewarn "Failed to compile ${1}" 2250 ewarn "No files to compile!"
121 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
122 ewarn "Failed to compile ${1}"
123 else
124 ewarn "Unable to find ${1}"
125 fi
126}
127
128#
129# name: python_mod_optimize
130# desc: if no arguments supplied, it will recompile all modules under
131# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
132# no recursively
133#
134# if supplied with arguments, it will recompile all modules recursively
135# in the supplied directory
136# exam:
137# python_mod_optimize ${ROOT}usr/share/codegen
138#
139python_mod_optimize() {
140 local myroot
141 # strip trailing slash
142 myroot="${ROOT%/}"
143
144 # allow compiling for older python versions
145 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
146 PYVER=${PYTHON_OVERRIDE_PYVER}
147 else
148 python_version
149 fi
150
151 # set opts
152 if [ "${PYVER}" = "2.2" ]; then
153 compileopts=""
154 else
155 compileopts="-q"
156 fi
157
158 ebegin "Byte compiling python modules for python-${PYVER} .."
159 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
160 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
161 eend $?
162}
163
164#
165# name: python_mod_cleanup
166# desc: run with optional arguments, where arguments are directories of
167# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
168#
169# it will recursively scan all compiled python modules in the directories
170# and determine if they are orphaned (eg. their corresponding .py is missing.)
171# if they are, then it will remove their corresponding .pyc and .pyo
172#
173python_mod_cleanup() {
174 local SEARCH_PATH myroot
175
176 # strip trailing slash
177 myroot="${ROOT%/}"
178
179 if [ $# -gt 0 ]; then
180 for path in $@; do
181 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
182 done
183 else
184 for path in ${myroot}/usr/lib*/python*/site-packages; do
185 SEARCH_PATH="${SEARCH_PATH} ${path}"
186 done
187 fi
188
189 for path in ${SEARCH_PATH}; do
190 einfo "Cleaning orphaned Python bytecode from ${path} .."
191 for obj in $(find ${path} -name *.pyc); do
192 src_py="${obj%c}"
193 if [ ! -f "${src_py}" ]; then
194 einfo "Purging ${src_py}[co]"
195 rm -f ${src_py}[co]
196 fi 2251 fi
197 done
198 # attempt to remove directories that maybe empty
199 for dir in $(find ${path} -type d | sort -r); do
200 rmdir ${dir} 2>/dev/null
201 done
202 done
203} 2252}

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.96

  ViewVC Help
Powered by ViewVC 1.1.20