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

Diff of /eclass/python.eclass

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

Revision 1.33 Revision 1.54
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.33 2008/02/28 20:20:32 dev-zero Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.54 2008/10/30 05:21:46 zmedico 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 > 150# @USAGE: < file > [more files ...]
128# @DESCRIPTION: 151# @DESCRIPTION:
129# 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.
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 ${ROOT}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() {
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
136 # allow compiling for older python versions 242 # allow compiling for older python versions
137 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 243 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
138 PYVER=${PYTHON_OVERRIDE_PYVER} 244 PYVER=${PYTHON_OVERRIDE_PYVER}
139 else 245 else
140 python_version 246 python_version
141 fi 247 fi
142 248
143 if [ -f "$1" ]; then 249 # set additional opts
144 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \ 250 myopts+=(-q)
145 ewarn "Failed to compile ${1}"
146 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
147 ewarn "Failed to compile ${1}"
148 else
149 ewarn "Unable to find ${1}"
150 fi
151}
152
153# @FUNCTION: python_mod_optimize
154# @USAGE: [ path ]
155# @DESCRIPTION:
156# If no arguments supplied, it will recompile all modules under
157# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
158# no recursively
159#
160# If supplied with arguments, it will recompile all modules recursively
161# in the supplied directory
162#
163# Example:
164# python_mod_optimize ${ROOT}usr/share/codegen
165python_mod_optimize() {
166 local myroot
167 # strip trailing slash
168 myroot="${ROOT%/}"
169
170 # allow compiling for older python versions
171 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
172 PYVER=${PYTHON_OVERRIDE_PYVER}
173 else
174 python_version
175 fi
176
177 # set opts
178 if [ "${PYVER}" = "2.2" ]; then
179 compileopts=""
180 else
181 compileopts="-q"
182 fi
183 251
184 ebegin "Byte compiling python modules for python-${PYVER} .." 252 ebegin "Byte compiling python modules for python-${PYVER} .."
253 if ((${#mydirs[@]})); then
254 python${PYVER} \
185 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@ 255 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
186 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@ 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
187 eend $? 266 eend $?
188} 267}
189 268
190# @FUNCTION: python_mod_cleanup 269# @FUNCTION: python_mod_cleanup
191# @USAGE: [ dir ] 270# @USAGE: [ dir ]
194# 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]
195# 274#
196# It will recursively scan all compiled python modules in the directories 275# It will recursively scan all compiled python modules in the directories
197# 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.)
198# 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()
199python_mod_cleanup() { 280python_mod_cleanup() {
200 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()"
201 286
202 # strip trailing slash 287 # strip trailing slash
203 myroot="${ROOT%/}" 288 myroot="${ROOT%/}"
204 289
205 if [ $# -gt 0 ]; then 290 if (($#)); then
206 for path in $@; do 291 SEARCH_PATH=("${@#/}")
207 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}" 292 SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
293 else
294 SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
295 fi
296
297 for path in "${SEARCH_PATH[@]}"; do
298 einfo "Cleaning orphaned Python bytecode from ${path} .."
299 find "${path}" -name '*.py[co]' -print0 | while read -rd ''; do
300 src_py="${REPLY%[co]}"
301 [[ -f "${src_py}" ]] && continue
302 einfo "Purging ${src_py}[co]"
303 rm -f "${src_py}"[co]
208 done 304 done
209 else
210 for path in ${myroot}/usr/lib*/python*/site-packages; do
211 SEARCH_PATH="${SEARCH_PATH} ${path}"
212 done
213 fi
214 305
215 for path in ${SEARCH_PATH}; do
216 einfo "Cleaning orphaned Python bytecode from ${path} .."
217 for obj in $(find ${path} -name *.py[co]); do
218 src_py="${obj%[co]}"
219 if [ ! -f "${src_py}" ]; then
220 einfo "Purging ${src_py}[co]"
221 rm -f ${src_py}[co]
222 fi
223 done
224 # attempt to remove directories that maybe empty 306 # attempt to remove directories that maybe empty
225 for dir in $(find ${path} -type d | sort -r); do 307 find "${path}" -type d | sort -r | while read -r dir; do
226 rmdir ${dir} 2>/dev/null 308 rmdir "${dir}" 2>/dev/null
227 done 309 done
228 done 310 done
229} 311}

Legend:
Removed from v.1.33  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20