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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.75 - (hide annotations) (download)
Fri Oct 2 17:32:23 2009 UTC (4 years, 10 months ago) by arfrever
Branch: MAIN
Changes since 1.74: +22 -5 lines
Print a warning when Python 2 or Python 3 is explicitly disabled.

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

  ViewVC Help
Powered by ViewVC 1.1.20