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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.72 - (hide annotations) (download)
Fri Sep 11 19:55:05 2009 UTC (5 years, 3 months ago) by arfrever
Branch: MAIN
Changes since 1.71: +12 -2 lines
Improve handling of directory stack in python_execute_function().

1 arfrever 1.56 # Copyright 1999-2009 Gentoo Foundation
2 liquidx 1.1 # Distributed under the terms of the GNU General Public License v2
3 arfrever 1.72 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.71 2009/09/09 04:16:58 arfrever Exp $
4 liquidx 1.1
5 dev-zero 1.33 # @ECLASS: python.eclass
6     # @MAINTAINER:
7     # python@gentoo.org
8     #
9     # original author: Alastair Tse <liquidx@gentoo.org>
10     # @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules.
11     # @DESCRIPTION:
12 arfrever 1.66 # Some useful functions for dealing with Python.
13 liquidx 1.1
14 arfrever 1.65 inherit multilib
15 liquidx 1.2
16 carlo 1.23 if [[ -n "${NEED_PYTHON}" ]] ; then
17 betelgeuse 1.55 PYTHON_ATOM=">=dev-lang/python-${NEED_PYTHON}"
18     DEPEND="${PYTHON_ATOM}"
19 swegener 1.24 RDEPEND="${DEPEND}"
20 betelgeuse 1.55 else
21     PYTHON_ATOM="dev-lang/python"
22 carlo 1.22 fi
23 liquidx 1.18
24 arfrever 1.66 DEPEND="${DEPEND} >=app-shells/bash-3.2"
25 arfrever 1.56 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
26 arfrever 1.59 DEPEND="${DEPEND} >=app-admin/eselect-python-20090804"
27 arfrever 1.56 fi
28    
29 liquidx 1.18 __python_eclass_test() {
30     __python_version_extract 2.3
31     echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
32     echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
33     __python_version_extract 2.3.4
34     echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
35     echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
36     __python_version_extract 2.3.5
37     echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
38     echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
39     __python_version_extract 2.4
40     echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
41     echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
42 liquidx 1.28 __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"
45 liquidx 1.18 }
46    
47 dev-zero 1.33 # @FUNCTION: python_version
48     # @DESCRIPTION:
49     # Run without arguments and it will export the version of python
50     # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
51 liquidx 1.18 __python_version_extract() {
52 hawking 1.45 local verstr=$1
53 liquidx 1.18 export PYVER_MAJOR=${verstr:0:1}
54     export PYVER_MINOR=${verstr:2:1}
55 hawking 1.47 if [[ ${verstr:3:1} == . ]]; then
56 swegener 1.29 export PYVER_MICRO=${verstr:4}
57 liquidx 1.28 fi
58 swegener 1.21 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
59 liquidx 1.18 }
60    
61 liquidx 1.1 python_version() {
62 hawking 1.44 [[ -n "${PYVER}" ]] && return 0
63 liquidx 1.1 local tmpstr
64     python=${python:-/usr/bin/python}
65     tmpstr="$(${python} -V 2>&1 )"
66     export PYVER_ALL="${tmpstr#Python }"
67 liquidx 1.18 __python_version_extract $PYVER_ALL
68 liquidx 1.1 }
69    
70 arfrever 1.60 # @FUNCTION: PYTHON
71 arfrever 1.71 # @USAGE: [-a|--absolute-path] [--] <Python_ABI="${PYTHON_ABI}">
72 arfrever 1.56 # @DESCRIPTION:
73     # Get Python interpreter filename for specified Python ABI. If Python_ABI argument
74     # is ommitted, then PYTHON_ABI environment variable must be set and is used.
75 arfrever 1.60 PYTHON() {
76 arfrever 1.56 local absolute_path="0" slot=
77    
78     while (($#)); do
79     case "$1" in
80     -a|--absolute-path)
81     absolute_path="1"
82     ;;
83 arfrever 1.71 --)
84     break
85     ;;
86 arfrever 1.56 -*)
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.
118     validate_PYTHON_ABIS() {
119 arfrever 1.66 # 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 arfrever 1.59 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
125 arfrever 1.63 if [[ "$(readlink /usr/bin/python)" != "python-wrapper" ]]; then
126 arfrever 1.66 die "'/usr/bin/python' isn't valid symlink"
127 arfrever 1.57 fi
128     if [[ "$(</usr/bin/python-config)" != *"Gentoo python-config wrapper script"* ]]; then
129 arfrever 1.66 die "'/usr/bin/python-config' isn't valid script"
130 arfrever 1.57 fi
131    
132 arfrever 1.56 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 4.
133 arfrever 1.70 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3; then
134 arfrever 1.56 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 arfrever 1.68
137 arfrever 1.70 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
138 arfrever 1.68 if [[ -z "${USE_PYTHON}" ]]; then
139     die "USE_PYTHON variable is empty"
140 arfrever 1.56 fi
141 arfrever 1.68
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 arfrever 1.66 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 arfrever 1.68 [[ "${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 arfrever 1.66 fi
160 arfrever 1.68 else
161     local restricted_ABI
162     python_version
163 arfrever 1.56
164 arfrever 1.68 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 arfrever 1.56 fi
172 arfrever 1.66
173     local PYTHON_ABI
174     for PYTHON_ABI in ${PYTHON_ABIS}; do
175 arfrever 1.71 # 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 arfrever 1.66 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 arfrever 1.56 }
186    
187     # @FUNCTION: python_copy_sources
188 arfrever 1.71 # @USAGE: [--no-link] [--] [directory]
189 arfrever 1.56 # @DESCRIPTION:
190     # Copy unpacked sources of given package for each Python ABI.
191     python_copy_sources() {
192 arfrever 1.71 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 arfrever 1.56
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 arfrever 1.71 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 arfrever 1.56 done
230     done
231     }
232    
233     # @FUNCTION: python_set_build_dir_symlink
234     # @USAGE: [directory="build"]
235     # @DESCRIPTION:
236     # Create build directory symlink.
237     python_set_build_dir_symlink() {
238     local dir="$1"
239    
240 arfrever 1.66 [[ -z "${PYTHON_ABI}" ]] && die "PYTHON_ABI variable not set"
241 arfrever 1.56 [[ -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 arfrever 1.71 # @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--] <function> [arguments]
250 arfrever 1.56 # @DESCRIPTION:
251 arfrever 1.60 # Execute specified function for each value of PYTHON_ABIS, optionally passing additional
252     # arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
253 arfrever 1.56 python_execute_function() {
254 arfrever 1.72 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 arfrever 1.56
256     while (($#)); do
257     case "$1" in
258     --action-message)
259     action_message_template="$2"
260     shift
261     ;;
262 arfrever 1.58 -d|--default-function)
263     default_function="1"
264     ;;
265 arfrever 1.56 --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 arfrever 1.71 --)
279     break
280     ;;
281 arfrever 1.56 -*)
282 arfrever 1.67 die "${FUNCNAME}(): Unrecognized option '$1'"
283 arfrever 1.56 ;;
284     *)
285     break
286     ;;
287     esac
288     shift
289     done
290    
291 arfrever 1.58 if [[ "${default_function}" == "0" ]]; then
292     if [[ "$#" -eq "0" ]]; then
293     die "${FUNCNAME}(): Missing function name"
294     fi
295     function="$1"
296     shift
297 arfrever 1.67
298     if [[ -z "$(type -t "${function}")" ]]; then
299     die "${FUNCNAME}(): '${function}' function isn't defined"
300     fi
301 arfrever 1.58 else
302     if [[ "$#" -ne "0" ]]; then
303 arfrever 1.67 die "${FUNCNAME}(): '--default-function' option and function name cannot be specified simultaneously"
304 arfrever 1.58 fi
305     if has "${EAPI:-0}" 0 1; then
306 arfrever 1.67 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
307 arfrever 1.58 fi
308    
309     if [[ "${EBUILD_PHASE}" == "configure" ]]; then
310 arfrever 1.61 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 arfrever 1.58 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 arfrever 1.56 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 arfrever 1.66
379 arfrever 1.56 if [[ "${separate_build_dirs}" == "1" ]]; then
380 arfrever 1.60 export BUILDDIR="${S}-${PYTHON_ABI}"
381     pushd "${BUILDDIR}" > /dev/null || die "pushd failed"
382     else
383     export BUILDDIR="${S}"
384 arfrever 1.56 fi
385 arfrever 1.66
386 arfrever 1.72 previous_directory_stack_length="${#DIRSTACK[@]}"
387    
388 arfrever 1.66 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 arfrever 1.56 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 arfrever 1.66
401 arfrever 1.69 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 arfrever 1.70 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 arfrever 1.56 if [[ "${quiet}" == "0" ]]; then
414     ewarn "${RED}${failure_message}${NORMAL}"
415     fi
416 arfrever 1.69 if [[ -z "${PYTHON_ABIS}" ]]; then
417     die "${function}() function failed with all enabled versions of Python"
418     fi
419 arfrever 1.56 else
420     die "${failure_message}"
421     fi
422     fi
423 arfrever 1.66
424 arfrever 1.72 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 arfrever 1.56 if [[ "${separate_build_dirs}" == "1" ]]; then
433     popd > /dev/null || die "popd failed"
434     fi
435 arfrever 1.60 unset BUILDDIR
436 arfrever 1.56 done
437 arfrever 1.58
438     if [[ "${default_function}" == "1" ]]; then
439     unset -f python_default_function
440     fi
441 arfrever 1.56 }
442    
443    
444 betelgeuse 1.55 # @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.
464 arfrever 1.67 if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
465 betelgeuse 1.55 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}"
514     fi
515    
516 arfrever 1.67 # @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.
520     if ! 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
531     fi
532    
533 hawking 1.46 # @FUNCTION: python_disable_pyc
534     # @DESCRIPTION:
535 arfrever 1.66 # Tell Python not to automatically recompile modules to .pyc/.pyo
536 hawking 1.46 # even if the timestamps/version stamps don't match. This is done
537     # to protect sandbox.
538     python_disable_pyc() {
539 arfrever 1.66 export PYTHONDONTWRITEBYTECODE="1"
540 hawking 1.46 }
541    
542     # @FUNCTION: python_enable_pyc
543     # @DESCRIPTION:
544 arfrever 1.66 # Tell Python to automatically recompile modules to .pyc/.pyo if the
545     # timestamps/version stamps have changed.
546 hawking 1.46 python_enable_pyc() {
547 hawking 1.53 unset PYTHONDONTWRITEBYTECODE
548 hawking 1.46 }
549    
550     python_disable_pyc
551    
552 hawking 1.52 # @FUNCTION: python_need_rebuild
553     # @DESCRIPTION: Run without arguments, specifies that the package should be
554     # rebuilt after a python upgrade.
555     python_need_rebuild() {
556     python_version
557     export PYTHON_NEED_REBUILD=${PYVER}
558     }
559    
560 arfrever 1.56 # @FUNCTION: python_get_includedir
561     # @DESCRIPTION:
562     # Run without arguments, returns the Python include directory.
563     python_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 pythonhead 1.43 # @FUNCTION: python_get_libdir
573     # @DESCRIPTION:
574 arfrever 1.56 # Run without arguments, returns the Python library directory.
575 pythonhead 1.43 python_get_libdir() {
576 arfrever 1.56 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 pythonhead 1.42 }
583    
584 pythonhead 1.43 # @FUNCTION: python_get_sitedir
585     # @DESCRIPTION:
586 arfrever 1.56 # Run without arguments, returns the Python site-packages directory.
587 pythonhead 1.43 python_get_sitedir() {
588     echo "$(python_get_libdir)/site-packages"
589 pythonhead 1.42 }
590    
591 dev-zero 1.33 # @FUNCTION: python_tkinter_exists
592     # @DESCRIPTION:
593     # Run without arguments, checks if python was compiled with Tkinter
594     # support. If not, prints an error message and dies.
595 liquidx 1.1 python_tkinter_exists() {
596     if ! python -c "import Tkinter" >/dev/null 2>&1; then
597     eerror "You need to recompile python with Tkinter support."
598 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
599 liquidx 1.27 eerror "in to /etc/portage/package.use"
600 liquidx 1.1 echo
601     die "missing tkinter support with installed python"
602     fi
603     }
604    
605 dev-zero 1.33 # @FUNCTION: python_mod_exists
606 arfrever 1.56 # @USAGE: <module>
607 dev-zero 1.33 # @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.
612 liquidx 1.1 #
613 dev-zero 1.33 # Example:
614 liquidx 1.1 # if python_mod_exists gtk; then
615 liquidx 1.28 # echo "gtk support enabled"
616 liquidx 1.1 # fi
617     python_mod_exists() {
618 zmedico 1.54 [[ "$1" ]] || die "${FUNCNAME} requires an argument!"
619 arfrever 1.56 python -c "import $1" &>/dev/null
620 liquidx 1.1 }
621    
622 dev-zero 1.33 # @FUNCTION: python_mod_compile
623 arfrever 1.56 # @USAGE: <file> [more files ...]
624 dev-zero 1.33 # @DESCRIPTION:
625 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
626 hawking 1.37 # This function should only be run in pkg_postinst()
627 liquidx 1.1 #
628 dev-zero 1.33 # Example:
629 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
630 liquidx 1.1 #
631     python_mod_compile() {
632 arfrever 1.56 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 hawking 1.48 local f myroot myfiles=()
637 hawking 1.37
638     # Check if phase is pkg_postinst()
639     [[ ${EBUILD_PHASE} != postinst ]] &&\
640 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
641 hawking 1.37
642 liquidx 1.5 # allow compiling for older python versions
643 hawking 1.48 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
644 liquidx 1.5 PYVER=${PYTHON_OVERRIDE_PYVER}
645 pythonhead 1.7 else
646 liquidx 1.5 python_version
647     fi
648 pythonhead 1.7
649 hawking 1.35 # strip trailing slash
650     myroot="${ROOT%/}"
651    
652     # respect ROOT
653 hawking 1.51 for f in "$@"; do
654 hawking 1.48 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
655 hawking 1.35 done
656    
657 hawking 1.48 if ((${#myfiles[@]})); then
658     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
659 arfrever 1.63 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}" &> /dev/null
660 liquidx 1.1 else
661 hawking 1.35 ewarn "No files to compile!"
662 pythonhead 1.7 fi
663 liquidx 1.1 }
664    
665 dev-zero 1.33 # @FUNCTION: python_mod_optimize
666 arfrever 1.56 # @USAGE: [options] [directory|file]
667 dev-zero 1.33 # @DESCRIPTION:
668 arfrever 1.56 # 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).
670 liquidx 1.1 #
671 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
672 arfrever 1.56 # in the supplied directory.
673     # This function should only be run in pkg_postinst().
674 dev-zero 1.33 #
675 arfrever 1.56 # Options passed to this function are passed to compileall.py.
676 hawking 1.39 #
677 dev-zero 1.33 # Example:
678 arfrever 1.56 # python_mod_optimize ctypesgencore
679 liquidx 1.1 python_mod_optimize() {
680 arfrever 1.56 # 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 hawking 1.37
686 arfrever 1.56 # 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 arfrever 1.62 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
718 arfrever 1.56 site_packages_dirs+=("$1")
719     break
720 arfrever 1.62 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
721 arfrever 1.56 site_packages_files+=("$1")
722     break
723 arfrever 1.62 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
724 arfrever 1.56 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 hawking 1.37
735 arfrever 1.56 # Set additional options.
736     options+=("-q")
737 liquidx 1.13
738 arfrever 1.56 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 arfrever 1.62 site_packages_absolute_dirs+=("${root}$(python_get_sitedir)/${dir}")
745 arfrever 1.56 done
746 arfrever 1.62 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" || return_code="1"
747 arfrever 1.63 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" &> /dev/null || return_code="1"
748 arfrever 1.56 fi
749     if ((${#site_packages_files[@]})); then
750     for file in "${site_packages_files[@]}"; do
751 arfrever 1.62 site_packages_absolute_files+=("${root}$(python_get_sitedir)/${file}")
752 arfrever 1.56 done
753 arfrever 1.62 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" || return_code="1"
754 arfrever 1.63 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" &> /dev/null || return_code="1"
755 hawking 1.49 fi
756 arfrever 1.56 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 hawking 1.36
764 arfrever 1.56 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 arfrever 1.62 python${PYVER} "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1"
769 arfrever 1.63 python${PYVER} -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
770 arfrever 1.56 fi
771     if ((${#other_files[@]})); then
772 arfrever 1.62 python${PYVER} "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1"
773 arfrever 1.63 python${PYVER} -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1"
774 arfrever 1.56 fi
775     eend "${return_code}"
776     fi
777 pythonhead 1.7 else
778 arfrever 1.63 local myroot mydirs=() myfiles=() myopts=() return_code="0"
779 arfrever 1.56
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 pythonhead 1.7
822 arfrever 1.56 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 arfrever 1.63 "${myopts[@]}" "${mydirs[@]}" || return_code="1"
827 arfrever 1.56 python${PYVER} -O \
828     "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
829 arfrever 1.63 "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
830 arfrever 1.56 fi
831 pythonhead 1.7
832 arfrever 1.56 if ((${#myfiles[@]})); then
833     python_mod_compile "${myfiles[@]}"
834     fi
835 hawking 1.36
836 arfrever 1.63 eend "${return_code}"
837 hawking 1.36 fi
838 liquidx 1.1 }
839    
840 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
841 arfrever 1.56 # @USAGE: [directory]
842 dev-zero 1.33 # @DESCRIPTION:
843     # Run with optional arguments, where arguments are directories of
844 arfrever 1.56 # python modules. If none given, it will look in /usr/lib/python[0-9].[0-9].
845 dev-zero 1.33 #
846 arfrever 1.56 # 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 hawking 1.37 #
850 arfrever 1.56 # This function should only be run in pkg_postrm().
851 liquidx 1.1 python_mod_cleanup() {
852 arfrever 1.56 local PYTHON_ABI SEARCH_PATH=() root src_py
853 liquidx 1.16
854 arfrever 1.56 # Check if phase is pkg_postrm().
855     [[ ${EBUILD_PHASE} != "postrm" ]] && die "${FUNCNAME} should only be run in pkg_postrm()"
856 hawking 1.37
857 arfrever 1.56 # Strip trailing slash from ROOT.
858     root="${ROOT%/}"
859 liquidx 1.1
860 hawking 1.50 if (($#)); then
861 arfrever 1.56 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
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 arfrever 1.62 SEARCH_PATH+=("${root}$(python_get_sitedir)/$1")
870 arfrever 1.56 done
871     fi
872     shift
873     done
874     else
875     SEARCH_PATH=("${@#/}")
876     SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}")
877     fi
878 liquidx 1.5 else
879 arfrever 1.56 SEARCH_PATH=("${root}"/usr/lib*/python*/site-packages)
880 liquidx 1.5 fi
881 pythonhead 1.7
882 hawking 1.50 for path in "${SEARCH_PATH[@]}"; do
883 arfrever 1.62 [[ ! -d "${path}" ]] && continue
884 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
885 zmedico 1.54 find "${path}" -name '*.py[co]' -print0 | while read -rd ''; do
886 hawking 1.50 src_py="${REPLY%[co]}"
887 arfrever 1.62 [[ -f "${src_py}" || (! -f "${src_py}c" && ! -f "${src_py}o") ]] && continue
888 hawking 1.50 einfo "Purging ${src_py}[co]"
889     rm -f "${src_py}"[co]
890 zmedico 1.54 done
891 hawking 1.50
892 arfrever 1.56 # Attempt to remove directories that may be empty.
893 zmedico 1.54 find "${path}" -type d | sort -r | while read -r dir; do
894 arfrever 1.62 rmdir "${dir}" 2>/dev/null && einfo "Removing empty directory ${dir}"
895 zmedico 1.54 done
896 pythonhead 1.7 done
897 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20