/[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.43
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.43 2008/08/01 22:22:21 pythonhead 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_get_libdir
84# name: python_makesym 84# @DESCRIPTION:
85# Run without arguments, returns the python library dir
86python_get_libdir() {
87 python_version
88 echo "/usr/$(get_libdir)/python${PYVER}"
89}
90
91# @FUNCTION: python_get_sitedir
92# @DESCRIPTION:
93# Run without arguments, returns the python site-packages dir
94python_get_sitedir() {
95 echo "$(python_get_libdir)/site-packages"
96}
97
98# @FUNCTION: python_makesym
99# @DESCRIPTION:
85# desc: run without arguments, it will create the /usr/bin/python symlinks 100# Run without arguments, it will create the /usr/bin/python symlinks
86# to the latest installed version 101# to the latest installed version
87#
88python_makesym() { 102python_makesym() {
89 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]" 103 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
90 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]" 104 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
91} 105}
92 106
93#
94# name: python_tkinter_exists 107# @FUNCTION: python_tkinter_exists
108# @DESCRIPTION:
95# desc: run without arguments, checks if python was compiled with Tkinter 109# Run without arguments, checks if python was compiled with Tkinter
96# support. If not, prints an error message and dies. 110# support. If not, prints an error message and dies.
97#
98python_tkinter_exists() { 111python_tkinter_exists() {
99 if ! python -c "import Tkinter" >/dev/null 2>&1; then 112 if ! python -c "import Tkinter" >/dev/null 2>&1; then
100 eerror "You need to recompile python with Tkinter support." 113 eerror "You need to recompile python with Tkinter support."
101 eerror "That means: USE='tcltk' emerge python" 114 eerror "Try adding: 'dev-lang/python tk'"
115 eerror "in to /etc/portage/package.use"
102 echo 116 echo
103 die "missing tkinter support with installed python" 117 die "missing tkinter support with installed python"
104 fi 118 fi
105} 119}
106 120
107# 121# @FUNCTION: python_mod_exists
108# name: python_mod_exists 122# @USAGE: < module >
123# @DESCRIPTION:
109# desc: run with the module name as an argument. it will check if a 124# Run with the module name as an argument. it will check if a
110# python module is installed and loadable. it will return 125# python module is installed and loadable. it will return
111# TRUE(0) if the module exists, and FALSE(1) if the module does 126# TRUE(0) if the module exists, and FALSE(1) if the module does
112# not exist. 127# not exist.
113# exam: 128#
129# Example:
114# if python_mod_exists gtk; then 130# if python_mod_exists gtk; then
115# echo "gtk support enabled 131# echo "gtk support enabled"
116# fi 132# fi
117#
118python_mod_exists() { 133python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!" 134 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then 135 if ! python -c "import $1" >/dev/null 2>&1; then
121 return 1 136 return 1
122 fi 137 fi
123 return 0 138 return 0
124} 139}
125 140
126# 141# @FUNCTION: python_mod_compile
127# name: python_mod_compile 142# @USAGE: < file > [more files ...]
143# @DESCRIPTION:
128# desc: given a filename, it will pre-compile the module's .pyc and .pyo. 144# Given filenames, it will pre-compile the module's .pyc and .pyo.
129# should only be run in pkg_postinst() 145# This function should only be run in pkg_postinst()
130# exam: 146#
147# Example:
131# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 148# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
132# 149#
133python_mod_compile() { 150python_mod_compile() {
151 local f myroot
152
153 # Check if phase is pkg_postinst()
154 [[ ${EBUILD_PHASE} != postinst ]] &&\
155 die "${FUNCNAME} should only be run in pkg_postinst()"
156
134 # allow compiling for older python versions 157 # allow compiling for older python versions
135 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 158 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
136 PYVER=${PYTHON_OVERRIDE_PYVER} 159 PYVER=${PYTHON_OVERRIDE_PYVER}
137 else 160 else
138 python_version 161 python_version
139 fi 162 fi
140 163
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 164 # strip trailing slash
165 myroot="${ROOT%/}" 165 myroot="${ROOT%/}"
166
167 # respect ROOT
168 for f in $@; do
169 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
170 done
171
172 if [ -n "${myfiles}" ]; then
173 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
174 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
175 else
176 ewarn "No files to compile!"
177 fi
178}
179
180# @FUNCTION: python_mod_optimize
181# @USAGE: [ path ]
182# @DESCRIPTION:
183# If no arguments supplied, it will recompile all modules under
184# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
185# no recursively
186#
187# If supplied with arguments, it will recompile all modules recursively
188# in the supplied directory
189# This function should only be run in pkg_postinst()
190#
191# Options passed to this function are passed to compileall.py
192#
193# Example:
194# python_mod_optimize /usr/share/codegen
195python_mod_optimize() {
196 local mydirs myfiles myroot myopts
197
198 # Check if phase is pkg_postinst()
199 [[ ${EBUILD_PHASE} != postinst ]] &&\
200 die "${FUNCNAME} should only be run in pkg_postinst()"
201
202 # strip trailing slash
203 myroot="${ROOT%/}"
204
205 # respect ROOT and options passed to compileall.py
206 while [ $# -gt 0 ]; do
207 case $1 in
208 -l|-f|-q)
209 myopts="${myopts} $1"
210 ;;
211 -d|-x)
212 myopts="${myopts} $1 $2"
213 shift
214 ;;
215 -*)
216 ewarn "${FUNCNAME}: Ignoring compile option $1"
217 ;;
218 *)
219 [ ! -e "${myroot}/${1}" ] && ewarn "${myroot}/${1} doesn't exist!"
220 [ -d "${myroot}/${1#/}" ] && mydirs="${mydirs} ${myroot}/${1#/}"
221 # Files are passed to python_mod_compile which is ROOT-aware
222 [ -f "${myroot}/${1}" ] && myfiles="${myfiles} ${1}"
223 ;;
224 esac
225 shift
226 done
166 227
167 # allow compiling for older python versions 228 # allow compiling for older python versions
168 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 229 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
169 PYVER=${PYTHON_OVERRIDE_PYVER} 230 PYVER=${PYTHON_OVERRIDE_PYVER}
170 else 231 else
171 python_version 232 python_version
172 fi 233 fi
173 234
174 # set opts 235 # set additional opts
175 if [ "${PYVER}" = "2.2" ]; then 236 myopts="${myopts} -q"
176 compileopts=""
177 else
178 compileopts="-q"
179 fi
180 237
181 ebegin "Byte compiling python modules for python-${PYVER} .." 238 ebegin "Byte compiling python modules for python-${PYVER} .."
182 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 239 if [ -n "${mydirs}" ]; then
183 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 240 python${PYVER} \
241 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
242 ${myopts} ${mydirs}
243 python${PYVER} -O \
244 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
245 ${myopts} ${mydirs}
246 fi
247
248 if [ -n "${myfiles}" ]; then
249 python_mod_compile ${myfiles}
250 fi
251
184 eend $? 252 eend $?
185} 253}
186 254
187# 255# @FUNCTION: python_mod_cleanup
188# name: python_mod_cleanup 256# @USAGE: [ dir ]
257# @DESCRIPTION:
189# desc: run with optional arguments, where arguments are directories of 258# 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] 259# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
191# 260#
192# it will recursively scan all compiled python modules in the directories 261# It will recursively scan all compiled python modules in the directories
193# and determine if they are orphaned (eg. their corresponding .py is missing.) 262# 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 263# if they are, then it will remove their corresponding .pyc and .pyo
195# 264#
265# This function should only be run in pkg_postrm()
196python_mod_cleanup() { 266python_mod_cleanup() {
197 local SEARCH_PATH myroot 267 local SEARCH_PATH myroot
268
269 # Check if phase is pkg_postrm()
270 [[ ${EBUILD_PHASE} != postrm ]] &&\
271 die "${FUNCNAME} should only be run in pkg_postrm()"
198 272
199 # strip trailing slash 273 # strip trailing slash
200 myroot="${ROOT%/}" 274 myroot="${ROOT%/}"
201 275
202 if [ $# -gt 0 ]; then 276 if [ $# -gt 0 ]; then
209 done 283 done
210 fi 284 fi
211 285
212 for path in ${SEARCH_PATH}; do 286 for path in ${SEARCH_PATH}; do
213 einfo "Cleaning orphaned Python bytecode from ${path} .." 287 einfo "Cleaning orphaned Python bytecode from ${path} .."
214 for obj in $(find ${path} -name *.pyc); do 288 for obj in $(find ${path} -name '*.py[co]'); do
215 src_py="${obj%c}" 289 src_py="${obj%[co]}"
216 if [ ! -f "${src_py}" ]; then 290 if [ ! -f "${src_py}" ]; then
217 einfo "Purging ${src_py}[co]" 291 einfo "Purging ${src_py}[co]"
218 rm -f ${src_py}[co] 292 rm -f ${src_py}[co]
219 fi 293 fi
220 done 294 done

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

  ViewVC Help
Powered by ViewVC 1.1.20