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

Diff of /eclass/python.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20