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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.40 - (show annotations) (download)
Thu May 29 22:03:59 2008 UTC (6 years, 6 months ago) by hawking
Branch: MAIN
Changes since 1.39: +6 -8 lines
Fix last commit. Thanks to Remy Blank.

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.39 2008/05/29 21:19:19 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_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 #
47 python_disable_pyc() {
48 export PYTHON_DONTCOMPILE=1
49 }
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
55 python_enable_pyc() {
56 unset PYTHON_DONTCOMPILE
57 }
58
59 python_disable_pyc
60
61 # @FUNCTION: python_version
62 # @DESCRIPTION:
63 # Run without arguments and it will export the version of python
64 # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
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
75 python_version() {
76 local tmpstr
77 python=${python:-/usr/bin/python}
78 tmpstr="$(${python} -V 2>&1 )"
79 export PYVER_ALL="${tmpstr#Python }"
80 __python_version_extract $PYVER_ALL
81 }
82
83 # @FUNCTION: python_makesym
84 # @DESCRIPTION:
85 # Run without arguments, it will create the /usr/bin/python symlinks
86 # to the latest installed version
87 python_makesym() {
88 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
89 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
90 }
91
92 # @FUNCTION: python_tkinter_exists
93 # @DESCRIPTION:
94 # Run without arguments, checks if python was compiled with Tkinter
95 # support. If not, prints an error message and dies.
96 python_tkinter_exists() {
97 if ! python -c "import Tkinter" >/dev/null 2>&1; then
98 eerror "You need to recompile python with Tkinter support."
99 eerror "Try adding: 'dev-lang/python tk'"
100 eerror "in to /etc/portage/package.use"
101 echo
102 die "missing tkinter support with installed python"
103 fi
104 }
105
106 # @FUNCTION: python_mod_exists
107 # @USAGE: < module >
108 # @DESCRIPTION:
109 # Run with the module name as an argument. it will check if a
110 # python module is installed and loadable. it will return
111 # TRUE(0) if the module exists, and FALSE(1) if the module does
112 # not exist.
113 #
114 # Example:
115 # if python_mod_exists gtk; then
116 # echo "gtk support enabled"
117 # fi
118 python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then
121 return 1
122 fi
123 return 0
124 }
125
126 # @FUNCTION: python_mod_compile
127 # @USAGE: < file > [more files ...]
128 # @DESCRIPTION:
129 # Given filenames, it will pre-compile the module's .pyc and .pyo.
130 # This function should only be run in pkg_postinst()
131 #
132 # Example:
133 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
134 #
135 python_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
157 if [ -n "${myfiles}" ]; then
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
161 ewarn "No files to compile!"
162 fi
163 }
164
165 # @FUNCTION: python_mod_optimize
166 # @USAGE: [ path ]
167 # @DESCRIPTION:
168 # If no arguments supplied, it will recompile all modules under
169 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
170 # no recursively
171 #
172 # If supplied with arguments, it will recompile all modules recursively
173 # in the supplied directory
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:
179 # python_mod_optimize /usr/share/codegen
180 python_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 # -x takes regexp as argument so quoting is necessary.
198 myopts="${myopts} $1 \"$2\""
199 shift
200 ;;
201 -*)
202 ewarn "${FUNCNAME}: Ignoring compile option $1"
203 ;;
204 *)
205 [ ! -e "${myroot}/${1}" ] && ewarn "${myroot}/${1} doesn't exist!"
206 [ -d "${myroot}/${1#/}" ] && mydirs="${mydirs} ${myroot}/${1#/}"
207 # Files are passed to python_mod_compile which is ROOT-aware
208 [ -f "${myroot}/${1}" ] && myfiles="${myfiles} ${1}"
209 ;;
210 esac
211 shift
212 done
213
214 # allow compiling for older python versions
215 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
216 PYVER=${PYTHON_OVERRIDE_PYVER}
217 else
218 python_version
219 fi
220
221 # set opts
222 if [ "${PYVER}" = "2.2" ]; then
223 compileopts=""
224 else
225 compileopts="-q"
226 fi
227
228 ebegin "Byte compiling python modules for python-${PYVER} .."
229 if [ -n "${mydirs}" ]; then
230 python${PYVER} \
231 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
232 ${compileopts} ${myopts} ${mydirs}
233 python${PYVER} -O \
234 ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
235 ${compileopts} ${myopts} ${mydirs}
236 fi
237
238 if [ -n "${myfiles}" ]; then
239 python_mod_compile ${myfiles}
240 fi
241
242 eend $?
243 }
244
245 # @FUNCTION: python_mod_cleanup
246 # @USAGE: [ dir ]
247 # @DESCRIPTION:
248 # Run with optional arguments, where arguments are directories of
249 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
250 #
251 # It will recursively scan all compiled python modules in the directories
252 # and determine if they are orphaned (eg. their corresponding .py is missing.)
253 # if they are, then it will remove their corresponding .pyc and .pyo
254 #
255 # This function should only be run in pkg_postrm()
256 python_mod_cleanup() {
257 local SEARCH_PATH myroot
258
259 # Check if phase is pkg_postrm()
260 [[ ${EBUILD_PHASE} != postrm ]] &&\
261 die "${FUNCNAME} should only be run in pkg_postrm()"
262
263 # strip trailing slash
264 myroot="${ROOT%/}"
265
266 if [ $# -gt 0 ]; then
267 for path in $@; do
268 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
269 done
270 else
271 for path in ${myroot}/usr/lib*/python*/site-packages; do
272 SEARCH_PATH="${SEARCH_PATH} ${path}"
273 done
274 fi
275
276 for path in ${SEARCH_PATH}; do
277 einfo "Cleaning orphaned Python bytecode from ${path} .."
278 for obj in $(find ${path} -name '*.py[co]'); do
279 src_py="${obj%[co]}"
280 if [ ! -f "${src_py}" ]; then
281 einfo "Purging ${src_py}[co]"
282 rm -f ${src_py}[co]
283 fi
284 done
285 # attempt to remove directories that maybe empty
286 for dir in $(find ${path} -type d | sort -r); do
287 rmdir ${dir} 2>/dev/null
288 done
289 done
290 }

  ViewVC Help
Powered by ViewVC 1.1.20