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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.20