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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.41

  ViewVC Help
Powered by ViewVC 1.1.20