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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.62

  ViewVC Help
Powered by ViewVC 1.1.20