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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.16 - (show annotations) (download)
Wed Apr 20 15:43:37 2005 UTC (9 years, 4 months ago) by liquidx
Branch: MAIN
Changes since 1.15: +12 -11 lines
python eclass bash-fu skills upgrade

1 # Copyright 1999-2004 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.15 2005/02/13 14:05:54 eradicator Exp $
4 #
5 # Author: Alastair Tse <liquidx@gentoo.org>
6 #
7 # A Utility Eclass that should be inherited by anything that deals with
8 # Python or Python modules.
9 #
10 # - Features:
11 # python_version() - sets PYVER/PYVER_MAJOR/PYVER_MINOR
12 # python_tkinter_exists() - Checks for tkinter support in python
13 # python_mod_exists() - Checks if a python module exists
14 # python_mod_compile() - Compiles a .py file to a .pyc/.pyo
15 # python_mod_optimize() - Generates .pyc/.pyo precompiled scripts
16 # python_mod_cleanup() - Goes through /usr/lib*/python* to remove
17 # orphaned *.pyc *.pyo
18 # python_makesym() - Makes /usr/bin/python symlinks
19
20 inherit alternatives
21
22 ECLASS="python"
23 INHERITED="$INHERITED $ECLASS"
24
25 #
26 # name: python_disable/enable_pyc
27 # desc: tells python not to automatically recompile modules to .pyc/.pyo
28 # even if the timestamps/version stamps don't match. this is
29 # done to protect sandbox.
30 #
31 # note: supported by >=dev-lang/python-2.2.3-r3 only.
32 #
33 python_disable_pyc() {
34 export PYTHON_DONTCOMPILE=1
35 }
36
37 python_enable_pyc() {
38 unset PYTHON_DONTCOMPILE
39 }
40
41 python_disable_pyc
42
43 #
44 # name: python_version
45 # desc: run without arguments and it will export the version of python
46 # currently in use as $PYVER
47 #
48 python_version() {
49 local tmpstr
50 python=${python:-/usr/bin/python}
51 tmpstr="$(${python} -V 2>&1 )"
52 export PYVER_ALL="${tmpstr#Python }"
53
54 export PYVER="${PYVER_ALL%.*}"
55 export PYVER_MAJOR="${PYVER%.*}"
56 export PYVER_MINOR="${PYVER##*.}"
57 export PYVER_MICRO="${PYVER_ALL##*.}"
58 }
59
60 #
61 # name: python_makesym
62 # desc: run without arguments, it will create the /usr/bin/python symlinks
63 # to the latest installed version
64 #
65 python_makesym() {
66 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
67 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
68 }
69
70 #
71 # name: python_tkinter_exists
72 # desc: run without arguments, checks if python was compiled with Tkinter
73 # support. If not, prints an error message and dies.
74 #
75 python_tkinter_exists() {
76 if ! python -c "import Tkinter" >/dev/null 2>&1; then
77 eerror "You need to recompile python with Tkinter support."
78 eerror "That means: USE='tcltk' emerge python"
79 echo
80 die "missing tkinter support with installed python"
81 fi
82 }
83
84 #
85 # name: python_mod_exists
86 # desc: run with the module name as an argument. it will check if a
87 # python module is installed and loadable. it will return
88 # TRUE(0) if the module exists, and FALSE(1) if the module does
89 # not exist.
90 # exam:
91 # if python_mod_exists gtk; then
92 # echo "gtk support enabled
93 # fi
94 #
95 python_mod_exists() {
96 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
97 if ! python -c "import $1" >/dev/null 2>&1; then
98 return 1
99 fi
100 return 0
101 }
102
103 #
104 # name: python_mod_compile
105 # desc: given a filename, it will pre-compile the module's .pyc and .pyo.
106 # should only be run in pkg_postinst()
107 # exam:
108 # python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
109 #
110 python_mod_compile() {
111 # allow compiling for older python versions
112 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
113 PYVER=${PYTHON_OVERRIDE_PYVER}
114 else
115 python_version
116 fi
117
118 if [ -f "$1" ]; then
119 python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
120 ewarn "Failed to compile ${1}"
121 python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
122 ewarn "Failed to compile ${1}"
123 else
124 ewarn "Unable to find ${1}"
125 fi
126 }
127
128 #
129 # name: python_mod_optimize
130 # desc: if no arguments supplied, it will recompile all modules under
131 # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
132 # no recursively
133 #
134 # if supplied with arguments, it will recompile all modules recursively
135 # in the supplied directory
136 # exam:
137 # python_mod_optimize ${ROOT}usr/share/codegen
138 #
139 python_mod_optimize() {
140 local myroot
141 # strip trailing slash
142 myroot="${ROOT%/}"
143
144 # allow compiling for older python versions
145 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
146 PYVER=${PYTHON_OVERRIDE_PYVER}
147 else
148 python_version
149 fi
150
151 # set opts
152 if [ "${PYVER}" = "2.2" ]; then
153 compileopts=""
154 else
155 compileopts="-q"
156 fi
157
158 ebegin "Byte compiling python modules for python-${PYVER} .."
159 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
160 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
161 eend $?
162 }
163
164 #
165 # name: python_mod_cleanup
166 # desc: run with optional arguments, where arguments are directories of
167 # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
168 #
169 # it will recursively scan all compiled python modules in the directories
170 # and determine if they are orphaned (eg. their corresponding .py is missing.)
171 # if they are, then it will remove their corresponding .pyc and .pyo
172 #
173 python_mod_cleanup() {
174 local SEARCH_PATH myroot
175
176 # strip trailing slash
177 myroot="${ROOT%/}"
178
179 if [ $# -gt 0 ]; then
180 for path in $@; do
181 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
182 done
183 else
184 for path in ${myroot}/usr/lib*/python*/site-packages; do
185 SEARCH_PATH="${SEARCH_PATH} ${path}"
186 done
187 fi
188
189 for path in ${SEARCH_PATH}; do
190 einfo "Cleaning orphaned Python bytecode from ${path} .."
191 for obj in $(find ${path} -name *.pyc); do
192 src_py="${obj%c}"
193 if [ ! -f "${src_py}" ]; then
194 einfo "Purging ${src_py}[co]"
195 rm -f ${src_py}[co]
196 fi
197 done
198 # attempt to remove directories that maybe empty
199 for dir in $(find ${path} -type d | sort -r); do
200 rmdir ${dir} 2>/dev/null
201 done
202 done
203 }

  ViewVC Help
Powered by ViewVC 1.1.20