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

Diff of /eclass/python.eclass

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

Revision 1.7 Revision 1.42
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.7 2003/10/24 07:12:42 pythonhead Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.42 2008/07/28 21:56:40 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
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: get_python_libdir
61# name: python_makesym 84# @DESCRIPTION:
85# Run without arguments, returns the python library dir
86get_python_libdir() {
87 python_version
88 echo "/usr/$(get_libdir)/python${PYVER}"
89}
90
91# @FUNCTION: get_python_sitedir
92# @DESCRIPTION:
93# Run without arguments, returns the python site-packages dir
94get_python_sitedir() {
95 echo "$(get_python_libdir)/site-packages"
96}
97
98# @FUNCTION: python_makesym
99# @DESCRIPTION:
62# desc: run without arguments, it will create the /usr/bin/python symlinks 100# Run without arguments, it will create the /usr/bin/python symlinks
63# to the latest installed version 101# to the latest installed version
64#
65python_makesym() { 102python_makesym() {
66 alternatives_auto_makesym "/usr/bin/python" "/usr/bin/python[0-9].[0-9]" 103 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]" 104 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
68} 105}
69 106
70#
71# name: python_tkinter_exists 107# @FUNCTION: python_tkinter_exists
72# desc: run without arguments, it will return TRUE(0) if python is compiled 108# @DESCRIPTION:
73# with tkinter or FALSE(1) if python is compiled without tkinter. 109# Run without arguments, checks if python was compiled with Tkinter
74# 110# support. If not, prints an error message and dies.
75python_tkinter_exists() { 111python_tkinter_exists() {
76 if ! python -c "import Tkinter" >/dev/null 2>&1; then 112 if ! python -c "import Tkinter" >/dev/null 2>&1; then
77 eerror "You need to recompile python with Tkinter support." 113 eerror "You need to recompile python with Tkinter support."
78 eerror "That means: USE='tcltk' emerge python" 114 eerror "Try adding: 'dev-lang/python tk'"
115 eerror "in to /etc/portage/package.use"
79 echo 116 echo
80 die "missing tkinter support with installed python" 117 die "missing tkinter support with installed python"
81 fi 118 fi
82} 119}
83 120
84# 121# @FUNCTION: python_mod_exists
85# name: python_mod_exists 122# @USAGE: < module >
123# @DESCRIPTION:
86# 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
87# python module is installed and loadable. it will return 125# python module is installed and loadable. it will return
88# 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
89# not exist. 127# not exist.
90# exam: 128#
129# Example:
91# if python_mod_exists gtk; then 130# if python_mod_exists gtk; then
92# echo "gtk support enabled 131# echo "gtk support enabled"
93# fi 132# fi
94#
95python_mod_exists() { 133python_mod_exists() {
134 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
96 if ! python -c "import $1" >/dev/null 2>&1; then 135 if ! python -c "import $1" >/dev/null 2>&1; then
97 return 1 136 return 1
98 fi 137 fi
99 return 0 138 return 0
100} 139}
101 140
102# 141# @FUNCTION: python_mod_compile
103# name: python_mod_compile 142# @USAGE: < file > [more files ...]
143# @DESCRIPTION:
104# 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.
105# should only be run in pkg_postinst() 145# This function should only be run in pkg_postinst()
106# exam: 146#
147# Example:
107# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 148# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
108# 149#
109python_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
110 # allow compiling for older python versions 157 # allow compiling for older python versions
111 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 158 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
112 PYVER=${PYTHON_OVERRIDE_PYVER} 159 PYVER=${PYTHON_OVERRIDE_PYVER}
113 else 160 else
114 python_version 161 python_version
115 fi 162 fi
116 163
164 # strip trailing slash
165 myroot="${ROOT%/}"
166
167 # respect ROOT
168 for f in $@; do
169 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
170 done
171
117 if [ -f "$1" ]; then 172 if [ -n "${myfiles}" ]; then
118 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \ 173 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
119 ewarn "Failed to compile ${1}" 174 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
120 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
121 ewarn "Failed to compile ${1}"
122 else 175 else
123 ewarn "Unable to find ${1}" 176 ewarn "No files to compile!"
124 fi 177 fi
125} 178}
126 179
127#
128# name: python_mod_optimize 180# @FUNCTION: python_mod_optimize
181# @USAGE: [ path ]
182# @DESCRIPTION:
129# desc: if no arguments supplied, it will recompile all modules under 183# If no arguments supplied, it will recompile all modules under
130# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) 184# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
131# no recursively 185# no recursively
132# 186#
133# if supplied with arguments, it will recompile all modules recursively 187# If supplied with arguments, it will recompile all modules recursively
134# in the supplied directory 188# in the supplied directory
135# exam: 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:
136# python_mod_optimize ${ROOT}usr/share/codegen 194# python_mod_optimize /usr/share/codegen
137#
138python_mod_optimize() { 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
227
139 # allow compiling for older python versions 228 # allow compiling for older python versions
140 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 229 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
141 PYVER=${PYTHON_OVERRIDE_PYVER} 230 PYVER=${PYTHON_OVERRIDE_PYVER}
142 else 231 else
143 python_version 232 python_version
144 fi 233 fi
145 234
146 # set opts 235 # set additional opts
147 if [ "${PYVER}" = "2.2" ]; then 236 myopts="${myopts} -q"
148 compileopts=""
149 else
150 compileopts="-q"
151 fi
152 237
153 ebegin "Byte Compiling Python modules for ${PYVER} .." 238 ebegin "Byte compiling python modules for python-${PYVER} .."
154 python${PYVER} ${ROOT}usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 239 if [ -n "${mydirs}" ]; then
155 python${PYVER} -O ${ROOT}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
156 eend $? 252 eend $?
157} 253}
158 254
159# 255# @FUNCTION: python_mod_cleanup
160# name: python_mod_cleanup 256# @USAGE: [ dir ]
257# @DESCRIPTION:
161# desc: run with optional arguments, where arguments are directories of 258# 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] 259# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
163# 260#
164# it will recursively scan all compiled python modules in the directories 261# It will recursively scan all compiled python modules in the directories
165# 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.)
166# 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
167# 264#
265# This function should only be run in pkg_postrm()
168python_mod_cleanup() { 266python_mod_cleanup() {
169 local SEARCH_PATH 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()"
272
273 # strip trailing slash
274 myroot="${ROOT%/}"
170 275
171 if [ $# -gt 0 ]; then 276 if [ $# -gt 0 ]; then
172 for path in $@; do 277 for path in $@; do
173 SEARCH_PATH="${SEARCH_PATH} ${ROOT}${path#/}" 278 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
174 done 279 done
175 else 280 else
176 for path in ${ROOT}usr/lib/python*/site-packages; do 281 for path in ${myroot}/usr/lib*/python*/site-packages; do
177 SEARCH_PATH="${SEARCH_PATH} ${path}" 282 SEARCH_PATH="${SEARCH_PATH} ${path}"
178 done 283 done
179 fi 284 fi
180 285
181 for path in ${SEARCH_PATH}; do 286 for path in ${SEARCH_PATH}; do
182 einfo "Searching ${path} .." 287 einfo "Cleaning orphaned Python bytecode from ${path} .."
183 for obj in $(find ${path} -name *.pyc); do 288 for obj in $(find ${path} -name '*.py[co]'); do
184 src_py="$(echo $obj | sed 's:c$::')" 289 src_py="${obj%[co]}"
185 if [ ! -f "${src_py}" ]; then 290 if [ ! -f "${src_py}" ]; then
186 einfo "Purging ${src_py}[co]" 291 einfo "Purging ${src_py}[co]"
187 rm -f ${src_py}[co] 292 rm -f ${src_py}[co]
188 fi 293 fi
189 done 294 done
295 # attempt to remove directories that maybe empty
296 for dir in $(find ${path} -type d | sort -r); do
297 rmdir ${dir} 2>/dev/null
298 done
190 done 299 done
191} 300}
192
193

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20