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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.52 - (show annotations) (download)
Mon Oct 27 00:17:28 2008 UTC (5 years, 5 months ago) by hawking
Branch: MAIN
Changes since 1.51: +9 -1 lines
Add python_need_rebuild marker function. The first step for a faster python-updater :)

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.51 2008/10/26 21:54:32 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:1} == . ]]; 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_need_rebuild
95 # @DESCRIPTION: Run without arguments, specifies that the package should be
96 # rebuilt after a python upgrade.
97 python_need_rebuild() {
98 python_version
99 export PYTHON_NEED_REBUILD=${PYVER}
100 }
101
102 # @FUNCTION: python_get_libdir
103 # @DESCRIPTION:
104 # Run without arguments, returns the python library dir
105 python_get_libdir() {
106 python_version
107 echo "/usr/$(get_libdir)/python${PYVER}"
108 }
109
110 # @FUNCTION: python_get_sitedir
111 # @DESCRIPTION:
112 # Run without arguments, returns the python site-packages dir
113 python_get_sitedir() {
114 echo "$(python_get_libdir)/site-packages"
115 }
116
117 # @FUNCTION: python_makesym
118 # @DESCRIPTION:
119 # Run without arguments, it will create the /usr/bin/python symlinks
120 # to the latest installed version
121 python_makesym() {
122 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
123 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
124 }
125
126 # @FUNCTION: python_tkinter_exists
127 # @DESCRIPTION:
128 # Run without arguments, checks if python was compiled with Tkinter
129 # support. If not, prints an error message and dies.
130 python_tkinter_exists() {
131 if ! python -c "import Tkinter" >/dev/null 2>&1; then
132 eerror "You need to recompile python with Tkinter support."
133 eerror "Try adding: 'dev-lang/python tk'"
134 eerror "in to /etc/portage/package.use"
135 echo
136 die "missing tkinter support with installed python"
137 fi
138 }
139
140 # @FUNCTION: python_mod_exists
141 # @USAGE: < module >
142 # @DESCRIPTION:
143 # Run with the module name as an argument. it will check if a
144 # python module is installed and loadable. it will return
145 # TRUE(0) if the module exists, and FALSE(1) if the module does
146 # not exist.
147 #
148 # Example:
149 # if python_mod_exists gtk; then
150 # echo "gtk support enabled"
151 # fi
152 python_mod_exists() {
153 [[ "$1" ]] && die "${FUNCNAME} requires an argument!"
154 python -c "import $1" >/dev/null 2>&1
155 }
156
157 # @FUNCTION: python_mod_compile
158 # @USAGE: < file > [more files ...]
159 # @DESCRIPTION:
160 # Given filenames, it will pre-compile the module's .pyc and .pyo.
161 # This function should only be run in pkg_postinst()
162 #
163 # Example:
164 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
165 #
166 python_mod_compile() {
167 local f myroot myfiles=()
168
169 # Check if phase is pkg_postinst()
170 [[ ${EBUILD_PHASE} != postinst ]] &&\
171 die "${FUNCNAME} should only be run in pkg_postinst()"
172
173 # allow compiling for older python versions
174 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
175 PYVER=${PYTHON_OVERRIDE_PYVER}
176 else
177 python_version
178 fi
179
180 # strip trailing slash
181 myroot="${ROOT%/}"
182
183 # respect ROOT
184 for f in "$@"; do
185 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
186 done
187
188 if ((${#myfiles[@]})); then
189 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
190 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
191 else
192 ewarn "No files to compile!"
193 fi
194 }
195
196 # @FUNCTION: python_mod_optimize
197 # @USAGE: [ path ]
198 # @DESCRIPTION:
199 # If no arguments supplied, it will recompile all modules under
200 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
201 # no recursively
202 #
203 # If supplied with arguments, it will recompile all modules recursively
204 # in the supplied directory
205 # This function should only be run in pkg_postinst()
206 #
207 # Options passed to this function are passed to compileall.py
208 #
209 # Example:
210 # python_mod_optimize /usr/share/codegen
211 python_mod_optimize() {
212 local myroot mydirs=() myfiles=() myopts=()
213
214 # Check if phase is pkg_postinst()
215 [[ ${EBUILD_PHASE} != postinst ]] &&\
216 die "${FUNCNAME} should only be run in pkg_postinst()"
217
218 # strip trailing slash
219 myroot="${ROOT%/}"
220
221 # respect ROOT and options passed to compileall.py
222 while (($#)); do
223 case $1 in
224 -l|-f|-q)
225 myopts+=("$1")
226 ;;
227 -d|-x)
228 myopts+=("$1" "$2")
229 shift
230 ;;
231 -*)
232 ewarn "${FUNCNAME}: Ignoring compile option $1"
233 ;;
234 *)
235 if [[ -d "${myroot}"/$1 ]]; then
236 mydirs+=("${myroot}/$1")
237 elif [[ -f "${myroot}"/$1 ]]; then
238 # Files are passed to python_mod_compile which is ROOT-aware
239 myfiles+=("$1")
240 elif [[ -e "${myroot}/$1" ]]; then
241 ewarn "${myroot}/$1 is not a file or directory!"
242 else
243 ewarn "${myroot}/$1 doesn't exist!"
244 fi
245 ;;
246 esac
247 shift
248 done
249
250 # allow compiling for older python versions
251 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
252 PYVER=${PYTHON_OVERRIDE_PYVER}
253 else
254 python_version
255 fi
256
257 # set additional opts
258 myopts+=(-q)
259
260 ebegin "Byte compiling python modules for python-${PYVER} .."
261 if ((${#mydirs[@]})); then
262 python${PYVER} \
263 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
264 "${myopts[@]}" "${mydirs[@]}"
265 python${PYVER} -O \
266 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
267 "${myopts[@]}" "${mydirs[@]}"
268 fi
269
270 if ((${#myfiles[@]})); then
271 python_mod_compile "${myfiles[@]}"
272 fi
273
274 eend $?
275 }
276
277 # @FUNCTION: python_mod_cleanup
278 # @USAGE: [ dir ]
279 # @DESCRIPTION:
280 # Run with optional arguments, where arguments are directories of
281 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
282 #
283 # It will recursively scan all compiled python modules in the directories
284 # and determine if they are orphaned (eg. their corresponding .py is missing.)
285 # if they are, then it will remove their corresponding .pyc and .pyo
286 #
287 # This function should only be run in pkg_postrm()
288 python_mod_cleanup() {
289 local SEARCH_PATH=() myroot src_py
290
291 # Check if phase is pkg_postrm()
292 [[ ${EBUILD_PHASE} != postrm ]] &&\
293 die "${FUNCNAME} should only be run in pkg_postrm()"
294
295 # strip trailing slash
296 myroot="${ROOT%/}"
297
298 if (($#)); then
299 SEARCH_PATH=("${@#/}")
300 SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
301 else
302 SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
303 fi
304
305 for path in "${SEARCH_PATH[@]}"; do
306 einfo "Cleaning orphaned Python bytecode from ${path} .."
307 while read -rd ''; do
308 src_py="${REPLY%[co]}"
309 [[ -f "${src_py}" ]] && continue
310 einfo "Purging ${src_py}[co]"
311 rm -f "${src_py}"[co]
312 done < <(find "${path}" -name '*.py[co]' -print0)
313
314 # attempt to remove directories that maybe empty
315 while read -r dir; do
316 rmdir "${dir}" 2>/dev/null
317 done < <(find "${path}" -type d | sort -r)
318 done
319 }

  ViewVC Help
Powered by ViewVC 1.1.20