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

Diff of /eclass/python.eclass

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

Revision 1.3 Revision 1.39
1# Copyright 1999-2003 Gentoo Technologies, Inc. 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.3 2003/10/09 08:57:20 liquidx 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
22ECLASS="python"
23INHERITED="$INHERITED $ECLASS"
24 15
16if [[ -n "${NEED_PYTHON}" ]] ; then
17 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18 RDEPEND="${DEPEND}"
19fi
20
21__python_eclass_test() {
22 __python_version_extract 2.3
23 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
24 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
25 __python_version_extract 2.3.4
26 echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
27 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
28 __python_version_extract 2.3.5
29 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
30 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
31 __python_version_extract 2.4
32 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
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}
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#
25python_disable_pyc() { 47python_disable_pyc() {
26 export PYTHON_DONTCOMPILE=1 48 export PYTHON_DONTCOMPILE=1
27} 49}
28 50
29# 51# @FUNCTION: python_enable_pyc
30# name: python_version 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
62# @DESCRIPTION:
31# desc: run without arguments and it will export the version of python 63# Run without arguments and it will export the version of python
32# currently in use as $PYVER 64# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
33# 65__python_version_extract() {
66 verstr=$1
67 export PYVER_MAJOR=${verstr:0:1}
68 export PYVER_MINOR=${verstr:2:1}
69 if [ "${verstr:3}x" = ".x" ]; then
70 export PYVER_MICRO=${verstr:4}
71 fi
72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73}
74
34python_version() { 75python_version() {
35 local tmpstr 76 local tmpstr
36 python=${python:-/usr/bin/python} 77 python=${python:-/usr/bin/python}
37 tmpstr="$(${python} -V 2>&1 )" 78 tmpstr="$(${python} -V 2>&1 )"
38 export PYVER_ALL="${tmpstr#Python }" 79 export PYVER_ALL="${tmpstr#Python }"
39 80 __python_version_extract $PYVER_ALL
40 export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1)
41 export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2)
42 export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-)
43 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
44} 81}
45 82
46# 83# @FUNCTION: python_makesym
47# name: python_makesym 84# @DESCRIPTION:
48# desc: run without arguments, it will create the /usr/bin/python symlinks 85# Run without arguments, it will create the /usr/bin/python symlinks
49# to the latest installed version 86# to the latest installed version
50#
51python_makesym() { 87python_makesym() {
52 alternatives_auto_makesym "/usr/bin/python" "/usr/bin/python[0-9].[0-9]" 88 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
53 alternatives_auto_makesym "/usr/bin/python2" "/usr/bin/python[0-9].[0-9]" 89 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
54} 90}
55 91
56#
57# name: python_tkinter_exists 92# @FUNCTION: python_tkinter_exists
58# desc: run without arguments, it will return TRUE(0) if python is compiled 93# @DESCRIPTION:
59# with tkinter or FALSE(1) if python is compiled without tkinter. 94# Run without arguments, checks if python was compiled with Tkinter
60# 95# support. If not, prints an error message and dies.
61python_tkinter_exists() { 96python_tkinter_exists() {
62 if ! python -c "import Tkinter" >/dev/null 2>&1; then 97 if ! python -c "import Tkinter" >/dev/null 2>&1; then
63 eerror "You need to recompile python with Tkinter support." 98 eerror "You need to recompile python with Tkinter support."
64 eerror "That means: USE='tcltk' emerge python" 99 eerror "Try adding: 'dev-lang/python tk'"
100 eerror "in to /etc/portage/package.use"
65 echo 101 echo
66 die "missing tkinter support with installed python" 102 die "missing tkinter support with installed python"
67 fi 103 fi
68} 104}
69 105
70# 106# @FUNCTION: python_mod_exists
71# name: python_mod_exists 107# @USAGE: < module >
108# @DESCRIPTION:
72# 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
73# python module is installed and loadable. it will return 110# python module is installed and loadable. it will return
74# 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
75# not exist. 112# not exist.
76# exam: 113#
114# Example:
77# if python_mod_exists gtk; then 115# if python_mod_exists gtk; then
78# echo "gtk support enabled 116# echo "gtk support enabled"
79# fi 117# fi
80#
81python_mod_exists() { 118python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
82 if ! python -c "import $1" >/dev/null 2>&1; then 120 if ! python -c "import $1" >/dev/null 2>&1; then
83 return 1 121 return 1
84 fi 122 fi
85 return 0 123 return 0
86} 124}
87 125
88# 126# @FUNCTION: python_mod_compile
89# name: python_mod_compile 127# @USAGE: < file > [more files ...]
128# @DESCRIPTION:
90# 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.
91# should only be run in pkg_postinst() 130# This function should only be run in pkg_postinst()
92# exam: 131#
132# Example:
93# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 133# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
94# 134#
95python_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
142 # allow compiling for older python versions
143 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
144 PYVER=${PYTHON_OVERRIDE_PYVER}
145 else
146 python_version
147 fi
148
149 # strip trailing slash
150 myroot="${ROOT%/}"
151
152 # respect ROOT
153 for f in $@; do
154 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
155 done
156
96 if [ -f "$1" ]; then 157 if [ -n "${myfiles}" ]; then
97 python -c "import py_compile; py_compile.compile('${1}')" || \ 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
98 ewarn "Failed to compile ${1}" 161 ewarn "No files to compile!"
99 python -O -c "import py_compile; py_compile.compile('${1}')" || \
100 ewarn "Failed to compile ${1}"
101 else
102 ewarn "Unable to find ${1}"
103 fi 162 fi
104} 163}
105 164
106#
107# name: python_mod_optimize 165# @FUNCTION: python_mod_optimize
166# @USAGE: [ path ]
167# @DESCRIPTION:
108# desc: if no arguments supplied, it will recompile all modules under 168# If no arguments supplied, it will recompile all modules under
109# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) 169# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
110# no recursively 170# no recursively
111# 171#
112# if supplied with arguments, it will recompile all modules recursively 172# If supplied with arguments, it will recompile all modules recursively
113# in the supplied directory 173# in the supplied directory
114# exam: 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:
115# python_mod_optimize ${ROOT}usr/share/codegen 179# python_mod_optimize /usr/share/codegen
116#
117python_mod_optimize() { 180python_mod_optimize() {
118 einfo "Byte Compiling Python modules .." 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
215
216 # allow compiling for older python versions
217 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
218 PYVER=${PYTHON_OVERRIDE_PYVER}
219 else
119 python_version 220 python_version
120 echo ${PYVER} 221 fi
121 python ${ROOT}usr/lib/python${PYVER}/compileall.py $@
122}
123 222
124# 223 # set opts
125# name: python_mod_cleanup 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}
246
247# @FUNCTION: python_mod_cleanup
248# @USAGE: [ dir ]
249# @DESCRIPTION:
126# desc: run with optional arguments, where arguments are directories of 250# Run with optional arguments, where arguments are directories of
127# 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]
128# 252#
129# it will recursively scan all compiled python modules in the directories 253# It will recursively scan all compiled python modules in the directories
130# 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.)
131# 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
132# 256#
257# This function should only be run in pkg_postrm()
133python_mod_cleanup() { 258python_mod_cleanup() {
134 local SEARCH_PATH 259 local SEARCH_PATH myroot
135 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
136 for path in $@; do 269 for path in $@; do
137 SEARCH_PATH="${SEARCH_PATH} ${ROOT}${dir}" 270 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
138 done 271 done
139 272 else
140 for path in ${ROOT}usr/lib/python*/site-packages; do 273 for path in ${myroot}/usr/lib*/python*/site-packages; do
141 SEARCH_PATH="${SEARCH_PATH} ${path}" 274 SEARCH_PATH="${SEARCH_PATH} ${path}"
142 done 275 done
143 276 fi
277
144 for path in ${SEARCH_PATH}; do 278 for path in ${SEARCH_PATH}; do
145 einfo "Searching ${path} .." 279 einfo "Cleaning orphaned Python bytecode from ${path} .."
146 for obj in $(find ${path} -name *.pyc); do 280 for obj in $(find ${path} -name '*.py[co]'); do
147 src_py="$(echo $obj | sed 's:c$::')" 281 src_py="${obj%[co]}"
148 if [ ! -f "${src_py}" ]; then 282 if [ ! -f "${src_py}" ]; then
149 einfo "Purging ${src_py}[co]" 283 einfo "Purging ${src_py}[co]"
150 rm -f ${src_py}[co] 284 rm -f ${src_py}[co]
151 fi 285 fi
152 done 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
153 done 291 done
154} 292}
155
156
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.39
  ViewVC Help
Powered by ViewVC 1.1.13