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

Diff of /eclass/python.eclass

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

Revision 1.36 Revision 1.53
1# Copyright 1999-2008 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.36 2008/05/29 15:24:35 hawking Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.53 2008/10/27 12:23:50 hawking 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#
… …
34 __python_version_extract 2.5b3 34 __python_version_extract 2.5b3
35 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 35 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37} 37}
38 38
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 39# @FUNCTION: python_version
62# @DESCRIPTION: 40# @DESCRIPTION:
63# Run without arguments and it will export the version of python 41# Run without arguments and it will export the version of python
64# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR 42# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65__python_version_extract() { 43__python_version_extract() {
66 verstr=$1 44 local verstr=$1
67 export PYVER_MAJOR=${verstr:0:1} 45 export PYVER_MAJOR=${verstr:0:1}
68 export PYVER_MINOR=${verstr:2:1} 46 export PYVER_MINOR=${verstr:2:1}
69 if [ "${verstr:3}x" = ".x" ]; then 47 if [[ ${verstr:3:1} == . ]]; then
70 export PYVER_MICRO=${verstr:4} 48 export PYVER_MICRO=${verstr:4}
71 fi 49 fi
72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" 50 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73} 51}
74 52
75python_version() { 53python_version() {
54 [[ -n "${PYVER}" ]] && return 0
76 local tmpstr 55 local tmpstr
77 python=${python:-/usr/bin/python} 56 python=${python:-/usr/bin/python}
78 tmpstr="$(${python} -V 2>&1 )" 57 tmpstr="$(${python} -V 2>&1 )"
79 export PYVER_ALL="${tmpstr#Python }" 58 export PYVER_ALL="${tmpstr#Python }"
80 __python_version_extract $PYVER_ALL 59 __python_version_extract $PYVER_ALL
60}
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.
67#
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"
81} 107}
82 108
83# @FUNCTION: python_makesym 109# @FUNCTION: python_makesym
84# @DESCRIPTION: 110# @DESCRIPTION:
85# Run without arguments, it will create the /usr/bin/python symlinks 111# Run without arguments, it will create the /usr/bin/python symlinks
… …
114# Example: 140# Example:
115# if python_mod_exists gtk; then 141# if python_mod_exists gtk; then
116# echo "gtk support enabled" 142# echo "gtk support enabled"
117# fi 143# fi
118python_mod_exists() { 144python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!" 145 [[ "$1" ]] && die "${FUNCNAME} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then 146 python -c "import $1" >/dev/null 2>&1
121 return 1
122 fi
123 return 0
124} 147}
125 148
126# @FUNCTION: python_mod_compile 149# @FUNCTION: python_mod_compile
127# @USAGE: < file > [more files ...] 150# @USAGE: < file > [more files ...]
128# @DESCRIPTION: 151# @DESCRIPTION:
129# Given filenames, it will pre-compile the module's .pyc and .pyo. 152# Given filenames, it will pre-compile the module's .pyc and .pyo.
130# should only be run in pkg_postinst() 153# This function should only be run in pkg_postinst()
131# 154#
132# Example: 155# Example:
133# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py 156# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
134# 157#
135python_mod_compile() { 158python_mod_compile() {
136 local f myroot 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
137 # allow compiling for older python versions 242 # allow compiling for older python versions
138 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 243 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
139 PYVER=${PYTHON_OVERRIDE_PYVER} 244 PYVER=${PYTHON_OVERRIDE_PYVER}
140 else 245 else
141 python_version 246 python_version
142 fi 247 fi
143 248
144 # strip trailing slash 249 # set additional opts
145 myroot="${ROOT%/}" 250 myopts+=(-q)
146
147 # respect ROOT
148 for f in $@; do
149 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
150 done
151
152 if [ -n "${myfiles}" ]; then
153 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
154 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
155 else
156 ewarn "No files to compile!"
157 fi
158}
159
160# @FUNCTION: python_mod_optimize
161# @USAGE: [ path ]
162# @DESCRIPTION:
163# If no arguments supplied, it will recompile all modules under
164# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
165# no recursively
166#
167# If supplied with arguments, it will recompile all modules recursively
168# in the supplied directory
169#
170# Example:
171# python_mod_optimize /usr/share/codegen
172python_mod_optimize() {
173 local mydirs myfiles myroot path
174 # strip trailing slash
175 myroot="${ROOT%/}"
176
177 # respect ROOT
178 for path in $@; do
179 [ ! -e "${myroot}/${path}" ] && ewarn "${myroot}/${path} doesn't exist!"
180 [ -d "${myroot}/${path#/}" ] && mydirs="${mydirs} ${myroot}/${path#/}"
181 # Files are passed to python_mod_compile which is ROOT-aware
182 [ -f "${myroot}/${path}" ] && myfiles="${myfiles} ${path}"
183 done
184
185 # allow compiling for older python versions
186 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
187 PYVER=${PYTHON_OVERRIDE_PYVER}
188 else
189 python_version
190 fi
191
192 # set opts
193 if [ "${PYVER}" = "2.2" ]; then
194 compileopts=""
195 else
196 compileopts="-q"
197 fi
198 251
199 ebegin "Byte compiling python modules for python-${PYVER} .." 252 ebegin "Byte compiling python modules for python-${PYVER} .."
200 if [ -n "${mydirs}" ]; then 253 if ((${#mydirs[@]})); then
201 python${PYVER} \ 254 python${PYVER} \
202 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \ 255 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
203 ${compileopts} ${mydirs} 256 "${myopts[@]}" "${mydirs[@]}"
204 python${PYVER} -O \ 257 python${PYVER} -O \
205 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \ 258 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
206 ${compileopts} ${mydirs} 259 "${myopts[@]}" "${mydirs[@]}"
207 fi 260 fi
208 261
209 if [ -n "${myfiles}" ]; then 262 if ((${#myfiles[@]})); then
210 python_mod_compile ${myfiles} 263 python_mod_compile "${myfiles[@]}"
211 fi 264 fi
212 265
213 eend $? 266 eend $?
214} 267}
215 268
… …
220# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9] 273# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
221# 274#
222# It will recursively scan all compiled python modules in the directories 275# It will recursively scan all compiled python modules in the directories
223# and determine if they are orphaned (eg. their corresponding .py is missing.) 276# and determine if they are orphaned (eg. their corresponding .py is missing.)
224# if they are, then it will remove their corresponding .pyc and .pyo 277# if they are, then it will remove their corresponding .pyc and .pyo
278#
279# This function should only be run in pkg_postrm()
225python_mod_cleanup() { 280python_mod_cleanup() {
226 local SEARCH_PATH myroot 281 local SEARCH_PATH=() myroot src_py
282
283 # Check if phase is pkg_postrm()
284 [[ ${EBUILD_PHASE} != postrm ]] &&\
285 die "${FUNCNAME} should only be run in pkg_postrm()"
227 286
228 # strip trailing slash 287 # strip trailing slash
229 myroot="${ROOT%/}" 288 myroot="${ROOT%/}"
230 289
231 if [ $# -gt 0 ]; then 290 if (($#)); then
232 for path in $@; do 291 SEARCH_PATH=("${@#/}")
233 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}" 292 SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
234 done
235 else 293 else
236 for path in ${myroot}/usr/lib*/python*/site-packages; do 294 SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
237 SEARCH_PATH="${SEARCH_PATH} ${path}"
238 done
239 fi 295 fi
240 296
241 for path in ${SEARCH_PATH}; do 297 for path in "${SEARCH_PATH[@]}"; do
242 einfo "Cleaning orphaned Python bytecode from ${path} .." 298 einfo "Cleaning orphaned Python bytecode from ${path} .."
243 for obj in $(find ${path} -name '*.py[co]'); do 299 while read -rd ''; do
244 src_py="${obj%[co]}" 300 src_py="${REPLY%[co]}"
245 if [ ! -f "${src_py}" ]; then 301 [[ -f "${src_py}" ]] && continue
246 einfo "Purging ${src_py}[co]" 302 einfo "Purging ${src_py}[co]"
247 rm -f ${src_py}[co] 303 rm -f "${src_py}"[co]
248 fi 304 done < <(find "${path}" -name '*.py[co]' -print0)
249 done 305
250 # attempt to remove directories that maybe empty 306 # attempt to remove directories that maybe empty
251 for dir in $(find ${path} -type d | sort -r); do 307 while read -r dir; do
252 rmdir ${dir} 2>/dev/null 308 rmdir "${dir}" 2>/dev/null
253 done 309 done < <(find "${path}" -type d | sort -r)
254 done 310 done
255} 311}
Legend:
Removed from v.1.36  
changed lines
  Added in v.1.53
  ViewVC Help
Powered by ViewVC 1.1.13