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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.42 - (show annotations) (download)
Mon Jul 28 21:56:40 2008 UTC (6 years ago) by pythonhead
Branch: MAIN
Changes since 1.41: +16 -1 lines
Added get_python_libdir and get_python_sitedir functions bug 232575

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.41 2008/05/30 09:58:28 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: get_python_libdir
84 # @DESCRIPTION:
85 # Run without arguments, returns the python library dir
86 get_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
94 get_python_sitedir() {
95 echo "$(get_python_libdir)/site-packages"
96 }
97
98 # @FUNCTION: python_makesym
99 # @DESCRIPTION:
100 # Run without arguments, it will create the /usr/bin/python symlinks
101 # to the latest installed version
102 python_makesym() {
103 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
104 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
105 }
106
107 # @FUNCTION: python_tkinter_exists
108 # @DESCRIPTION:
109 # Run without arguments, checks if python was compiled with Tkinter
110 # support. If not, prints an error message and dies.
111 python_tkinter_exists() {
112 if ! python -c "import Tkinter" >/dev/null 2>&1; then
113 eerror "You need to recompile python with Tkinter support."
114 eerror "Try adding: 'dev-lang/python tk'"
115 eerror "in to /etc/portage/package.use"
116 echo
117 die "missing tkinter support with installed python"
118 fi
119 }
120
121 # @FUNCTION: python_mod_exists
122 # @USAGE: < module >
123 # @DESCRIPTION:
124 # Run with the module name as an argument. it will check if a
125 # python module is installed and loadable. it will return
126 # TRUE(0) if the module exists, and FALSE(1) if the module does
127 # not exist.
128 #
129 # Example:
130 # if python_mod_exists gtk; then
131 # echo "gtk support enabled"
132 # fi
133 python_mod_exists() {
134 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
135 if ! python -c "import $1" >/dev/null 2>&1; then
136 return 1
137 fi
138 return 0
139 }
140
141 # @FUNCTION: python_mod_compile
142 # @USAGE: < file > [more files ...]
143 # @DESCRIPTION:
144 # Given filenames, it will pre-compile the module's .pyc and .pyo.
145 # This function should only be run in pkg_postinst()
146 #
147 # Example:
148 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
149 #
150 python_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
157 # allow compiling for older python versions
158 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
159 PYVER=${PYTHON_OVERRIDE_PYVER}
160 else
161 python_version
162 fi
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
172 if [ -n "${myfiles}" ]; then
173 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
174 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
175 else
176 ewarn "No files to compile!"
177 fi
178 }
179
180 # @FUNCTION: python_mod_optimize
181 # @USAGE: [ path ]
182 # @DESCRIPTION:
183 # If no arguments supplied, it will recompile all modules under
184 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
185 # no recursively
186 #
187 # If supplied with arguments, it will recompile all modules recursively
188 # in the supplied directory
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:
194 # python_mod_optimize /usr/share/codegen
195 python_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
228 # allow compiling for older python versions
229 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
230 PYVER=${PYTHON_OVERRIDE_PYVER}
231 else
232 python_version
233 fi
234
235 # set additional opts
236 myopts="${myopts} -q"
237
238 ebegin "Byte compiling python modules for python-${PYVER} .."
239 if [ -n "${mydirs}" ]; then
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
252 eend $?
253 }
254
255 # @FUNCTION: python_mod_cleanup
256 # @USAGE: [ dir ]
257 # @DESCRIPTION:
258 # Run with optional arguments, where arguments are directories of
259 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
260 #
261 # It will recursively scan all compiled python modules in the directories
262 # and determine if they are orphaned (eg. their corresponding .py is missing.)
263 # if they are, then it will remove their corresponding .pyc and .pyo
264 #
265 # This function should only be run in pkg_postrm()
266 python_mod_cleanup() {
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%/}"
275
276 if [ $# -gt 0 ]; then
277 for path in $@; do
278 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
279 done
280 else
281 for path in ${myroot}/usr/lib*/python*/site-packages; do
282 SEARCH_PATH="${SEARCH_PATH} ${path}"
283 done
284 fi
285
286 for path in ${SEARCH_PATH}; do
287 einfo "Cleaning orphaned Python bytecode from ${path} .."
288 for obj in $(find ${path} -name '*.py[co]'); do
289 src_py="${obj%[co]}"
290 if [ ! -f "${src_py}" ]; then
291 einfo "Purging ${src_py}[co]"
292 rm -f ${src_py}[co]
293 fi
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
299 done
300 }

  ViewVC Help
Powered by ViewVC 1.1.20