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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.21 - (show annotations) (download)
Mon Jul 11 15:08:06 2005 UTC (9 years, 5 months ago) by swegener
Branch: MAIN
Changes since 1.20: +2 -2 lines
QA: Apply whitespace checks from repoman to eclasses.

1 # Copyright 1999-2004 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.20 2005/07/06 20:23:20 agriffis Exp $
4 #
5 # Author: Alastair Tse <liquidx@gentoo.org>
6 #
7 # A Utility Eclass that should be inherited by anything that deals with
8 # Python or Python modules.
9 #
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
20 inherit alternatives
21
22
23
24 __python_eclass_test() {
25 __python_version_extract 2.3
26 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
27 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
28 __python_version_extract 2.3.4
29 echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
30 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
31 __python_version_extract 2.3.5
32 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
33 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
34 __python_version_extract 2.4
35 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37 }
38
39 #
40 # name: python_disable/enable_pyc
41 # desc: tells python not to automatically recompile modules to .pyc/.pyo
42 # even if the timestamps/version stamps don't match. this is
43 # done to protect sandbox.
44 #
45 # note: supported by >=dev-lang/python-2.2.3-r3 only.
46 #
47 python_disable_pyc() {
48 export PYTHON_DONTCOMPILE=1
49 }
50
51 python_enable_pyc() {
52 unset PYTHON_DONTCOMPILE
53 }
54
55 python_disable_pyc
56
57 #
58 # name: python_version
59 # desc: run without arguments and it will export the version of python
60 # currently in use as $PYVER
61 #
62
63 __python_version_extract() {
64 verstr=$1
65 export PYVER_MAJOR=${verstr:0:1}
66 export PYVER_MINOR=${verstr:2:1}
67 export PYVER_MICRO=${verstr:4}
68 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
69 }
70
71 python_version() {
72 local tmpstr
73 python=${python:-/usr/bin/python}
74 tmpstr="$(${python} -V 2>&1 )"
75 export PYVER_ALL="${tmpstr#Python }"
76 __python_version_extract $PYVER_ALL
77 }
78
79 #
80 # name: python_makesym
81 # desc: run without arguments, it will create the /usr/bin/python symlinks
82 # to the latest installed version
83 #
84 python_makesym() {
85 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
86 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
87 }
88
89 #
90 # name: python_tkinter_exists
91 # desc: run without arguments, checks if python was compiled with Tkinter
92 # support. If not, prints an error message and dies.
93 #
94 python_tkinter_exists() {
95 if ! python -c "import Tkinter" >/dev/null 2>&1; then
96 eerror "You need to recompile python with Tkinter support."
97 eerror "That means: USE='tcltk' emerge python"
98 echo
99 die "missing tkinter support with installed python"
100 fi
101 }
102
103 #
104 # name: python_mod_exists
105 # desc: run with the module name as an argument. it will check if a
106 # python module is installed and loadable. it will return
107 # TRUE(0) if the module exists, and FALSE(1) if the module does
108 # not exist.
109 # exam:
110 # if python_mod_exists gtk; then
111 # echo "gtk support enabled
112 # fi
113 #
114 python_mod_exists() {
115 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
116 if ! python -c "import $1" >/dev/null 2>&1; then
117 return 1
118 fi
119 return 0
120 }
121
122 #
123 # name: python_mod_compile
124 # desc: given a filename, it will pre-compile the module's .pyc and .pyo.
125 # should only be run in pkg_postinst()
126 # exam:
127 # python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
128 #
129 python_mod_compile() {
130 # allow compiling for older python versions
131 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
132 PYVER=${PYTHON_OVERRIDE_PYVER}
133 else
134 python_version
135 fi
136
137 if [ -f "$1" ]; then
138 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
139 ewarn "Failed to compile ${1}"
140 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
141 ewarn "Failed to compile ${1}"
142 else
143 ewarn "Unable to find ${1}"
144 fi
145 }
146
147 #
148 # name: python_mod_optimize
149 # desc: if no arguments supplied, it will recompile all modules under
150 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
151 # no recursively
152 #
153 # if supplied with arguments, it will recompile all modules recursively
154 # in the supplied directory
155 # exam:
156 # python_mod_optimize ${ROOT}usr/share/codegen
157 #
158 python_mod_optimize() {
159 local myroot
160 # strip trailing slash
161 myroot="${ROOT%/}"
162
163 # allow compiling for older python versions
164 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
165 PYVER=${PYTHON_OVERRIDE_PYVER}
166 else
167 python_version
168 fi
169
170 # set opts
171 if [ "${PYVER}" = "2.2" ]; then
172 compileopts=""
173 else
174 compileopts="-q"
175 fi
176
177 ebegin "Byte compiling python modules for python-${PYVER} .."
178 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
179 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
180 eend $?
181 }
182
183 #
184 # name: python_mod_cleanup
185 # desc: run with optional arguments, where arguments are directories of
186 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
187 #
188 # it will recursively scan all compiled python modules in the directories
189 # and determine if they are orphaned (eg. their corresponding .py is missing.)
190 # if they are, then it will remove their corresponding .pyc and .pyo
191 #
192 python_mod_cleanup() {
193 local SEARCH_PATH myroot
194
195 # strip trailing slash
196 myroot="${ROOT%/}"
197
198 if [ $# -gt 0 ]; then
199 for path in $@; do
200 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
201 done
202 else
203 for path in ${myroot}/usr/lib*/python*/site-packages; do
204 SEARCH_PATH="${SEARCH_PATH} ${path}"
205 done
206 fi
207
208 for path in ${SEARCH_PATH}; do
209 einfo "Cleaning orphaned Python bytecode from ${path} .."
210 for obj in $(find ${path} -name *.pyc); do
211 src_py="${obj%c}"
212 if [ ! -f "${src_py}" ]; then
213 einfo "Purging ${src_py}[co]"
214 rm -f ${src_py}[co]
215 fi
216 done
217 # attempt to remove directories that maybe empty
218 for dir in $(find ${path} -type d | sort -r); do
219 rmdir ${dir} 2>/dev/null
220 done
221 done
222 }

  ViewVC Help
Powered by ViewVC 1.1.20