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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log

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