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

Diff of /eclass/python.eclass

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

Revision 1.39 Revision 1.56
1# Copyright 1999-2008 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.39 2008/05/29 21:19:19 hawking Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.56 2009/08/01 22:36:20 arfrever Exp $
4 4
5# @ECLASS: python.eclass 5# @ECLASS: python.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# python@gentoo.org 7# python@gentoo.org
8# 8#
12# Some useful functions for dealing with python. 12# Some useful functions for dealing with python.
13inherit alternatives multilib 13inherit alternatives multilib
14 14
15 15
16if [[ -n "${NEED_PYTHON}" ]] ; then 16if [[ -n "${NEED_PYTHON}" ]] ; then
17 DEPEND=">=dev-lang/python-${NEED_PYTHON}" 17 PYTHON_ATOM=">=dev-lang/python-${NEED_PYTHON}"
18 DEPEND="${PYTHON_ATOM}"
18 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"
19fi 26fi
20 27
21__python_eclass_test() { 28__python_eclass_test() {
22 __python_version_extract 2.3 29 __python_version_extract 2.3
23 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 30 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
34 __python_version_extract 2.5b3 41 __python_version_extract 2.5b3
35 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 42 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 43 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37} 44}
38 45
39# @FUNCTION: python_disable_pyc
40# @DESCRIPTION:
41# Tells python not to automatically recompile modules to .pyc/.pyo
42# even if the timestamps/version stamps don't match. This is done
43# to protect sandbox.
44#
45# note: supported by >=dev-lang/python-2.2.3-r3 only.
46#
47python_disable_pyc() {
48 export PYTHON_DONTCOMPILE=1
49}
50
51# @FUNCTION: python_enable_pyc
52# @DESCRIPTION:
53# Tells python to automatically recompile modules to .pyc/.pyo if the
54# timestamps/version stamps change
55python_enable_pyc() {
56 unset PYTHON_DONTCOMPILE
57}
58
59python_disable_pyc
60
61# @FUNCTION: python_version 46# @FUNCTION: python_version
62# @DESCRIPTION: 47# @DESCRIPTION:
63# 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; sets PYVER/PYVER_MAJOR/PYVER_MINOR 49# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65__python_version_extract() { 50__python_version_extract() {
66 verstr=$1 51 local verstr=$1
67 export PYVER_MAJOR=${verstr:0:1} 52 export PYVER_MAJOR=${verstr:0:1}
68 export PYVER_MINOR=${verstr:2:1} 53 export PYVER_MINOR=${verstr:2:1}
69 if [ "${verstr:3}x" = ".x" ]; then 54 if [[ ${verstr:3:1} == . ]]; then
70 export PYVER_MICRO=${verstr:4} 55 export PYVER_MICRO=${verstr:4}
71 fi 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
67}
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.
367#
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"
81} 423}
82 424
83# @FUNCTION: python_makesym 425# @FUNCTION: python_makesym
84# @DESCRIPTION: 426# @DESCRIPTION:
85# Run without arguments, it will create the /usr/bin/python symlinks 427# Run without arguments, it will create the /usr/bin/python symlinks
102 die "missing tkinter support with installed python" 444 die "missing tkinter support with installed python"
103 fi 445 fi
104} 446}
105 447
106# @FUNCTION: python_mod_exists 448# @FUNCTION: python_mod_exists
107# @USAGE: < module > 449# @USAGE: <module>
108# @DESCRIPTION: 450# @DESCRIPTION:
109# 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
110# python module is installed and loadable. it will return 452# python module is installed and loadable. it will return
111# 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
112# not exist. 454# not exist.
114# Example: 456# Example:
115# if python_mod_exists gtk; then 457# if python_mod_exists gtk; then
116# echo "gtk support enabled" 458# echo "gtk support enabled"
117# fi 459# fi
118python_mod_exists() { 460python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!" 461 [[ "$1" ]] || die "${FUNCNAME} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then 462 python -c "import $1" &>/dev/null
121 return 1
122 fi
123 return 0
124} 463}
125 464
126# @FUNCTION: python_mod_compile 465# @FUNCTION: python_mod_compile
127# @USAGE: < file > [more files ...] 466# @USAGE: <file> [more files ...]
128# @DESCRIPTION: 467# @DESCRIPTION:
129# Given filenames, it will pre-compile the module's .pyc and .pyo. 468# Given filenames, it will pre-compile the module's .pyc and .pyo.
130# This function should only be run in pkg_postinst() 469# This function should only be run in pkg_postinst()
131# 470#
132# Example: 471# Example:
133# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py 472# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
134# 473#
135python_mod_compile() { 474python_mod_compile() {
136 local f myroot 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=()
137 480
138 # Check if phase is pkg_postinst() 481 # Check if phase is pkg_postinst()
139 [[ ${EBUILD_PHASE} != postinst ]] &&\ 482 [[ ${EBUILD_PHASE} != postinst ]] &&\
140 die "${FUNCNAME} should only be run in pkg_postinst()" 483 die "${FUNCNAME} should only be run in pkg_postinst()"
141 484
142 # allow compiling for older python versions 485 # allow compiling for older python versions
143 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 486 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
144 PYVER=${PYTHON_OVERRIDE_PYVER} 487 PYVER=${PYTHON_OVERRIDE_PYVER}
145 else 488 else
146 python_version 489 python_version
147 fi 490 fi
148 491
149 # strip trailing slash 492 # strip trailing slash
150 myroot="${ROOT%/}" 493 myroot="${ROOT%/}"
151 494
152 # respect ROOT 495 # respect ROOT
153 for f in $@; do 496 for f in "$@"; do
154 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}" 497 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
155 done 498 done
156 499
157 if [ -n "${myfiles}" ]; then 500 if ((${#myfiles[@]})); then
158 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles} 501 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
159 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles} 502 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
160 else 503 else
161 ewarn "No files to compile!" 504 ewarn "No files to compile!"
162 fi 505 fi
163} 506}
164 507
165# @FUNCTION: python_mod_optimize 508# @FUNCTION: python_mod_optimize
166# @USAGE: [ path ] 509# @USAGE: [options] [directory|file]
167# @DESCRIPTION: 510# @DESCRIPTION:
168# If no arguments supplied, it will recompile all modules under 511# If no arguments supplied, it will recompile not recursively all modules
169# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) 512# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages).
170# no recursively
171# 513#
172# If supplied with arguments, it will recompile all modules recursively 514# If supplied with arguments, it will recompile all modules recursively
173# in the supplied directory 515# in the supplied directory.
174# This function should only be run in pkg_postinst() 516# This function should only be run in pkg_postinst().
175# 517#
176# Options passed to this function are passed to compileall.py 518# Options passed to this function are passed to compileall.py.
177# 519#
178# Example: 520# Example:
179# python_mod_optimize /usr/share/codegen 521# python_mod_optimize ctypesgencore
180python_mod_optimize() { 522python_mod_optimize() {
181 local mydirs myfiles myroot myopts path
182
183 # Check if phase is pkg_postinst() 523 # Check if phase is pkg_postinst().
184 [[ ${EBUILD_PHASE} != postinst ]] &&\ 524 [[ ${EBUILD_PHASE} != "postinst" ]] && die "${FUNCNAME} should only be run in pkg_postinst()"
185 die "${FUNCNAME} should only be run in pkg_postinst()"
186 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
187 # strip trailing slash 623 # strip trailing slash
188 myroot="${ROOT%/}" 624 myroot="${ROOT%/}"
189 625
190 # respect ROOT and options passed to compileall.py 626 # respect ROOT and options passed to compileall.py
191 while [ $# -gt 0 ]; do 627 while (($#)); do
192 case $1 in 628 case "$1" in
193 -l|-f|-q) 629 -l|-f|-q)
194 myopts="${myopts} $1" 630 myopts+=("$1")
195 ;; 631 ;;
196 -d|-x) 632 -d|-x)
197 # -x takes regexp as argument so quoting is necessary. 633 myopts+=("$1" "$2")
198 myopts="${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
655 # allow compiling for older python versions
656 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
657 PYVER=${PYTHON_OVERRIDE_PYVER}
658 else
659 python_version
660 fi
661
662 # set additional opts
663 myopts+=(-q)
664
665 ebegin "Byte compiling python modules for python-${PYVER} .."
666 if ((${#mydirs[@]})); then
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
679 eend $?
680 fi
681}
682
683# @FUNCTION: python_mod_cleanup
684# @USAGE: [directory]
685# @DESCRIPTION:
686# Run with optional arguments, where arguments are directories of
687# python modules. If none given, it will look in /usr/lib/python[0-9].[0-9].
688#
689# It will recursively scan all compiled Python modules in the directories and
690# determine if they are orphaned (i.e. their corresponding .py files are missing.)
691# If they are, then it will remove their corresponding .pyc and .pyo files.
692#
693# This function should only be run in pkg_postrm().
694python_mod_cleanup() {
695 local PYTHON_ABI SEARCH_PATH=() root src_py
696
697 # Check if phase is pkg_postrm().
698 [[ ${EBUILD_PHASE} != "postrm" ]] && die "${FUNCNAME} should only be run in pkg_postrm()"
699
700 # Strip trailing slash from ROOT.
701 root="${ROOT%/}"
702
703 if (($#)); then
704 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
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
199 shift 715 shift
200 ;;
201 -*)
202 ewarn "${FUNCNAME}: Ignoring compile option $1"
203 ;;
204 *)
205 for path in $@; do
206 [ ! -e "${myroot}/${path}" ] && ewarn "${myroot}/${path} doesn't exist!"
207 [ -d "${myroot}/${path#/}" ] && mydirs="${mydirs} ${myroot}/${path#/}"
208 # Files are passed to python_mod_compile which is ROOT-aware
209 [ -f "${myroot}/${path}" ] && myfiles="${myfiles} ${path}"
210 done 716 done
211 ;; 717 else
212 esac 718 SEARCH_PATH=("${@#/}")
213 shift 719 SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}")
720 fi
721 else
722 SEARCH_PATH=("${root}"/usr/lib*/python*/site-packages)
723 fi
724
725 for path in "${SEARCH_PATH[@]}"; do
726 einfo "Cleaning orphaned Python bytecode from ${path} .."
727 find "${path}" -name '*.py[co]' -print0 | while read -rd ''; do
728 src_py="${REPLY%[co]}"
729 [[ -f "${src_py}" ]] && continue
730 einfo "Purging ${src_py}[co]"
731 rm -f "${src_py}"[co]
732 done
733
734 # Attempt to remove directories that may be empty.
735 find "${path}" -type d | sort -r | while read -r dir; do
736 rmdir "${dir}" 2>/dev/null
737 done
214 done 738 done
215
216 # allow compiling for older python versions
217 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
218 PYVER=${PYTHON_OVERRIDE_PYVER}
219 else
220 python_version
221 fi
222
223 # set opts
224 if [ "${PYVER}" = "2.2" ]; then
225 compileopts=""
226 else
227 compileopts="-q"
228 fi
229
230 ebegin "Byte compiling python modules for python-${PYVER} .."
231 if [ -n "${mydirs}" ]; then
232 python${PYVER} \
233 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
234 ${compileopts} ${myopts} ${mydirs}
235 python${PYVER} -O \
236 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
237 ${compileopts} ${myopts} ${mydirs}
238 fi
239
240 if [ -n "${myfiles}" ]; then
241 python_mod_compile ${myfiles}
242 fi
243
244 eend $?
245} 739}
246
247# @FUNCTION: python_mod_cleanup
248# @USAGE: [ dir ]
249# @DESCRIPTION:
250# Run with optional arguments, where arguments are directories of
251# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
252#
253# It will recursively scan all compiled python modules in the directories
254# and determine if they are orphaned (eg. their corresponding .py is missing.)
255# if they are, then it will remove their corresponding .pyc and .pyo
256#
257# This function should only be run in pkg_postrm()
258python_mod_cleanup() {
259 local SEARCH_PATH myroot
260
261 # Check if phase is pkg_postrm()
262 [[ ${EBUILD_PHASE} != postrm ]] &&\
263 die "${FUNCNAME} should only be run in pkg_postrm()"
264
265 # strip trailing slash
266 myroot="${ROOT%/}"
267
268 if [ $# -gt 0 ]; then
269 for path in $@; do
270 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
271 done
272 else
273 for path in ${myroot}/usr/lib*/python*/site-packages; do
274 SEARCH_PATH="${SEARCH_PATH} ${path}"
275 done
276 fi
277
278 for path in ${SEARCH_PATH}; do
279 einfo "Cleaning orphaned Python bytecode from ${path} .."
280 for obj in $(find ${path} -name '*.py[co]'); do
281 src_py="${obj%[co]}"
282 if [ ! -f "${src_py}" ]; then
283 einfo "Purging ${src_py}[co]"
284 rm -f ${src_py}[co]
285 fi
286 done
287 # attempt to remove directories that maybe empty
288 for dir in $(find ${path} -type d | sort -r); do
289 rmdir ${dir} 2>/dev/null
290 done
291 done
292}

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

  ViewVC Help
Powered by ViewVC 1.1.20