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

Diff of /eclass/python.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20