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

Diff of /eclass/python.eclass

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

Revision 1.20 Revision 1.53
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2008 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.20 2005/07/06 20:23:20 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.53 2008/10/27 12:23:50 hawking 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
16if [[ -n "${NEED_PYTHON}" ]] ; then
17 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18 RDEPEND="${DEPEND}"
19fi
23 20
24__python_eclass_test() { 21__python_eclass_test() {
25 __python_version_extract 2.3 22 __python_version_extract 2.3
26 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 23 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
27 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 24 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
32 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 29 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
33 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 30 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
34 __python_version_extract 2.4 31 __python_version_extract 2.4
35 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 32 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 33 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
34 __python_version_extract 2.5b3
35 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37} 37}
38 38
39# 39# @FUNCTION: python_version
40# name: python_disable/enable_pyc 40# @DESCRIPTION:
41# desc: tells python not to automatically recompile modules to .pyc/.pyo
42# even if the timestamps/version stamps don't match. this is
43# done 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
51python_enable_pyc() {
52 unset PYTHON_DONTCOMPILE
53}
54
55python_disable_pyc
56
57#
58# name: python_version
59# desc: run without arguments and it will export the version of python 41# Run without arguments and it will export the version of python
60# currently in use as $PYVER 42# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
61#
62
63__python_version_extract() { 43__python_version_extract() {
64 verstr=$1 44 local verstr=$1
65 export PYVER_MAJOR=${verstr:0:1} 45 export PYVER_MAJOR=${verstr:0:1}
66 export PYVER_MINOR=${verstr:2:1} 46 export PYVER_MINOR=${verstr:2:1}
47 if [[ ${verstr:3:1} == . ]]; then
67 export PYVER_MICRO=${verstr:4} 48 export PYVER_MICRO=${verstr:4}
49 fi
68 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" 50 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
69} 51}
70 52
71python_version() { 53python_version() {
54 [[ -n "${PYVER}" ]] && return 0
72 local tmpstr 55 local tmpstr
73 python=${python:-/usr/bin/python} 56 python=${python:-/usr/bin/python}
74 tmpstr="$(${python} -V 2>&1 )" 57 tmpstr="$(${python} -V 2>&1 )"
75 export PYVER_ALL="${tmpstr#Python }" 58 export PYVER_ALL="${tmpstr#Python }"
76 __python_version_extract $PYVER_ALL 59 __python_version_extract $PYVER_ALL
77} 60}
78 61
62# @FUNCTION: python_disable_pyc
63# @DESCRIPTION:
64# Tells python not to automatically recompile modules to .pyc/.pyo
65# even if the timestamps/version stamps don't match. This is done
66# to protect sandbox.
79# 67#
80# name: python_makesym 68# note: supported by >=dev-lang/python-2.2.3-r3 only.
69#
70python_disable_pyc() {
71 export PYTHONDONTWRITEBYTECODE=1 # For 2.6 and above
72 export PYTHON_DONTCOMPILE=1 # For 2.5 and below
73}
74
75# @FUNCTION: python_enable_pyc
76# @DESCRIPTION:
77# Tells python to automatically recompile modules to .pyc/.pyo if the
78# timestamps/version stamps change
79python_enable_pyc() {
80 unset PYTHONDONTWRITEBYTECODE
81 unset PYTHON_DONTCOMPILE
82}
83
84python_disable_pyc
85
86# @FUNCTION: python_need_rebuild
87# @DESCRIPTION: Run without arguments, specifies that the package should be
88# rebuilt after a python upgrade.
89python_need_rebuild() {
90 python_version
91 export PYTHON_NEED_REBUILD=${PYVER}
92}
93
94# @FUNCTION: python_get_libdir
95# @DESCRIPTION:
96# Run without arguments, returns the python library dir
97python_get_libdir() {
98 python_version
99 echo "/usr/$(get_libdir)/python${PYVER}"
100}
101
102# @FUNCTION: python_get_sitedir
103# @DESCRIPTION:
104# Run without arguments, returns the python site-packages dir
105python_get_sitedir() {
106 echo "$(python_get_libdir)/site-packages"
107}
108
109# @FUNCTION: python_makesym
110# @DESCRIPTION:
81# desc: run without arguments, it will create the /usr/bin/python symlinks 111# Run without arguments, it will create the /usr/bin/python symlinks
82# to the latest installed version 112# to the latest installed version
83#
84python_makesym() { 113python_makesym() {
85 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]" 114 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
86 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]" 115 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
87} 116}
88 117
89#
90# name: python_tkinter_exists 118# @FUNCTION: python_tkinter_exists
119# @DESCRIPTION:
91# desc: run without arguments, checks if python was compiled with Tkinter 120# Run without arguments, checks if python was compiled with Tkinter
92# support. If not, prints an error message and dies. 121# support. If not, prints an error message and dies.
93#
94python_tkinter_exists() { 122python_tkinter_exists() {
95 if ! python -c "import Tkinter" >/dev/null 2>&1; then 123 if ! python -c "import Tkinter" >/dev/null 2>&1; then
96 eerror "You need to recompile python with Tkinter support." 124 eerror "You need to recompile python with Tkinter support."
97 eerror "That means: USE='tcltk' emerge python" 125 eerror "Try adding: 'dev-lang/python tk'"
126 eerror "in to /etc/portage/package.use"
98 echo 127 echo
99 die "missing tkinter support with installed python" 128 die "missing tkinter support with installed python"
100 fi 129 fi
101} 130}
102 131
103# 132# @FUNCTION: python_mod_exists
104# name: python_mod_exists 133# @USAGE: < module >
134# @DESCRIPTION:
105# desc: run with the module name as an argument. it will check if a 135# Run with the module name as an argument. it will check if a
106# python module is installed and loadable. it will return 136# python module is installed and loadable. it will return
107# TRUE(0) if the module exists, and FALSE(1) if the module does 137# TRUE(0) if the module exists, and FALSE(1) if the module does
108# not exist. 138# not exist.
109# exam: 139#
140# Example:
110# if python_mod_exists gtk; then 141# if python_mod_exists gtk; then
111# echo "gtk support enabled 142# echo "gtk support enabled"
112# fi 143# fi
113#
114python_mod_exists() { 144python_mod_exists() {
115 [ -z "$1" ] && die "${FUNCTION} requires an argument!" 145 [[ "$1" ]] && die "${FUNCNAME} requires an argument!"
116 if ! python -c "import $1" >/dev/null 2>&1; then 146 python -c "import $1" >/dev/null 2>&1
117 return 1
118 fi
119 return 0
120} 147}
121 148
122# 149# @FUNCTION: python_mod_compile
123# name: python_mod_compile 150# @USAGE: < file > [more files ...]
151# @DESCRIPTION:
124# desc: given a filename, it will pre-compile the module's .pyc and .pyo. 152# Given filenames, it will pre-compile the module's .pyc and .pyo.
125# should only be run in pkg_postinst() 153# This function should only be run in pkg_postinst()
126# exam: 154#
155# Example:
127# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 156# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
128# 157#
129python_mod_compile() { 158python_mod_compile() {
159 local f myroot myfiles=()
160
161 # Check if phase is pkg_postinst()
162 [[ ${EBUILD_PHASE} != postinst ]] &&\
163 die "${FUNCNAME} should only be run in pkg_postinst()"
164
165 # allow compiling for older python versions
166 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
167 PYVER=${PYTHON_OVERRIDE_PYVER}
168 else
169 python_version
170 fi
171
172 # strip trailing slash
173 myroot="${ROOT%/}"
174
175 # respect ROOT
176 for f in "$@"; do
177 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
178 done
179
180 if ((${#myfiles[@]})); then
181 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
182 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
183 else
184 ewarn "No files to compile!"
185 fi
186}
187
188# @FUNCTION: python_mod_optimize
189# @USAGE: [ path ]
190# @DESCRIPTION:
191# If no arguments supplied, it will recompile all modules under
192# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
193# no recursively
194#
195# If supplied with arguments, it will recompile all modules recursively
196# in the supplied directory
197# This function should only be run in pkg_postinst()
198#
199# Options passed to this function are passed to compileall.py
200#
201# Example:
202# python_mod_optimize /usr/share/codegen
203python_mod_optimize() {
204 local myroot mydirs=() myfiles=() myopts=()
205
206 # Check if phase is pkg_postinst()
207 [[ ${EBUILD_PHASE} != postinst ]] &&\
208 die "${FUNCNAME} should only be run in pkg_postinst()"
209
210 # strip trailing slash
211 myroot="${ROOT%/}"
212
213 # respect ROOT and options passed to compileall.py
214 while (($#)); do
215 case $1 in
216 -l|-f|-q)
217 myopts+=("$1")
218 ;;
219 -d|-x)
220 myopts+=("$1" "$2")
221 shift
222 ;;
223 -*)
224 ewarn "${FUNCNAME}: Ignoring compile option $1"
225 ;;
226 *)
227 if [[ -d "${myroot}"/$1 ]]; then
228 mydirs+=("${myroot}/$1")
229 elif [[ -f "${myroot}"/$1 ]]; then
230 # Files are passed to python_mod_compile which is ROOT-aware
231 myfiles+=("$1")
232 elif [[ -e "${myroot}/$1" ]]; then
233 ewarn "${myroot}/$1 is not a file or directory!"
234 else
235 ewarn "${myroot}/$1 doesn't exist!"
236 fi
237 ;;
238 esac
239 shift
240 done
241
130 # allow compiling for older python versions 242 # allow compiling for older python versions
131 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 243 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
132 PYVER=${PYTHON_OVERRIDE_PYVER} 244 PYVER=${PYTHON_OVERRIDE_PYVER}
133 else 245 else
134 python_version 246 python_version
135 fi 247 fi
136 248
137 if [ -f "$1" ]; then 249 # set additional opts
138 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \ 250 myopts+=(-q)
139 ewarn "Failed to compile ${1}"
140 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
141 ewarn "Failed to compile ${1}"
142 else
143 ewarn "Unable to find ${1}"
144 fi
145}
146 251
252 ebegin "Byte compiling python modules for python-${PYVER} .."
253 if ((${#mydirs[@]})); then
254 python${PYVER} \
255 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
256 "${myopts[@]}" "${mydirs[@]}"
257 python${PYVER} -O \
258 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
259 "${myopts[@]}" "${mydirs[@]}"
260 fi
261
262 if ((${#myfiles[@]})); then
263 python_mod_compile "${myfiles[@]}"
264 fi
265
266 eend $?
267}
268
269# @FUNCTION: python_mod_cleanup
270# @USAGE: [ dir ]
271# @DESCRIPTION:
272# Run with optional arguments, where arguments are directories of
273# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
147# 274#
148# name: python_mod_optimize 275# It will recursively scan all compiled python modules in the directories
149# desc: if no arguments supplied, it will recompile all modules under 276# and determine if they are orphaned (eg. their corresponding .py is missing.)
150# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) 277# if they are, then it will remove their corresponding .pyc and .pyo
151# no recursively
152# 278#
153# if supplied with arguments, it will recompile all modules recursively 279# This function should only be run in pkg_postrm()
154# in the supplied directory 280python_mod_cleanup() {
155# exam: 281 local SEARCH_PATH=() myroot src_py
156# python_mod_optimize ${ROOT}usr/share/codegen 282
157# 283 # Check if phase is pkg_postrm()
158python_mod_optimize() { 284 [[ ${EBUILD_PHASE} != postrm ]] &&\
159 local myroot 285 die "${FUNCNAME} should only be run in pkg_postrm()"
286
160 # strip trailing slash 287 # strip trailing slash
161 myroot="${ROOT%/}" 288 myroot="${ROOT%/}"
162 289
163 # allow compiling for older python versions 290 if (($#)); then
164 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 291 SEARCH_PATH=("${@#/}")
165 PYVER=${PYTHON_OVERRIDE_PYVER} 292 SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
166 else 293 else
167 python_version 294 SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
168 fi 295 fi
169 296
170 # set opts
171 if [ "${PYVER}" = "2.2" ]; then
172 compileopts=""
173 else
174 compileopts="-q"
175 fi
176
177 ebegin "Byte compiling python modules for python-${PYVER} .."
178 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
179 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
180 eend $?
181}
182
183#
184# name: python_mod_cleanup
185# desc: run with optional arguments, where arguments are directories of
186# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
187#
188# it will recursively scan all compiled python modules in the directories
189# and determine if they are orphaned (eg. their corresponding .py is missing.)
190# if they are, then it will remove their corresponding .pyc and .pyo
191#
192python_mod_cleanup() {
193 local SEARCH_PATH myroot
194
195 # strip trailing slash
196 myroot="${ROOT%/}"
197
198 if [ $# -gt 0 ]; then
199 for path in $@; do
200 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
201 done
202 else
203 for path in ${myroot}/usr/lib*/python*/site-packages; do
204 SEARCH_PATH="${SEARCH_PATH} ${path}"
205 done
206 fi
207
208 for path in ${SEARCH_PATH}; do 297 for path in "${SEARCH_PATH[@]}"; do
209 einfo "Cleaning orphaned Python bytecode from ${path} .." 298 einfo "Cleaning orphaned Python bytecode from ${path} .."
210 for obj in $(find ${path} -name *.pyc); do 299 while read -rd ''; do
211 src_py="${obj%c}" 300 src_py="${REPLY%[co]}"
212 if [ ! -f "${src_py}" ]; then 301 [[ -f "${src_py}" ]] && continue
213 einfo "Purging ${src_py}[co]" 302 einfo "Purging ${src_py}[co]"
214 rm -f ${src_py}[co] 303 rm -f "${src_py}"[co]
215 fi 304 done < <(find "${path}" -name '*.py[co]' -print0)
216 done 305
217 # attempt to remove directories that maybe empty 306 # attempt to remove directories that maybe empty
218 for dir in $(find ${path} -type d | sort -r); do 307 while read -r dir; do
219 rmdir ${dir} 2>/dev/null 308 rmdir "${dir}" 2>/dev/null
220 done 309 done < <(find "${path}" -type d | sort -r)
221 done 310 done
222} 311}

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.53

  ViewVC Help
Powered by ViewVC 1.1.20