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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (show annotations) (download)
Fri Mar 28 07:11:57 2008 UTC (6 years, 3 months ago) by hawking
Branch: MAIN
Changes since 1.33: +2 -2 lines
Add quoting for find, thanks to Yanik Gleyzer, bug 214830

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.33 2008/02/28 20:20:32 dev-zero 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 >
128 # @DESCRIPTION:
129 # Given a filename, it will pre-compile the module's .pyc and .pyo.
130 # should only be run in pkg_postinst()
131 #
132 # Example:
133 # python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
134 #
135 python_mod_compile() {
136 # allow compiling for older python versions
137 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
138 PYVER=${PYTHON_OVERRIDE_PYVER}
139 else
140 python_version
141 fi
142
143 if [ -f "$1" ]; then
144 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
145 ewarn "Failed to compile ${1}"
146 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
147 ewarn "Failed to compile ${1}"
148 else
149 ewarn "Unable to find ${1}"
150 fi
151 }
152
153 # @FUNCTION: python_mod_optimize
154 # @USAGE: [ path ]
155 # @DESCRIPTION:
156 # If no arguments supplied, it will recompile all modules under
157 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
158 # no recursively
159 #
160 # If supplied with arguments, it will recompile all modules recursively
161 # in the supplied directory
162 #
163 # Example:
164 # python_mod_optimize ${ROOT}usr/share/codegen
165 python_mod_optimize() {
166 local myroot
167 # strip trailing slash
168 myroot="${ROOT%/}"
169
170 # allow compiling for older python versions
171 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
172 PYVER=${PYTHON_OVERRIDE_PYVER}
173 else
174 python_version
175 fi
176
177 # set opts
178 if [ "${PYVER}" = "2.2" ]; then
179 compileopts=""
180 else
181 compileopts="-q"
182 fi
183
184 ebegin "Byte compiling python modules for python-${PYVER} .."
185 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
186 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
187 eend $?
188 }
189
190 # @FUNCTION: python_mod_cleanup
191 # @USAGE: [ dir ]
192 # @DESCRIPTION:
193 # Run with optional arguments, where arguments are directories of
194 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
195 #
196 # It will recursively scan all compiled python modules in the directories
197 # and determine if they are orphaned (eg. their corresponding .py is missing.)
198 # if they are, then it will remove their corresponding .pyc and .pyo
199 python_mod_cleanup() {
200 local SEARCH_PATH myroot
201
202 # strip trailing slash
203 myroot="${ROOT%/}"
204
205 if [ $# -gt 0 ]; then
206 for path in $@; do
207 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
208 done
209 else
210 for path in ${myroot}/usr/lib*/python*/site-packages; do
211 SEARCH_PATH="${SEARCH_PATH} ${path}"
212 done
213 fi
214
215 for path in ${SEARCH_PATH}; do
216 einfo "Cleaning orphaned Python bytecode from ${path} .."
217 for obj in $(find ${path} -name '*.py[co]'); do
218 src_py="${obj%[co]}"
219 if [ ! -f "${src_py}" ]; then
220 einfo "Purging ${src_py}[co]"
221 rm -f ${src_py}[co]
222 fi
223 done
224 # attempt to remove directories that maybe empty
225 for dir in $(find ${path} -type d | sort -r); do
226 rmdir ${dir} 2>/dev/null
227 done
228 done
229 }

  ViewVC Help
Powered by ViewVC 1.1.20