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

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

  ViewVC Help
Powered by ViewVC 1.1.20