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

Diff of /eclass/python.eclass

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

Revision 1.5 Revision 1.41
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.5 2003/10/17 07:14:26 liquidx 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
22ECLASS="python"
23INHERITED="$INHERITED $ECLASS"
24 15
25# 16if [[ -n "${NEED_PYTHON}" ]] ; then
26# name: python_disable/enable_pyc 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:
27# desc: tells python not to automatically recompile modules to .pyc/.pyo 41# Tells python not to automatically recompile modules to .pyc/.pyo
28# even if the timestamps/version stamps don't match. this is 42# even if the timestamps/version stamps don't match. This is done
29# done to protect sandbox. 43# to protect sandbox.
30# 44#
31# note: supported by >=dev-lang/python-2.2.3-r3 only. 45# note: supported by >=dev-lang/python-2.2.3-r3 only.
32# 46#
33python_disable_pyc() { 47python_disable_pyc() {
34 export PYTHON_DONTCOMPILE=1 48 export PYTHON_DONTCOMPILE=1
35} 49}
36 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
37python_enable_pyc() { 55python_enable_pyc() {
38 unset PYTHON_DONTCOMPILE 56 unset PYTHON_DONTCOMPILE
39} 57}
40 58
41python_disable_pyc 59python_disable_pyc
42 60
43# 61# @FUNCTION: python_version
44# name: python_version 62# @DESCRIPTION:
45# desc: run without arguments and it will export the version of python 63# Run without arguments and it will export the version of python
46# currently in use as $PYVER 64# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
47# 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
48python_version() { 75python_version() {
49 local tmpstr 76 local tmpstr
50 python=${python:-/usr/bin/python} 77 python=${python:-/usr/bin/python}
51 tmpstr="$(${python} -V 2>&1 )" 78 tmpstr="$(${python} -V 2>&1 )"
52 export PYVER_ALL="${tmpstr#Python }" 79 export PYVER_ALL="${tmpstr#Python }"
53 80 __python_version_extract $PYVER_ALL
54 export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1)
55 export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2)
56 export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-)
57 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
58} 81}
59 82
60# 83# @FUNCTION: python_makesym
61# name: python_makesym 84# @DESCRIPTION:
62# desc: run without arguments, it will create the /usr/bin/python symlinks 85# Run without arguments, it will create the /usr/bin/python symlinks
63# to the latest installed version 86# to the latest installed version
64#
65python_makesym() { 87python_makesym() {
66 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]"
67 alternatives_auto_makesym "/usr/bin/python2" "/usr/bin/python[0-9].[0-9]" 89 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
68} 90}
69 91
70#
71# name: python_tkinter_exists 92# @FUNCTION: python_tkinter_exists
72# desc: run without arguments, it will return TRUE(0) if python is compiled 93# @DESCRIPTION:
73# with tkinter or FALSE(1) if python is compiled without tkinter. 94# Run without arguments, checks if python was compiled with Tkinter
74# 95# support. If not, prints an error message and dies.
75python_tkinter_exists() { 96python_tkinter_exists() {
76 if ! python -c "import Tkinter" >/dev/null 2>&1; then 97 if ! python -c "import Tkinter" >/dev/null 2>&1; then
77 eerror "You need to recompile python with Tkinter support." 98 eerror "You need to recompile python with Tkinter support."
78 eerror "That means: USE='tcltk' emerge python" 99 eerror "Try adding: 'dev-lang/python tk'"
100 eerror "in to /etc/portage/package.use"
79 echo 101 echo
80 die "missing tkinter support with installed python" 102 die "missing tkinter support with installed python"
81 fi 103 fi
82} 104}
83 105
84# 106# @FUNCTION: python_mod_exists
85# name: python_mod_exists 107# @USAGE: < module >
108# @DESCRIPTION:
86# 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
87# python module is installed and loadable. it will return 110# python module is installed and loadable. it will return
88# 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
89# not exist. 112# not exist.
90# exam: 113#
114# Example:
91# if python_mod_exists gtk; then 115# if python_mod_exists gtk; then
92# echo "gtk support enabled 116# echo "gtk support enabled"
93# fi 117# fi
94#
95python_mod_exists() { 118python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
96 if ! python -c "import $1" >/dev/null 2>&1; then 120 if ! python -c "import $1" >/dev/null 2>&1; then
97 return 1 121 return 1
98 fi 122 fi
99 return 0 123 return 0
100} 124}
101 125
102# 126# @FUNCTION: python_mod_compile
103# name: python_mod_compile 127# @USAGE: < file > [more files ...]
128# @DESCRIPTION:
104# 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.
105# should only be run in pkg_postinst() 130# This function should only be run in pkg_postinst()
106# exam: 131#
132# Example:
107# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 133# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
108# 134#
109python_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
110 # allow compiling for older python versions 142 # allow compiling for older python versions
111 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 143 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
112 PYVER=${PYTHON_OVERRIDE_PYVER} 144 PYVER=${PYTHON_OVERRIDE_PYVER}
113 else 145 else
114 python_version 146 python_version
115 fi 147 fi
116 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
117 if [ -f "$1" ]; then 157 if [ -n "${myfiles}" ]; then
118 python${PYVER} -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
119 ewarn "Failed to compile ${1}" 161 ewarn "No files to compile!"
120 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
121 ewarn "Failed to compile ${1}"
122 else
123 ewarn "Unable to find ${1}"
124 fi 162 fi
125} 163}
126 164
127#
128# name: python_mod_optimize 165# @FUNCTION: python_mod_optimize
166# @USAGE: [ path ]
167# @DESCRIPTION:
129# desc: if no arguments supplied, it will recompile all modules under 168# If no arguments supplied, it will recompile all modules under
130# 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/ ..)
131# no recursively 170# no recursively
132# 171#
133# if supplied with arguments, it will recompile all modules recursively 172# If supplied with arguments, it will recompile all modules recursively
134# in the supplied directory 173# in the supplied directory
135# 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:
136# python_mod_optimize ${ROOT}usr/share/codegen 179# python_mod_optimize /usr/share/codegen
137#
138python_mod_optimize() { 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
212
139 # allow compiling for older python versions 213 # allow compiling for older python versions
140 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 214 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
141 PYVER=${PYTHON_OVERRIDE_PYVER} 215 PYVER=${PYTHON_OVERRIDE_PYVER}
142 else 216 else
143 python_version 217 python_version
144 fi 218 fi
145 219
146 # set opts 220 # set additional opts
147 if [ "${PYVER}" = "2.2" ]; then 221 myopts="${myopts} -q"
148 compileopts="" 222
149 else
150 compileopts="-q"
151 fi
152
153 ebegin "Byte Compiling Python modules for ${PYVER} .." 223 ebegin "Byte compiling python modules for python-${PYVER} .."
154 python${PYVER} ${ROOT}usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 224 if [ -n "${mydirs}" ]; then
155 python${PYVER} -O ${ROOT}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
156 eend $? 237 eend $?
157} 238}
158 239
159# 240# @FUNCTION: python_mod_cleanup
160# name: python_mod_cleanup 241# @USAGE: [ dir ]
242# @DESCRIPTION:
161# desc: run with optional arguments, where arguments are directories of 243# Run with optional arguments, where arguments are directories of
162# 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]
163# 245#
164# it will recursively scan all compiled python modules in the directories 246# It will recursively scan all compiled python modules in the directories
165# 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.)
166# 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
167# 249#
250# This function should only be run in pkg_postrm()
168python_mod_cleanup() { 251python_mod_cleanup() {
169 local SEARCH_PATH 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()"
257
258 # strip trailing slash
259 myroot="${ROOT%/}"
170 260
171 if [ $# -gt 0 ]; then 261 if [ $# -gt 0 ]; then
172 for path in $@; do 262 for path in $@; do
173 SEARCH_PATH="${SEARCH_PATH} ${ROOT}${path#/}" 263 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
174 done 264 done
175 else 265 else
176 for path in ${ROOT}usr/lib/python*/site-packages; do 266 for path in ${myroot}/usr/lib*/python*/site-packages; do
177 SEARCH_PATH="${SEARCH_PATH} ${path}" 267 SEARCH_PATH="${SEARCH_PATH} ${path}"
178 done 268 done
179 fi 269 fi
180 270
181 for path in ${SEARCH_PATH}; do 271 for path in ${SEARCH_PATH}; do
182 einfo "Searching ${path} .." 272 einfo "Cleaning orphaned Python bytecode from ${path} .."
183 for obj in $(find ${path} -name *.pyc); do 273 for obj in $(find ${path} -name '*.py[co]'); do
184 src_py="$(echo $obj | sed 's:c$::')" 274 src_py="${obj%[co]}"
185 if [ ! -f "${src_py}" ]; then 275 if [ ! -f "${src_py}" ]; then
186 einfo "Purging ${src_py}[co]" 276 einfo "Purging ${src_py}[co]"
187 rm -f ${src_py}[co] 277 rm -f ${src_py}[co]
188 fi 278 fi
189 done 279 done
280 # attempt to remove directories that maybe empty
281 for dir in $(find ${path} -type d | sort -r); do
282 rmdir ${dir} 2>/dev/null
283 done
190 done 284 done
191} 285}
192
193
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.41
  ViewVC Help
Powered by ViewVC 1.1.13