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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.67 - (hide annotations) (download)
Sat Aug 29 02:15:24 2009 UTC (5 years, 7 months ago) by arfrever
Branch: MAIN
Changes since 1.66: +26 -5 lines
Ensure that defined functions are passed to python_execute_function(). Add PYTHON_DEFINE_DEFAULT_FUNCTIONS variable.

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

  ViewVC Help
Powered by ViewVC 1.1.20