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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (show annotations) (download)
Sun Oct 26 17:11:51 2008 UTC (5 years, 8 months ago) by hawking
Branch: MAIN
Changes since 1.45: +33 -23 lines
Use PYTHONDONTWRITEBYTECODE to {en,dis}able pyc for 2.6 and above.

1 # Copyright 1999-2008 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.45 2008/09/01 14:11:54 hawking Exp $
4
5 # @ECLASS: python.eclass
6 # @MAINTAINER:
7 # python@gentoo.org
8 #
9 # original author: Alastair Tse <liquidx@gentoo.org>
10 # @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules.
11 # @DESCRIPTION:
12 # Some useful functions for dealing with python.
13 inherit alternatives multilib
14
15
16 if [[ -n "${NEED_PYTHON}" ]] ; then
17 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18 RDEPEND="${DEPEND}"
19 fi
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_version
40 # @DESCRIPTION:
41 # Run without arguments and it will export the version of python
42 # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
43 __python_version_extract() {
44 local verstr=$1
45 export PYVER_MAJOR=${verstr:0:1}
46 export PYVER_MINOR=${verstr:2:1}
47 if [ "${verstr:3}x" = ".x" ]; then
48 export PYVER_MICRO=${verstr:4}
49 fi
50 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
51 }
52
53 python_version() {
54 [[ -n "${PYVER}" ]] && return 0
55 local tmpstr
56 python=${python:-/usr/bin/python}
57 tmpstr="$(${python} -V 2>&1 )"
58 export PYVER_ALL="${tmpstr#Python }"
59 __python_version_extract $PYVER_ALL
60 }
61
62 # @FUNCTION: python_disable_pyc
63 # @DESCRIPTION:
64 # Tells python not to automatically recompile modules to .pyc/.pyo
65 # even if the timestamps/version stamps don't match. This is done
66 # to protect sandbox.
67 #
68 # note: supported by >=dev-lang/python-2.2.3-r3 only.
69 #
70 python_disable_pyc() {
71 python_version
72 if [[ ${PYVER/./,} -ge 2,6 ]]; then
73 export PYTHONDONTWRITEBYTECODE=1
74 else
75 export PYTHON_DONTCOMPILE=1
76 fi
77 }
78
79 # @FUNCTION: python_enable_pyc
80 # @DESCRIPTION:
81 # Tells python to automatically recompile modules to .pyc/.pyo if the
82 # timestamps/version stamps change
83 python_enable_pyc() {
84 python_version
85 if [[ ${PYVER/./,} -ge 2,6 ]]; then
86 unset PYTHONDONTWRITEBYTECODE
87 else
88 unset PYTHON_DONTCOMPILE
89 fi
90 }
91
92 python_disable_pyc
93
94 # @FUNCTION: python_get_libdir
95 # @DESCRIPTION:
96 # Run without arguments, returns the python library dir
97 python_get_libdir() {
98 python_version
99 echo "/usr/$(get_libdir)/python${PYVER}"
100 }
101
102 # @FUNCTION: python_get_sitedir
103 # @DESCRIPTION:
104 # Run without arguments, returns the python site-packages dir
105 python_get_sitedir() {
106 echo "$(python_get_libdir)/site-packages"
107 }
108
109 # @FUNCTION: python_makesym
110 # @DESCRIPTION:
111 # Run without arguments, it will create the /usr/bin/python symlinks
112 # to the latest installed version
113 python_makesym() {
114 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
115 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
116 }
117
118 # @FUNCTION: python_tkinter_exists
119 # @DESCRIPTION:
120 # Run without arguments, checks if python was compiled with Tkinter
121 # support. If not, prints an error message and dies.
122 python_tkinter_exists() {
123 if ! python -c "import Tkinter" >/dev/null 2>&1; then
124 eerror "You need to recompile python with Tkinter support."
125 eerror "Try adding: 'dev-lang/python tk'"
126 eerror "in to /etc/portage/package.use"
127 echo
128 die "missing tkinter support with installed python"
129 fi
130 }
131
132 # @FUNCTION: python_mod_exists
133 # @USAGE: < module >
134 # @DESCRIPTION:
135 # Run with the module name as an argument. it will check if a
136 # python module is installed and loadable. it will return
137 # TRUE(0) if the module exists, and FALSE(1) if the module does
138 # not exist.
139 #
140 # Example:
141 # if python_mod_exists gtk; then
142 # echo "gtk support enabled"
143 # fi
144 python_mod_exists() {
145 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
146 if ! python -c "import $1" >/dev/null 2>&1; then
147 return 1
148 fi
149 return 0
150 }
151
152 # @FUNCTION: python_mod_compile
153 # @USAGE: < file > [more files ...]
154 # @DESCRIPTION:
155 # Given filenames, it will pre-compile the module's .pyc and .pyo.
156 # This function should only be run in pkg_postinst()
157 #
158 # Example:
159 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
160 #
161 python_mod_compile() {
162 local f myroot
163
164 # Check if phase is pkg_postinst()
165 [[ ${EBUILD_PHASE} != postinst ]] &&\
166 die "${FUNCNAME} should only be run in pkg_postinst()"
167
168 # allow compiling for older python versions
169 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
170 PYVER=${PYTHON_OVERRIDE_PYVER}
171 else
172 python_version
173 fi
174
175 # strip trailing slash
176 myroot="${ROOT%/}"
177
178 # respect ROOT
179 for f in $@; do
180 [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
181 done
182
183 if [ -n "${myfiles}" ]; then
184 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
185 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
186 else
187 ewarn "No files to compile!"
188 fi
189 }
190
191 # @FUNCTION: python_mod_optimize
192 # @USAGE: [ path ]
193 # @DESCRIPTION:
194 # If no arguments supplied, it will recompile all modules under
195 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
196 # no recursively
197 #
198 # If supplied with arguments, it will recompile all modules recursively
199 # in the supplied directory
200 # This function should only be run in pkg_postinst()
201 #
202 # Options passed to this function are passed to compileall.py
203 #
204 # Example:
205 # python_mod_optimize /usr/share/codegen
206 python_mod_optimize() {
207 local mydirs myfiles myroot myopts
208
209 # Check if phase is pkg_postinst()
210 [[ ${EBUILD_PHASE} != postinst ]] &&\
211 die "${FUNCNAME} should only be run in pkg_postinst()"
212
213 # strip trailing slash
214 myroot="${ROOT%/}"
215
216 # respect ROOT and options passed to compileall.py
217 while [ $# -gt 0 ]; do
218 case $1 in
219 -l|-f|-q)
220 myopts="${myopts} $1"
221 ;;
222 -d|-x)
223 myopts="${myopts} $1 $2"
224 shift
225 ;;
226 -*)
227 ewarn "${FUNCNAME}: Ignoring compile option $1"
228 ;;
229 *)
230 [ ! -e "${myroot}/${1}" ] && ewarn "${myroot}/${1} doesn't exist!"
231 [ -d "${myroot}/${1#/}" ] && mydirs="${mydirs} ${myroot}/${1#/}"
232 # Files are passed to python_mod_compile which is ROOT-aware
233 [ -f "${myroot}/${1}" ] && myfiles="${myfiles} ${1}"
234 ;;
235 esac
236 shift
237 done
238
239 # allow compiling for older python versions
240 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
241 PYVER=${PYTHON_OVERRIDE_PYVER}
242 else
243 python_version
244 fi
245
246 # set additional opts
247 myopts="${myopts} -q"
248
249 ebegin "Byte compiling python modules for python-${PYVER} .."
250 if [ -n "${mydirs}" ]; then
251 python${PYVER} \
252 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
253 ${myopts} ${mydirs}
254 python${PYVER} -O \
255 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
256 ${myopts} ${mydirs}
257 fi
258
259 if [ -n "${myfiles}" ]; then
260 python_mod_compile ${myfiles}
261 fi
262
263 eend $?
264 }
265
266 # @FUNCTION: python_mod_cleanup
267 # @USAGE: [ dir ]
268 # @DESCRIPTION:
269 # Run with optional arguments, where arguments are directories of
270 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
271 #
272 # It will recursively scan all compiled python modules in the directories
273 # and determine if they are orphaned (eg. their corresponding .py is missing.)
274 # if they are, then it will remove their corresponding .pyc and .pyo
275 #
276 # This function should only be run in pkg_postrm()
277 python_mod_cleanup() {
278 local SEARCH_PATH myroot
279
280 # Check if phase is pkg_postrm()
281 [[ ${EBUILD_PHASE} != postrm ]] &&\
282 die "${FUNCNAME} should only be run in pkg_postrm()"
283
284 # strip trailing slash
285 myroot="${ROOT%/}"
286
287 if [ $# -gt 0 ]; then
288 for path in $@; do
289 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
290 done
291 else
292 for path in ${myroot}/usr/lib*/python*/site-packages; do
293 SEARCH_PATH="${SEARCH_PATH} ${path}"
294 done
295 fi
296
297 for path in ${SEARCH_PATH}; do
298 einfo "Cleaning orphaned Python bytecode from ${path} .."
299 for obj in $(find ${path} -name '*.py[co]'); do
300 src_py="${obj%[co]}"
301 if [ ! -f "${src_py}" ]; then
302 einfo "Purging ${src_py}[co]"
303 rm -f ${src_py}[co]
304 fi
305 done
306 # attempt to remove directories that maybe empty
307 for dir in $(find ${path} -type d | sort -r); do
308 rmdir ${dir} 2>/dev/null
309 done
310 done
311 }

  ViewVC Help
Powered by ViewVC 1.1.20