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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20