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

Diff of /eclass/python.eclass

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

Revision 1.24 Revision 1.72
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2009 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.24 2006/06/10 16:19:54 swegener Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.72 2009/09/11 19:55:05 arfrever Exp $
4
5# @ECLASS: python.eclass
6# @MAINTAINER:
7# python@gentoo.org
4# 8#
5# Author: Alastair Tse <liquidx@gentoo.org> 9# original author: Alastair Tse <liquidx@gentoo.org>
6#
7# A Utility Eclass that should be inherited by anything that deals with 10# @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules.
8# Python or Python modules. 11# @DESCRIPTION:
9# 12# Some useful functions for dealing with Python.
10# - Features:
11# python_version() - sets PYVER/PYVER_MAJOR/PYVER_MINOR
12# python_tkinter_exists() - Checks for tkinter support in python
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 13
20inherit alternatives 14inherit multilib
21
22 15
23if [[ -n "${NEED_PYTHON}" ]] ; then 16if [[ -n "${NEED_PYTHON}" ]] ; then
24 DEPEND=">=dev-lang/python-${NEED_PYTHON}" 17 PYTHON_ATOM=">=dev-lang/python-${NEED_PYTHON}"
18 DEPEND="${PYTHON_ATOM}"
25 RDEPEND="${DEPEND}" 19 RDEPEND="${DEPEND}"
20else
21 PYTHON_ATOM="dev-lang/python"
22fi
23
24DEPEND="${DEPEND} >=app-shells/bash-3.2"
25if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
26 DEPEND="${DEPEND} >=app-admin/eselect-python-20090804"
26fi 27fi
27 28
28__python_eclass_test() { 29__python_eclass_test() {
29 __python_version_extract 2.3 30 __python_version_extract 2.3
30 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 31 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
… …
36 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 37 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
37 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 38 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
38 __python_version_extract 2.4 39 __python_version_extract 2.4
39 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 40 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
40 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 41 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
42 __python_version_extract 2.5b3
43 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
44 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
41} 45}
42 46
43# 47# @FUNCTION: python_version
44# name: python_disable/enable_pyc 48# @DESCRIPTION:
45# desc: tells python not to automatically recompile modules to .pyc/.pyo
46# even if the timestamps/version stamps don't match. this is
47# done to protect sandbox.
48#
49# note: supported by >=dev-lang/python-2.2.3-r3 only.
50#
51python_disable_pyc() {
52 export PYTHON_DONTCOMPILE=1
53}
54
55python_enable_pyc() {
56 unset PYTHON_DONTCOMPILE
57}
58
59python_disable_pyc
60
61#
62# name: python_version
63# desc: run without arguments and it will export the version of python 49# Run without arguments and it will export the version of python
64# currently in use as $PYVER 50# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65#
66
67__python_version_extract() { 51__python_version_extract() {
68 verstr=$1 52 local verstr=$1
69 export PYVER_MAJOR=${verstr:0:1} 53 export PYVER_MAJOR=${verstr:0:1}
70 export PYVER_MINOR=${verstr:2:1} 54 export PYVER_MINOR=${verstr:2:1}
55 if [[ ${verstr:3:1} == . ]]; then
71 export PYVER_MICRO=${verstr:4} 56 export PYVER_MICRO=${verstr:4}
57 fi
72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" 58 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73} 59}
74 60
75python_version() { 61python_version() {
62 [[ -n "${PYVER}" ]] && return 0
76 local tmpstr 63 local tmpstr
77 python=${python:-/usr/bin/python} 64 python=${python:-/usr/bin/python}
78 tmpstr="$(${python} -V 2>&1 )" 65 tmpstr="$(${python} -V 2>&1 )"
79 export PYVER_ALL="${tmpstr#Python }" 66 export PYVER_ALL="${tmpstr#Python }"
80 __python_version_extract $PYVER_ALL 67 __python_version_extract $PYVER_ALL
81} 68}
82 69
83# 70# @FUNCTION: PYTHON
84# name: python_makesym 71# @USAGE: [-a|--absolute-path] [--] <Python_ABI="${PYTHON_ABI}">
85# desc: run without arguments, it will create the /usr/bin/python symlinks 72# @DESCRIPTION:
86# to the latest installed version 73# Get Python interpreter filename for specified Python ABI. If Python_ABI argument
87# 74# is ommitted, then PYTHON_ABI environment variable must be set and is used.
88python_makesym() { 75PYTHON() {
89 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]" 76 local absolute_path="0" slot=
90 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
91}
92 77
93# 78 while (($#)); do
79 case "$1" in
80 -a|--absolute-path)
81 absolute_path="1"
82 ;;
83 --)
84 break
85 ;;
86 -*)
87 die "${FUNCNAME}(): Unrecognized option $1"
88 ;;
89 *)
90 break
91 ;;
92 esac
93 shift
94 done
95
96 if [[ "$#" -eq "0" ]]; then
97 if [[ -n "${PYTHON_ABI}" ]]; then
98 slot="${PYTHON_ABI}"
99 else
100 die "${FUNCNAME}(): Invalid usage"
101 fi
102 elif [[ "$#" -eq "1" ]]; then
103 slot="$1"
104 else
105 die "${FUNCNAME}(): Invalid usage"
106 fi
107
108 if [[ "${absolute_path}" == "1" ]]; then
109 echo -n "/usr/bin/python${slot}"
110 else
111 echo -n "python${slot}"
112 fi
113}
114
115# @FUNCTION: validate_PYTHON_ABIS
116# @DESCRIPTION:
117# Make sure PYTHON_ABIS variable has valid value.
118validate_PYTHON_ABIS() {
119 # Ensure that some functions cannot be accidentally successfully used in EAPI <= 2 without setting SUPPORT_PYTHON_ABIS variable.
120 if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
121 die "${FUNCNAME}() cannot be used in this EAPI without setting SUPPORT_PYTHON_ABIS variable"
122 fi
123
124 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
125 if [[ "$(readlink /usr/bin/python)" != "python-wrapper" ]]; then
126 die "'/usr/bin/python' isn't valid symlink"
127 fi
128 if [[ "$(</usr/bin/python-config)" != *"Gentoo python-config wrapper script"* ]]; then
129 die "'/usr/bin/python-config' isn't valid script"
130 fi
131
132 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 4.
133 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3; then
134 local ABI support_ABI supported_PYTHON_ABIS= restricted_ABI
135 PYTHON_ABI_SUPPORTED_VALUES="2.4 2.5 2.6 2.7 3.0 3.1 3.2"
136
137 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
138 if [[ -z "${USE_PYTHON}" ]]; then
139 die "USE_PYTHON variable is empty"
140 fi
141
142 for ABI in ${USE_PYTHON}; do
143 if ! has "${ABI}" ${PYTHON_ABI_SUPPORTED_VALUES}; then
144 die "USE_PYTHON variable contains invalid value '${ABI}'"
145 fi
146 support_ABI="1"
147 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
148 if python -c "from fnmatch import fnmatch; exit(not fnmatch('${ABI}', '${restricted_ABI}'))"; then
149 support_ABI="0"
150 break
151 fi
152 done
153 [[ "${support_ABI}" == "1" ]] && supported_PYTHON_ABIS+=" ${ABI}"
154 done
155 export PYTHON_ABIS="${supported_PYTHON_ABIS# }"
156
157 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then
158 die "USE_PYTHON variable doesn't enable any Python version supported by ${CATEGORY}/${PF}"
159 fi
160 else
161 local restricted_ABI
162 python_version
163
164 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do
165 if python -c "from fnmatch import fnmatch; exit(not fnmatch('${PYVER}', '${restricted_ABI}'))"; then
166 die "Active Python version isn't supported by ${CATEGORY}/${PF}"
167 fi
168 done
169 export PYTHON_ABIS="${PYVER}"
170 fi
171 fi
172
173 local PYTHON_ABI
174 for PYTHON_ABI in ${PYTHON_ABIS}; do
175 # Ensure that appropriate Python version is installed.
176 if ! has_version "dev-lang/python:${PYTHON_ABI}"; then
177 die "dev-lang/python:${PYTHON_ABI} isn't installed"
178 fi
179
180 # Ensure that EPYTHON variable is respected.
181 if [[ "$(EPYTHON="$(PYTHON)" python -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')" != "${PYTHON_ABI}" ]]; then
182 die "'python' doesn't respect EPYTHON variable"
183 fi
184 done
185}
186
187# @FUNCTION: python_copy_sources
188# @USAGE: [--no-link] [--] [directory]
189# @DESCRIPTION:
190# Copy unpacked sources of given package for each Python ABI.
191python_copy_sources() {
192 local dir dirs=() no_link="0" PYTHON_ABI
193
194 while (($#)); do
195 case "$1" in
196 --no-link)
197 no_link="1"
198 ;;
199 --)
200 break
201 ;;
202 -*)
203 die "${FUNCNAME}(): Unrecognized option '$1'"
204 ;;
205 *)
206 break
207 ;;
208 esac
209 shift
210 done
211
212 if [[ "$#" -eq "0" ]]; then
213 if [[ "${WORKDIR}" == "${S}" ]]; then
214 die "${FUNCNAME}() cannot be used"
215 fi
216 dirs="${S}"
217 else
218 dirs="$@"
219 fi
220
221 validate_PYTHON_ABIS
222 for PYTHON_ABI in ${PYTHON_ABIS}; do
223 for dir in "${dirs[@]}"; do
224 if [[ "${no_link}" == "1" ]]; then
225 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
226 else
227 cp -lpr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
228 fi
229 done
230 done
231}
232
233# @FUNCTION: python_set_build_dir_symlink
234# @USAGE: [directory="build"]
235# @DESCRIPTION:
236# Create build directory symlink.
237python_set_build_dir_symlink() {
238 local dir="$1"
239
240 [[ -z "${PYTHON_ABI}" ]] && die "PYTHON_ABI variable not set"
241 [[ -z "${dir}" ]] && dir="build"
242
243 # Don't delete preexistent directories.
244 rm -f "${dir}" || die "Deletion of '${dir}' failed"
245 ln -s "${dir}-${PYTHON_ABI}" "${dir}" || die "Creation of '${dir}' directory symlink failed"
246}
247
248# @FUNCTION: python_execute_function
249# @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--] <function> [arguments]
250# @DESCRIPTION:
251# Execute specified function for each value of PYTHON_ABIS, optionally passing additional
252# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
253python_execute_function() {
254 local action action_message action_message_template= default_function="0" failure_message failure_message_template= function nonfatal="0" previous_directory_stack_length PYTHON_ABI quiet="0" separate_build_dirs="0"
255
256 while (($#)); do
257 case "$1" in
258 --action-message)
259 action_message_template="$2"
260 shift
261 ;;
262 -d|--default-function)
263 default_function="1"
264 ;;
265 --failure-message)
266 failure_message_template="$2"
267 shift
268 ;;
269 --nonfatal)
270 nonfatal="1"
271 ;;
272 -q|--quiet)
273 quiet="1"
274 ;;
275 -s|--separate-build-dirs)
276 separate_build_dirs="1"
277 ;;
278 --)
279 break
280 ;;
281 -*)
282 die "${FUNCNAME}(): Unrecognized option '$1'"
283 ;;
284 *)
285 break
286 ;;
287 esac
288 shift
289 done
290
291 if [[ "${default_function}" == "0" ]]; then
292 if [[ "$#" -eq "0" ]]; then
293 die "${FUNCNAME}(): Missing function name"
294 fi
295 function="$1"
296 shift
297
298 if [[ -z "$(type -t "${function}")" ]]; then
299 die "${FUNCNAME}(): '${function}' function isn't defined"
300 fi
301 else
302 if [[ "$#" -ne "0" ]]; then
303 die "${FUNCNAME}(): '--default-function' option and function name cannot be specified simultaneously"
304 fi
305 if has "${EAPI:-0}" 0 1; then
306 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
307 fi
308
309 if [[ "${EBUILD_PHASE}" == "configure" ]]; then
310 if has "${EAPI}" 2; then
311 python_default_function() {
312 econf
313 }
314 else
315 python_default_function() {
316 nonfatal econf
317 }
318 fi
319 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then
320 python_default_function() {
321 emake
322 }
323 elif [[ "${EBUILD_PHASE}" == "test" ]]; then
324 python_default_function() {
325 if emake -j1 -n check &> /dev/null; then
326 emake -j1 check
327 elif emake -j1 -n test &> /dev/null; then
328 emake -j1 test
329 fi
330 }
331 elif [[ "${EBUILD_PHASE}" == "install" ]]; then
332 python_default_function() {
333 emake DESTDIR="${D}" install
334 }
335 else
336 die "${FUNCNAME}(): --default-function option cannot be used in this ebuild phase"
337 fi
338 function="python_default_function"
339 fi
340
341 if [[ "${quiet}" == "0" ]]; then
342 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up"
343 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking"
344 [[ "${EBUILD_PHASE}" == "prepare" ]] && action="Preparation"
345 [[ "${EBUILD_PHASE}" == "configure" ]] && action="Configuration"
346 [[ "${EBUILD_PHASE}" == "compile" ]] && action="Building"
347 [[ "${EBUILD_PHASE}" == "test" ]] && action="Testing"
348 [[ "${EBUILD_PHASE}" == "install" ]] && action="Installation"
349 [[ "${EBUILD_PHASE}" == "preinst" ]] && action="Preinstallation"
350 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation"
351 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation"
352 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation"
353 fi
354
355 local RED GREEN BLUE NORMAL
356 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
357 RED=$'\e[1;31m'
358 GREEN=$'\e[1;32m'
359 BLUE=$'\e[1;34m'
360 NORMAL=$'\e[0m'
361 else
362 RED=
363 GREEN=
364 BLUE=
365 NORMAL=
366 fi
367
368 validate_PYTHON_ABIS
369 for PYTHON_ABI in ${PYTHON_ABIS}; do
370 if [[ "${quiet}" == "0" ]]; then
371 if [[ -n "${action_message_template}" ]]; then
372 action_message="$(eval echo -n "${action_message_template}")"
373 else
374 action_message="${action} of ${CATEGORY}/${PF} with Python ${PYTHON_ABI}..."
375 fi
376 echo " ${GREEN}*${NORMAL} ${BLUE}${action_message}${NORMAL}"
377 fi
378
379 if [[ "${separate_build_dirs}" == "1" ]]; then
380 export BUILDDIR="${S}-${PYTHON_ABI}"
381 pushd "${BUILDDIR}" > /dev/null || die "pushd failed"
382 else
383 export BUILDDIR="${S}"
384 fi
385
386 previous_directory_stack_length="${#DIRSTACK[@]}"
387
388 if ! has "${EAPI}" 0 1 2 && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
389 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@"
390 else
391 EPYTHON="$(PYTHON)" "${function}" "$@"
392 fi
393
394 if [[ "$?" != "0" ]]; then
395 if [[ -n "${failure_message_template}" ]]; then
396 failure_message="$(eval echo -n "${failure_message_template}")"
397 else
398 failure_message="${action} failed with Python ${PYTHON_ABI} in ${function}() function"
399 fi
400
401 if [[ "${nonfatal}" == "1" ]]; then
402 if [[ "${quiet}" == "0" ]]; then
403 ewarn "${RED}${failure_message}${NORMAL}"
404 fi
405 elif has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
406 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then
407 local ABI enabled_PYTHON_ABIS=
408 for ABI in ${PYTHON_ABIS}; do
409 [[ "${ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+=" ${ABI}"
410 done
411 export PYTHON_ABIS="${enabled_PYTHON_ABIS# }"
412 fi
413 if [[ "${quiet}" == "0" ]]; then
414 ewarn "${RED}${failure_message}${NORMAL}"
415 fi
416 if [[ -z "${PYTHON_ABIS}" ]]; then
417 die "${function}() function failed with all enabled versions of Python"
418 fi
419 else
420 die "${failure_message}"
421 fi
422 fi
423
424 if [[ "${#DIRSTACK[@]}" -lt "${previous_directory_stack_length}" ]]; then
425 die "Directory stack decreased illegally"
426 fi
427
428 while [[ "${#DIRSTACK[@]}" -gt "${previous_directory_stack_length}" ]]; do
429 popd > /dev/null || die "popd failed"
430 done
431
432 if [[ "${separate_build_dirs}" == "1" ]]; then
433 popd > /dev/null || die "popd failed"
434 fi
435 unset BUILDDIR
436 done
437
438 if [[ "${default_function}" == "1" ]]; then
439 unset -f python_default_function
440 fi
441}
442
443
444# @ECLASS-VARIABLE: PYTHON_USE_WITH
445# @DESCRIPTION:
446# Set this to a space separated list of use flags
447# the python slot in use must be built with.
448
449# @ECLASS-VARIABLE: PYTHON_USE_WITH_OR
450# @DESCRIPTION:
451# Set this to a space separated list of use flags
452# of which one must be turned on for the slot of
453# in use.
454
455# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT
456# @DESCRIPTION:
457# Set this if you need to make either PYTHON_USE_WITH or
458# PYTHON_USE_WITH_OR atoms conditional under a use flag.
459
460# @FUNCTION: python_pkg_setup
461# @DESCRIPTION:
462# Makes sure PYTHON_USE_WITH or PYTHON_USE_WITH_OR listed use flags
463# are respected. Only exported if one of those variables is set.
464if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
465 python_pkg_setup_fail() {
466 eerror "${1}"
467 die "${1}"
468 }
469
470 python_pkg_setup() {
471 [[ ${PYTHON_USE_WITH_OPT} ]] && use !${PYTHON_USE_WITH_OPT} && return
472
473 python_version
474 local failed
475 local pyatom="dev-lang/python:${PYVER}"
476
477 for use in ${PYTHON_USE_WITH}; do
478 if ! has_version "${pyatom}[${use}]"; then
479 python_pkg_setup_fail \
480 "Please rebuild ${pyatom} with use flags: ${PYTHON_USE_WITH}"
481 fi
482 done
483
484 for use in ${PYTHON_USE_WITH_OR}; do
485 if has_version "${pyatom}[${use}]"; then
486 return
487 fi
488 done
489
490 if [[ ${PYTHON_USE_WITH_OR} ]]; then
491 python_pkg_setup_fail \
492 "Please rebuild ${pyatom} with one of: ${PYTHON_USE_WITH_OR}"
493 fi
494 }
495
496 EXPORT_FUNCTIONS pkg_setup
497
498 if [[ ${PYTHON_USE_WITH} ]]; then
499 PYTHON_USE_WITH_ATOM="${PYTHON_ATOM}[${PYTHON_USE_WITH/ /,}]"
500 elif [[ ${PYTHON_USE_WITH_OR} ]]; then
501 PYTHON_USE_WITH_ATOM="|| ( "
502 for use in ${PYTHON_USE_WITH_OR}; do
503 PYTHON_USE_WITH_ATOM="
504 ${PYTHON_USE_WITH_ATOM}
505 ${PYTHON_ATOM}[${use}]"
506 done
507 PYTHON_USE_WITH_ATOM="${PYTHON_USE_WITH_ATOM} )"
508 fi
509 if [[ ${PYTHON_USE_WITH_OPT} ]]; then
510 PYTHON_USE_WITH_ATOM="${PYTHON_USE_WITH_OPT}? ( ${PYTHON_USE_WITH_ATOM} )"
511 fi
512 DEPEND="${PYTHON_USE_WITH_ATOM}"
513 RDEPEND="${PYTHON_USE_WITH_ATOM}"
514fi
515
516# @ECLASS-VARIABLE: PYTHON_DEFINE_DEFAULT_FUNCTIONS
517# @DESCRIPTION:
518# Set this to define default functions for the following ebuild phases:
519# src_prepare, src_configure, src_compile, src_test, src_install.
520if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_DEFINE_DEFAULT_FUNCTIONS}" ]]; then
521 python_src_prepare() {
522 python_copy_sources
523 }
524
525 for python_default_function in src_configure src_compile src_test src_install; do
526 eval "python_${python_default_function}() { python_execute_function -d -s; }"
527 done
528 unset python_default_function
529
530 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install
531fi
532
533# @FUNCTION: python_disable_pyc
534# @DESCRIPTION:
535# Tell Python not to automatically recompile modules to .pyc/.pyo
536# even if the timestamps/version stamps don't match. This is done
537# to protect sandbox.
538python_disable_pyc() {
539 export PYTHONDONTWRITEBYTECODE="1"
540}
541
542# @FUNCTION: python_enable_pyc
543# @DESCRIPTION:
544# Tell Python to automatically recompile modules to .pyc/.pyo if the
545# timestamps/version stamps have changed.
546python_enable_pyc() {
547 unset PYTHONDONTWRITEBYTECODE
548}
549
550python_disable_pyc
551
552# @FUNCTION: python_need_rebuild
553# @DESCRIPTION: Run without arguments, specifies that the package should be
554# rebuilt after a python upgrade.
555python_need_rebuild() {
556 python_version
557 export PYTHON_NEED_REBUILD=${PYVER}
558}
559
560# @FUNCTION: python_get_includedir
561# @DESCRIPTION:
562# Run without arguments, returns the Python include directory.
563python_get_includedir() {
564 if [[ -n "${PYTHON_ABI}" ]]; then
565 echo "/usr/include/python${PYTHON_ABI}"
566 else
567 python_version
568 echo "/usr/include/python${PYVER}"
569 fi
570}
571
572# @FUNCTION: python_get_libdir
573# @DESCRIPTION:
574# Run without arguments, returns the Python library directory.
575python_get_libdir() {
576 if [[ -n "${PYTHON_ABI}" ]]; then
577 echo "/usr/$(get_libdir)/python${PYTHON_ABI}"
578 else
579 python_version
580 echo "/usr/$(get_libdir)/python${PYVER}"
581 fi
582}
583
584# @FUNCTION: python_get_sitedir
585# @DESCRIPTION:
586# Run without arguments, returns the Python site-packages directory.
587python_get_sitedir() {
588 echo "$(python_get_libdir)/site-packages"
589}
590
94# name: python_tkinter_exists 591# @FUNCTION: python_tkinter_exists
592# @DESCRIPTION:
95# desc: run without arguments, checks if python was compiled with Tkinter 593# Run without arguments, checks if python was compiled with Tkinter
96# support. If not, prints an error message and dies. 594# support. If not, prints an error message and dies.
97#
98python_tkinter_exists() { 595python_tkinter_exists() {
99 if ! python -c "import Tkinter" >/dev/null 2>&1; then 596 if ! python -c "import Tkinter" >/dev/null 2>&1; then
100 eerror "You need to recompile python with Tkinter support." 597 eerror "You need to recompile python with Tkinter support."
101 eerror "That means: USE='tcltk' emerge python" 598 eerror "Try adding: 'dev-lang/python tk'"
599 eerror "in to /etc/portage/package.use"
102 echo 600 echo
103 die "missing tkinter support with installed python" 601 die "missing tkinter support with installed python"
104 fi 602 fi
105} 603}
106 604
605# @FUNCTION: python_mod_exists
606# @USAGE: <module>
607# @DESCRIPTION:
608# Run with the module name as an argument. it will check if a
609# python module is installed and loadable. it will return
610# TRUE(0) if the module exists, and FALSE(1) if the module does
611# not exist.
107# 612#
108# name: python_mod_exists 613# Example:
109# desc: run with the module name as an argument. it will check if a
110# python module is installed and loadable. it will return
111# TRUE(0) if the module exists, and FALSE(1) if the module does
112# not exist.
113# exam:
114# if python_mod_exists gtk; then 614# if python_mod_exists gtk; then
115# echo "gtk support enabled 615# echo "gtk support enabled"
116# fi 616# fi
617python_mod_exists() {
618 [[ "$1" ]] || die "${FUNCNAME} requires an argument!"
619 python -c "import $1" &>/dev/null
620}
621
622# @FUNCTION: python_mod_compile
623# @USAGE: <file> [more files ...]
624# @DESCRIPTION:
625# Given filenames, it will pre-compile the module's .pyc and .pyo.
626# This function should only be run in pkg_postinst()
117# 627#
118python_mod_exists() { 628# Example:
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then
121 return 1
122 fi
123 return 0
124}
125
126#
127# name: python_mod_compile
128# desc: given a filename, it will pre-compile the module's .pyc and .pyo.
129# should only be run in pkg_postinst()
130# exam:
131# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 629# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
132# 630#
133python_mod_compile() { 631python_mod_compile() {
632 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
633 die "${FUNCNAME}() cannot be used in this EAPI"
634 fi
635
636 local f myroot myfiles=()
637
638 # Check if phase is pkg_postinst()
639 [[ ${EBUILD_PHASE} != postinst ]] &&\
640 die "${FUNCNAME} should only be run in pkg_postinst()"
641
134 # allow compiling for older python versions 642 # allow compiling for older python versions
135 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 643 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
136 PYVER=${PYTHON_OVERRIDE_PYVER} 644 PYVER=${PYTHON_OVERRIDE_PYVER}
137 else 645 else
138 python_version 646 python_version
139 fi 647 fi
140 648
141 if [ -f "$1" ]; then
142 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
143 ewarn "Failed to compile ${1}"
144 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
145 ewarn "Failed to compile ${1}"
146 else
147 ewarn "Unable to find ${1}"
148 fi
149}
150
151#
152# name: python_mod_optimize
153# desc: if no arguments supplied, it will recompile all modules under
154# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
155# no recursively
156#
157# if supplied with arguments, it will recompile all modules recursively
158# in the supplied directory
159# exam:
160# python_mod_optimize ${ROOT}usr/share/codegen
161#
162python_mod_optimize() {
163 local myroot
164 # strip trailing slash 649 # strip trailing slash
165 myroot="${ROOT%/}" 650 myroot="${ROOT%/}"
166 651
167 # allow compiling for older python versions 652 # respect ROOT
168 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 653 for f in "$@"; do
169 PYVER=${PYTHON_OVERRIDE_PYVER} 654 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
170 else 655 done
171 python_version
172 fi
173 656
174 # set opts 657 if ((${#myfiles[@]})); then
175 if [ "${PYVER}" = "2.2" ]; then
176 compileopts=""
177 else
178 compileopts="-q"
179 fi
180
181 ebegin "Byte compiling python modules for python-${PYVER} .."
182 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 658 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
183 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 659 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}" &> /dev/null
184 eend $? 660 else
661 ewarn "No files to compile!"
662 fi
185} 663}
186 664
665# @FUNCTION: python_mod_optimize
666# @USAGE: [options] [directory|file]
667# @DESCRIPTION:
668# If no arguments supplied, it will recompile not recursively all modules
669# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages).
187# 670#
188# name: python_mod_cleanup 671# If supplied with arguments, it will recompile all modules recursively
189# desc: run with optional arguments, where arguments are directories of 672# in the supplied directory.
190# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9] 673# This function should only be run in pkg_postinst().
191# 674#
192# it will recursively scan all compiled python modules in the directories 675# Options passed to this function are passed to compileall.py.
193# and determine if they are orphaned (eg. their corresponding .py is missing.)
194# if they are, then it will remove their corresponding .pyc and .pyo
195# 676#
677# Example:
678# python_mod_optimize ctypesgencore
679python_mod_optimize() {
680 # Check if phase is pkg_postinst().
681 [[ ${EBUILD_PHASE} != "postinst" ]] && die "${FUNCNAME} should only be run in pkg_postinst()"
682
683 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
684 local dir file options=() other_dirs=() other_files=() PYTHON_ABI return_code root site_packages_absolute_dirs=() site_packages_dirs=() site_packages_absolute_files=() site_packages_files=()
685
686 # Strip trailing slash from ROOT.
687 root="${ROOT%/}"
688
689 # Respect ROOT and options passed to compileall.py.
690 while (($#)); do
691 case "$1" in
692 -l|-f|-q)
693 options+=("$1")
694 ;;
695 -d|-x)
696 options+=("$1" "$2")
697 shift
698 ;;
699 -*)
700 ewarn "${FUNCNAME}: Ignoring compile option $1"
701 ;;
702 *)
703 if [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
704 die "${FUNCNAME} doesn't support absolute paths of directories/files in site-packages directories"
705 elif [[ "$1" =~ ^/ ]]; then
706 if [[ -d "${root}/$1" ]]; then
707 other_dirs+=("${root}/$1")
708 elif [[ -f "${root}/$1" ]]; then
709 other_files+=("${root}/$1")
710 elif [[ -e "${root}/$1" ]]; then
711 ewarn "'${root}/$1' is not a file or a directory!"
712 else
713 ewarn "'${root}/$1' doesn't exist!"
714 fi
715 else
716 for PYTHON_ABI in ${PYTHON_ABIS}; do
717 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
718 site_packages_dirs+=("$1")
719 break
720 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
721 site_packages_files+=("$1")
722 break
723 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
724 ewarn "'$1' is not a file or a directory!"
725 else
726 ewarn "'$1' doesn't exist!"
727 fi
728 done
729 fi
730 ;;
731 esac
732 shift
733 done
734
735 # Set additional options.
736 options+=("-q")
737
738 for PYTHON_ABI in ${PYTHON_ABIS}; do
739 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})); then
740 return_code="0"
741 ebegin "Compilation and optimization of Python modules for Python ${PYTHON_ABI}"
742 if ((${#site_packages_dirs[@]})); then
743 for dir in "${site_packages_dirs[@]}"; do
744 site_packages_absolute_dirs+=("${root}$(python_get_sitedir)/${dir}")
745 done
746 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" || return_code="1"
747 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" &> /dev/null || return_code="1"
748 fi
749 if ((${#site_packages_files[@]})); then
750 for file in "${site_packages_files[@]}"; do
751 site_packages_absolute_files+=("${root}$(python_get_sitedir)/${file}")
752 done
753 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" || return_code="1"
754 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" &> /dev/null || return_code="1"
755 fi
756 eend "${return_code}"
757 fi
758 unset site_packages_absolute_dirs site_packages_absolute_files
759 done
760
761 # Don't use PYTHON_ABI in next calls to python_get_libdir().
762 unset PYTHON_ABI
763
764 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then
765 return_code="0"
766 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for Python ${PYVER}..."
767 if ((${#other_dirs[@]})); then
768 python${PYVER} "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1"
769 python${PYVER} -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
770 fi
771 if ((${#other_files[@]})); then
772 python${PYVER} "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1"
773 python${PYVER} -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1"
774 fi
775 eend "${return_code}"
776 fi
777 else
778 local myroot mydirs=() myfiles=() myopts=() return_code="0"
779
780 # strip trailing slash
781 myroot="${ROOT%/}"
782
783 # respect ROOT and options passed to compileall.py
784 while (($#)); do
785 case "$1" in
786 -l|-f|-q)
787 myopts+=("$1")
788 ;;
789 -d|-x)
790 myopts+=("$1" "$2")
791 shift
792 ;;
793 -*)
794 ewarn "${FUNCNAME}: Ignoring compile option $1"
795 ;;
796 *)
797 if [[ -d "${myroot}"/$1 ]]; then
798 mydirs+=("${myroot}/$1")
799 elif [[ -f "${myroot}"/$1 ]]; then
800 # Files are passed to python_mod_compile which is ROOT-aware
801 myfiles+=("$1")
802 elif [[ -e "${myroot}/$1" ]]; then
803 ewarn "${myroot}/$1 is not a file or directory!"
804 else
805 ewarn "${myroot}/$1 doesn't exist!"
806 fi
807 ;;
808 esac
809 shift
810 done
811
812 # allow compiling for older python versions
813 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
814 PYVER=${PYTHON_OVERRIDE_PYVER}
815 else
816 python_version
817 fi
818
819 # set additional opts
820 myopts+=(-q)
821
822 ebegin "Byte compiling python modules for python-${PYVER} .."
823 if ((${#mydirs[@]})); then
824 python${PYVER} \
825 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
826 "${myopts[@]}" "${mydirs[@]}" || return_code="1"
827 python${PYVER} -O \
828 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
829 "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
830 fi
831
832 if ((${#myfiles[@]})); then
833 python_mod_compile "${myfiles[@]}"
834 fi
835
836 eend "${return_code}"
837 fi
838}
839
840# @FUNCTION: python_mod_cleanup
841# @USAGE: [directory]
842# @DESCRIPTION:
843# Run with optional arguments, where arguments are directories of
844# python modules. If none given, it will look in /usr/lib/python[0-9].[0-9].
845#
846# It will recursively scan all compiled Python modules in the directories and
847# determine if they are orphaned (i.e. their corresponding .py files are missing.)
848# If they are, then it will remove their corresponding .pyc and .pyo files.
849#
850# This function should only be run in pkg_postrm().
196python_mod_cleanup() { 851python_mod_cleanup() {
197 local SEARCH_PATH myroot 852 local PYTHON_ABI SEARCH_PATH=() root src_py
198 853
854 # Check if phase is pkg_postrm().
855 [[ ${EBUILD_PHASE} != "postrm" ]] && die "${FUNCNAME} should only be run in pkg_postrm()"
856
199 # strip trailing slash 857 # Strip trailing slash from ROOT.
200 myroot="${ROOT%/}" 858 root="${ROOT%/}"
201 859
202 if [ $# -gt 0 ]; then 860 if (($#)); then
203 for path in $@; do 861 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
204 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}" 862 while (($#)); do
863 if [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
864 die "${FUNCNAME} doesn't support absolute paths of directories/files in site-packages directories"
865 elif [[ "$1" =~ ^/ ]]; then
866 SEARCH_PATH+=("${root}/${1#/}")
867 else
868 for PYTHON_ABI in ${PYTHON_ABIS}; do
869 SEARCH_PATH+=("${root}$(python_get_sitedir)/$1")
870 done
871 fi
872 shift
205 done 873 done
206 else 874 else
207 for path in ${myroot}/usr/lib*/python*/site-packages; do 875 SEARCH_PATH=("${@#/}")
208 SEARCH_PATH="${SEARCH_PATH} ${path}" 876 SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}")
209 done
210 fi 877 fi
878 else
879 SEARCH_PATH=("${root}"/usr/lib*/python*/site-packages)
880 fi
211 881
212 for path in ${SEARCH_PATH}; do 882 for path in "${SEARCH_PATH[@]}"; do
883 [[ ! -d "${path}" ]] && continue
213 einfo "Cleaning orphaned Python bytecode from ${path} .." 884 einfo "Cleaning orphaned Python bytecode from ${path} .."
214 for obj in $(find ${path} -name *.pyc); do 885 find "${path}" -name '*.py[co]' -print0 | while read -rd ''; do
215 src_py="${obj%c}" 886 src_py="${REPLY%[co]}"
216 if [ ! -f "${src_py}" ]; then 887 [[ -f "${src_py}" || (! -f "${src_py}c" && ! -f "${src_py}o") ]] && continue
217 einfo "Purging ${src_py}[co]" 888 einfo "Purging ${src_py}[co]"
218 rm -f ${src_py}[co] 889 rm -f "${src_py}"[co]
219 fi
220 done 890 done
891
221 # attempt to remove directories that maybe empty 892 # Attempt to remove directories that may be empty.
222 for dir in $(find ${path} -type d | sort -r); do 893 find "${path}" -type d | sort -r | while read -r dir; do
223 rmdir ${dir} 2>/dev/null 894 rmdir "${dir}" 2>/dev/null && einfo "Removing empty directory ${dir}"
224 done 895 done
225 done 896 done
226} 897}
Legend:
Removed from v.1.24  
changed lines
  Added in v.1.72
  ViewVC Help
Powered by ViewVC 1.1.13