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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (hide annotations) (download)
Sun Oct 26 17:34:44 2008 UTC (6 years, 2 months ago) by hawking
Branch: MAIN
Changes since 1.47: +7 -7 lines
Bashify python_mod_compile, thanks to Steve Long.

1 dev-zero 1.33 # Copyright 1999-2008 Gentoo Foundation
2 liquidx 1.1 # Distributed under the terms of the GNU General Public License v2
3 hawking 1.48 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.47 2008/10/26 17:26:18 hawking Exp $
4 liquidx 1.1
5 dev-zero 1.33 # @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 kloeri 1.32 inherit alternatives multilib
14 liquidx 1.1
15 liquidx 1.2
16 carlo 1.23 if [[ -n "${NEED_PYTHON}" ]] ; then
17 swegener 1.24 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18     RDEPEND="${DEPEND}"
19 carlo 1.22 fi
20 liquidx 1.18
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 liquidx 1.28 __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 liquidx 1.18 }
38    
39 dev-zero 1.33 # @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 liquidx 1.18 __python_version_extract() {
44 hawking 1.45 local verstr=$1
45 liquidx 1.18 export PYVER_MAJOR=${verstr:0:1}
46     export PYVER_MINOR=${verstr:2:1}
47 hawking 1.47 if [[ ${verstr:3:1} == . ]]; then
48 swegener 1.29 export PYVER_MICRO=${verstr:4}
49 liquidx 1.28 fi
50 swegener 1.21 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
51 liquidx 1.18 }
52    
53 liquidx 1.1 python_version() {
54 hawking 1.44 [[ -n "${PYVER}" ]] && return 0
55 liquidx 1.1 local tmpstr
56     python=${python:-/usr/bin/python}
57     tmpstr="$(${python} -V 2>&1 )"
58     export PYVER_ALL="${tmpstr#Python }"
59 liquidx 1.18 __python_version_extract $PYVER_ALL
60 liquidx 1.1 }
61    
62 hawking 1.46 # @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 pythonhead 1.43 # @FUNCTION: python_get_libdir
95     # @DESCRIPTION:
96 pythonhead 1.42 # Run without arguments, returns the python library dir
97 pythonhead 1.43 python_get_libdir() {
98 pythonhead 1.42 python_version
99     echo "/usr/$(get_libdir)/python${PYVER}"
100     }
101    
102 pythonhead 1.43 # @FUNCTION: python_get_sitedir
103     # @DESCRIPTION:
104 pythonhead 1.42 # Run without arguments, returns the python site-packages dir
105 pythonhead 1.43 python_get_sitedir() {
106     echo "$(python_get_libdir)/site-packages"
107 pythonhead 1.42 }
108    
109 dev-zero 1.33 # @FUNCTION: python_makesym
110     # @DESCRIPTION:
111     # Run without arguments, it will create the /usr/bin/python symlinks
112     # to the latest installed version
113 liquidx 1.1 python_makesym() {
114 liquidx 1.10 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
115     alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
116 liquidx 1.1 }
117    
118 dev-zero 1.33 # @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 liquidx 1.1 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 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
126 liquidx 1.27 eerror "in to /etc/portage/package.use"
127 liquidx 1.1 echo
128     die "missing tkinter support with installed python"
129     fi
130     }
131    
132 dev-zero 1.33 # @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 liquidx 1.1 #
140 dev-zero 1.33 # Example:
141 liquidx 1.1 # if python_mod_exists gtk; then
142 liquidx 1.28 # echo "gtk support enabled"
143 liquidx 1.1 # fi
144     python_mod_exists() {
145 hawking 1.47 [[ "$1" ]] && die "${FUNCNAME} requires an argument!"
146     python -c "import $1" >/dev/null 2>&1
147 liquidx 1.1 }
148    
149 dev-zero 1.33 # @FUNCTION: python_mod_compile
150 hawking 1.35 # @USAGE: < file > [more files ...]
151 dev-zero 1.33 # @DESCRIPTION:
152 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
153 hawking 1.37 # This function should only be run in pkg_postinst()
154 liquidx 1.1 #
155 dev-zero 1.33 # Example:
156 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
157 liquidx 1.1 #
158     python_mod_compile() {
159 hawking 1.48 local f myroot myfiles=()
160 hawking 1.37
161     # Check if phase is pkg_postinst()
162     [[ ${EBUILD_PHASE} != postinst ]] &&\
163 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
164 hawking 1.37
165 liquidx 1.5 # allow compiling for older python versions
166 hawking 1.48 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
167 liquidx 1.5 PYVER=${PYTHON_OVERRIDE_PYVER}
168 pythonhead 1.7 else
169 liquidx 1.5 python_version
170     fi
171 pythonhead 1.7
172 hawking 1.35 # strip trailing slash
173     myroot="${ROOT%/}"
174    
175     # respect ROOT
176     for f in $@; do
177 hawking 1.48 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
178 hawking 1.35 done
179    
180 hawking 1.48 if ((${#myfiles[@]})); then
181     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
182     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
183 liquidx 1.1 else
184 hawking 1.35 ewarn "No files to compile!"
185 pythonhead 1.7 fi
186 liquidx 1.1 }
187    
188 dev-zero 1.33 # @FUNCTION: python_mod_optimize
189     # @USAGE: [ path ]
190     # @DESCRIPTION:
191     # If no arguments supplied, it will recompile all modules under
192     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
193     # no recursively
194 liquidx 1.1 #
195 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
196     # in the supplied directory
197 hawking 1.37 # This function should only be run in pkg_postinst()
198 dev-zero 1.33 #
199 hawking 1.39 # Options passed to this function are passed to compileall.py
200     #
201 dev-zero 1.33 # Example:
202 hawking 1.36 # python_mod_optimize /usr/share/codegen
203 liquidx 1.1 python_mod_optimize() {
204 hawking 1.40 local mydirs myfiles myroot myopts
205 hawking 1.37
206     # Check if phase is pkg_postinst()
207     [[ ${EBUILD_PHASE} != postinst ]] &&\
208 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
209 hawking 1.37
210 liquidx 1.13 # strip trailing slash
211 liquidx 1.16 myroot="${ROOT%/}"
212 liquidx 1.13
213 hawking 1.39 # respect ROOT and options passed to compileall.py
214     while [ $# -gt 0 ]; do
215     case $1 in
216     -l|-f|-q)
217     myopts="${myopts} $1"
218     ;;
219     -d|-x)
220 hawking 1.41 myopts="${myopts} $1 $2"
221 hawking 1.39 shift
222     ;;
223     -*)
224     ewarn "${FUNCNAME}: Ignoring compile option $1"
225     ;;
226     *)
227 hawking 1.40 [ ! -e "${myroot}/${1}" ] && ewarn "${myroot}/${1} doesn't exist!"
228     [ -d "${myroot}/${1#/}" ] && mydirs="${mydirs} ${myroot}/${1#/}"
229     # Files are passed to python_mod_compile which is ROOT-aware
230     [ -f "${myroot}/${1}" ] && myfiles="${myfiles} ${1}"
231 hawking 1.39 ;;
232     esac
233     shift
234 hawking 1.36 done
235    
236 liquidx 1.5 # allow compiling for older python versions
237     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
238     PYVER=${PYTHON_OVERRIDE_PYVER}
239 pythonhead 1.7 else
240 liquidx 1.5 python_version
241     fi
242 pythonhead 1.7
243 hawking 1.41 # set additional opts
244     myopts="${myopts} -q"
245 pythonhead 1.7
246 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
247 hawking 1.36 if [ -n "${mydirs}" ]; then
248     python${PYVER} \
249     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
250 hawking 1.41 ${myopts} ${mydirs}
251 hawking 1.36 python${PYVER} -O \
252     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
253 hawking 1.41 ${myopts} ${mydirs}
254 hawking 1.36 fi
255    
256     if [ -n "${myfiles}" ]; then
257     python_mod_compile ${myfiles}
258     fi
259    
260 liquidx 1.5 eend $?
261 liquidx 1.1 }
262    
263 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
264     # @USAGE: [ dir ]
265     # @DESCRIPTION:
266     # Run with optional arguments, where arguments are directories of
267     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
268     #
269     # It will recursively scan all compiled python modules in the directories
270     # and determine if they are orphaned (eg. their corresponding .py is missing.)
271     # if they are, then it will remove their corresponding .pyc and .pyo
272 hawking 1.37 #
273     # This function should only be run in pkg_postrm()
274 liquidx 1.1 python_mod_cleanup() {
275 liquidx 1.13 local SEARCH_PATH myroot
276 liquidx 1.16
277 hawking 1.38 # Check if phase is pkg_postrm()
278 hawking 1.37 [[ ${EBUILD_PHASE} != postrm ]] &&\
279 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postrm()"
280 hawking 1.37
281 liquidx 1.13 # strip trailing slash
282 liquidx 1.16 myroot="${ROOT%/}"
283 liquidx 1.1
284 liquidx 1.5 if [ $# -gt 0 ]; then
285     for path in $@; do
286 liquidx 1.13 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
287 pythonhead 1.7 done
288 liquidx 1.5 else
289 eradicator 1.15 for path in ${myroot}/usr/lib*/python*/site-packages; do
290 liquidx 1.5 SEARCH_PATH="${SEARCH_PATH} ${path}"
291     done
292     fi
293 pythonhead 1.7
294 liquidx 1.1 for path in ${SEARCH_PATH}; do
295 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
296 hawking 1.34 for obj in $(find ${path} -name '*.py[co]'); do
297 kloeri 1.31 src_py="${obj%[co]}"
298 liquidx 1.1 if [ ! -f "${src_py}" ]; then
299     einfo "Purging ${src_py}[co]"
300     rm -f ${src_py}[co]
301     fi
302 liquidx 1.12 done
303     # attempt to remove directories that maybe empty
304     for dir in $(find ${path} -type d | sort -r); do
305     rmdir ${dir} 2>/dev/null
306 liquidx 1.1 done
307 pythonhead 1.7 done
308 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20