1 | # Copyright 1999-2003 Gentoo Technologies, Inc. |
1 | # Copyright 1999-2008 Gentoo Foundation |
2 | # Distributed under the terms of the GNU General Public License v2 |
2 | # Distributed under the terms of the GNU General Public License v2 |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.7 2003/10/24 07:12:42 pythonhead Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.52 2008/10/27 00:17:28 hawking Exp $ |
|
|
4 | |
|
|
5 | # @ECLASS: python.eclass |
|
|
6 | # @MAINTAINER: |
|
|
7 | # python@gentoo.org |
4 | # |
8 | # |
5 | # Author: Alastair Tse <liquidx@gentoo.org> |
9 | # original author: Alastair Tse <liquidx@gentoo.org> |
6 | # |
|
|
7 | # A Utility Eclass that should be inherited by anything that deals with |
10 | # @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules. |
8 | # Python or Python modules. |
11 | # @DESCRIPTION: |
9 | # |
12 | # Some useful functions for dealing with python. |
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 |
13 | inherit alternatives multilib |
21 | |
14 | |
22 | ECLASS="python" |
|
|
23 | INHERITED="$INHERITED $ECLASS" |
|
|
24 | |
15 | |
25 | # |
16 | if [[ -n "${NEED_PYTHON}" ]] ; then |
26 | # name: python_disable/enable_pyc |
17 | DEPEND=">=dev-lang/python-${NEED_PYTHON}" |
27 | # desc: tells python not to automatically recompile modules to .pyc/.pyo |
18 | RDEPEND="${DEPEND}" |
28 | # even if the timestamps/version stamps don't match. this is |
19 | fi |
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 | |
20 | |
37 | python_enable_pyc() { |
21 | __python_eclass_test() { |
38 | unset PYTHON_DONTCOMPILE |
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" |
39 | } |
37 | } |
40 | |
38 | |
41 | python_disable_pyc |
39 | # @FUNCTION: python_version |
42 | |
40 | # @DESCRIPTION: |
43 | # |
|
|
44 | # name: python_version |
|
|
45 | # desc: run without arguments and it will export the version of python |
41 | # Run without arguments and it will export the version of python |
46 | # currently in use as $PYVER |
42 | # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR |
47 | # |
43 | __python_version_extract() { |
|
|
44 | local verstr=$1 |
|
|
45 | export PYVER_MAJOR=${verstr:0:1} |
|
|
46 | export PYVER_MINOR=${verstr:2:1} |
|
|
47 | if [[ ${verstr:3:1} == . ]]; then |
|
|
48 | export PYVER_MICRO=${verstr:4} |
|
|
49 | fi |
|
|
50 | export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" |
|
|
51 | } |
|
|
52 | |
48 | python_version() { |
53 | python_version() { |
|
|
54 | [[ -n "${PYVER}" ]] && return 0 |
49 | local tmpstr |
55 | local tmpstr |
50 | python=${python:-/usr/bin/python} |
56 | python=${python:-/usr/bin/python} |
51 | tmpstr="$(${python} -V 2>&1 )" |
57 | tmpstr="$(${python} -V 2>&1 )" |
52 | export PYVER_ALL="${tmpstr#Python }" |
58 | export PYVER_ALL="${tmpstr#Python }" |
53 | |
59 | __python_version_extract $PYVER_ALL |
54 | export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1) |
|
|
55 | export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2) |
|
|
56 | export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-) |
|
|
57 | export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" |
|
|
58 | } |
60 | } |
59 | |
61 | |
|
|
62 | # @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. |
60 | # |
67 | # |
61 | # name: python_makesym |
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 | # @FUNCTION: python_need_rebuild |
|
|
95 | # @DESCRIPTION: Run without arguments, specifies that the package should be |
|
|
96 | # rebuilt after a python upgrade. |
|
|
97 | python_need_rebuild() { |
|
|
98 | python_version |
|
|
99 | export PYTHON_NEED_REBUILD=${PYVER} |
|
|
100 | } |
|
|
101 | |
|
|
102 | # @FUNCTION: python_get_libdir |
|
|
103 | # @DESCRIPTION: |
|
|
104 | # Run without arguments, returns the python library dir |
|
|
105 | python_get_libdir() { |
|
|
106 | python_version |
|
|
107 | echo "/usr/$(get_libdir)/python${PYVER}" |
|
|
108 | } |
|
|
109 | |
|
|
110 | # @FUNCTION: python_get_sitedir |
|
|
111 | # @DESCRIPTION: |
|
|
112 | # Run without arguments, returns the python site-packages dir |
|
|
113 | python_get_sitedir() { |
|
|
114 | echo "$(python_get_libdir)/site-packages" |
|
|
115 | } |
|
|
116 | |
|
|
117 | # @FUNCTION: python_makesym |
|
|
118 | # @DESCRIPTION: |
62 | # desc: run without arguments, it will create the /usr/bin/python symlinks |
119 | # Run without arguments, it will create the /usr/bin/python symlinks |
63 | # to the latest installed version |
120 | # to the latest installed version |
64 | # |
|
|
65 | python_makesym() { |
121 | python_makesym() { |
66 | alternatives_auto_makesym "/usr/bin/python" "/usr/bin/python[0-9].[0-9]" |
122 | alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]" |
67 | alternatives_auto_makesym "/usr/bin/python2" "/usr/bin/python[0-9].[0-9]" |
123 | alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]" |
68 | } |
124 | } |
69 | |
125 | |
70 | # |
|
|
71 | # name: python_tkinter_exists |
126 | # @FUNCTION: python_tkinter_exists |
72 | # desc: run without arguments, it will return TRUE(0) if python is compiled |
127 | # @DESCRIPTION: |
73 | # with tkinter or FALSE(1) if python is compiled without tkinter. |
128 | # Run without arguments, checks if python was compiled with Tkinter |
74 | # |
129 | # support. If not, prints an error message and dies. |
75 | python_tkinter_exists() { |
130 | python_tkinter_exists() { |
76 | if ! python -c "import Tkinter" >/dev/null 2>&1; then |
131 | if ! python -c "import Tkinter" >/dev/null 2>&1; then |
77 | eerror "You need to recompile python with Tkinter support." |
132 | eerror "You need to recompile python with Tkinter support." |
78 | eerror "That means: USE='tcltk' emerge python" |
133 | eerror "Try adding: 'dev-lang/python tk'" |
|
|
134 | eerror "in to /etc/portage/package.use" |
79 | echo |
135 | echo |
80 | die "missing tkinter support with installed python" |
136 | die "missing tkinter support with installed python" |
81 | fi |
137 | fi |
82 | } |
138 | } |
83 | |
139 | |
84 | # |
140 | # @FUNCTION: python_mod_exists |
85 | # name: python_mod_exists |
141 | # @USAGE: < module > |
|
|
142 | # @DESCRIPTION: |
86 | # desc: run with the module name as an argument. it will check if a |
143 | # Run with the module name as an argument. it will check if a |
87 | # python module is installed and loadable. it will return |
144 | # python module is installed and loadable. it will return |
88 | # TRUE(0) if the module exists, and FALSE(1) if the module does |
145 | # TRUE(0) if the module exists, and FALSE(1) if the module does |
89 | # not exist. |
146 | # not exist. |
90 | # exam: |
147 | # |
|
|
148 | # Example: |
91 | # if python_mod_exists gtk; then |
149 | # if python_mod_exists gtk; then |
92 | # echo "gtk support enabled |
150 | # echo "gtk support enabled" |
93 | # fi |
151 | # fi |
94 | # |
|
|
95 | python_mod_exists() { |
152 | python_mod_exists() { |
|
|
153 | [[ "$1" ]] && die "${FUNCNAME} requires an argument!" |
96 | if ! python -c "import $1" >/dev/null 2>&1; then |
154 | python -c "import $1" >/dev/null 2>&1 |
97 | return 1 |
|
|
98 | fi |
|
|
99 | return 0 |
|
|
100 | } |
155 | } |
101 | |
156 | |
102 | # |
157 | # @FUNCTION: python_mod_compile |
103 | # name: python_mod_compile |
158 | # @USAGE: < file > [more files ...] |
|
|
159 | # @DESCRIPTION: |
104 | # desc: given a filename, it will pre-compile the module's .pyc and .pyo. |
160 | # Given filenames, it will pre-compile the module's .pyc and .pyo. |
105 | # should only be run in pkg_postinst() |
161 | # This function should only be run in pkg_postinst() |
106 | # exam: |
162 | # |
|
|
163 | # Example: |
107 | # python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py |
164 | # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py |
108 | # |
165 | # |
109 | python_mod_compile() { |
166 | python_mod_compile() { |
|
|
167 | local f myroot myfiles=() |
|
|
168 | |
|
|
169 | # Check if phase is pkg_postinst() |
|
|
170 | [[ ${EBUILD_PHASE} != postinst ]] &&\ |
|
|
171 | die "${FUNCNAME} should only be run in pkg_postinst()" |
|
|
172 | |
|
|
173 | # allow compiling for older python versions |
|
|
174 | if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then |
|
|
175 | PYVER=${PYTHON_OVERRIDE_PYVER} |
|
|
176 | else |
|
|
177 | python_version |
|
|
178 | fi |
|
|
179 | |
|
|
180 | # strip trailing slash |
|
|
181 | myroot="${ROOT%/}" |
|
|
182 | |
|
|
183 | # respect ROOT |
|
|
184 | for f in "$@"; do |
|
|
185 | [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}") |
|
|
186 | done |
|
|
187 | |
|
|
188 | if ((${#myfiles[@]})); then |
|
|
189 | python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}" |
|
|
190 | python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}" |
|
|
191 | else |
|
|
192 | ewarn "No files to compile!" |
|
|
193 | fi |
|
|
194 | } |
|
|
195 | |
|
|
196 | # @FUNCTION: python_mod_optimize |
|
|
197 | # @USAGE: [ path ] |
|
|
198 | # @DESCRIPTION: |
|
|
199 | # If no arguments supplied, it will recompile all modules under |
|
|
200 | # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) |
|
|
201 | # no recursively |
|
|
202 | # |
|
|
203 | # If supplied with arguments, it will recompile all modules recursively |
|
|
204 | # in the supplied directory |
|
|
205 | # This function should only be run in pkg_postinst() |
|
|
206 | # |
|
|
207 | # Options passed to this function are passed to compileall.py |
|
|
208 | # |
|
|
209 | # Example: |
|
|
210 | # python_mod_optimize /usr/share/codegen |
|
|
211 | python_mod_optimize() { |
|
|
212 | local myroot mydirs=() myfiles=() myopts=() |
|
|
213 | |
|
|
214 | # Check if phase is pkg_postinst() |
|
|
215 | [[ ${EBUILD_PHASE} != postinst ]] &&\ |
|
|
216 | die "${FUNCNAME} should only be run in pkg_postinst()" |
|
|
217 | |
|
|
218 | # strip trailing slash |
|
|
219 | myroot="${ROOT%/}" |
|
|
220 | |
|
|
221 | # respect ROOT and options passed to compileall.py |
|
|
222 | while (($#)); do |
|
|
223 | case $1 in |
|
|
224 | -l|-f|-q) |
|
|
225 | myopts+=("$1") |
|
|
226 | ;; |
|
|
227 | -d|-x) |
|
|
228 | myopts+=("$1" "$2") |
|
|
229 | shift |
|
|
230 | ;; |
|
|
231 | -*) |
|
|
232 | ewarn "${FUNCNAME}: Ignoring compile option $1" |
|
|
233 | ;; |
|
|
234 | *) |
|
|
235 | if [[ -d "${myroot}"/$1 ]]; then |
|
|
236 | mydirs+=("${myroot}/$1") |
|
|
237 | elif [[ -f "${myroot}"/$1 ]]; then |
|
|
238 | # Files are passed to python_mod_compile which is ROOT-aware |
|
|
239 | myfiles+=("$1") |
|
|
240 | elif [[ -e "${myroot}/$1" ]]; then |
|
|
241 | ewarn "${myroot}/$1 is not a file or directory!" |
|
|
242 | else |
|
|
243 | ewarn "${myroot}/$1 doesn't exist!" |
|
|
244 | fi |
|
|
245 | ;; |
|
|
246 | esac |
|
|
247 | shift |
|
|
248 | done |
|
|
249 | |
110 | # allow compiling for older python versions |
250 | # allow compiling for older python versions |
111 | if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then |
251 | if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then |
112 | PYVER=${PYTHON_OVERRIDE_PYVER} |
252 | PYVER=${PYTHON_OVERRIDE_PYVER} |
113 | else |
253 | else |
114 | python_version |
254 | python_version |
115 | fi |
255 | fi |
116 | |
256 | |
117 | if [ -f "$1" ]; then |
257 | # set additional opts |
118 | python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \ |
258 | myopts+=(-q) |
119 | ewarn "Failed to compile ${1}" |
|
|
120 | python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \ |
|
|
121 | ewarn "Failed to compile ${1}" |
|
|
122 | else |
|
|
123 | ewarn "Unable to find ${1}" |
|
|
124 | fi |
|
|
125 | } |
|
|
126 | |
259 | |
127 | # |
|
|
128 | # name: python_mod_optimize |
|
|
129 | # desc: if no arguments supplied, it will recompile all modules under |
|
|
130 | # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) |
|
|
131 | # no recursively |
|
|
132 | # |
|
|
133 | # if supplied with arguments, it will recompile all modules recursively |
|
|
134 | # in the supplied directory |
|
|
135 | # exam: |
|
|
136 | # python_mod_optimize ${ROOT}usr/share/codegen |
|
|
137 | # |
|
|
138 | python_mod_optimize() { |
|
|
139 | # allow compiling for older python versions |
|
|
140 | if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then |
|
|
141 | PYVER=${PYTHON_OVERRIDE_PYVER} |
|
|
142 | else |
|
|
143 | python_version |
|
|
144 | fi |
|
|
145 | |
|
|
146 | # set opts |
|
|
147 | if [ "${PYVER}" = "2.2" ]; then |
|
|
148 | compileopts="" |
|
|
149 | else |
|
|
150 | compileopts="-q" |
|
|
151 | fi |
|
|
152 | |
|
|
153 | ebegin "Byte Compiling Python modules for ${PYVER} .." |
260 | ebegin "Byte compiling python modules for python-${PYVER} .." |
154 | python${PYVER} ${ROOT}usr/lib/python${PYVER}/compileall.py ${compileopts} $@ |
261 | if ((${#mydirs[@]})); then |
155 | python${PYVER} -O ${ROOT}usr/lib/python${PYVER}/compileall.py ${compileopts} $@ |
262 | python${PYVER} \ |
|
|
263 | "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \ |
|
|
264 | "${myopts[@]}" "${mydirs[@]}" |
|
|
265 | python${PYVER} -O \ |
|
|
266 | "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \ |
|
|
267 | "${myopts[@]}" "${mydirs[@]}" |
|
|
268 | fi |
|
|
269 | |
|
|
270 | if ((${#myfiles[@]})); then |
|
|
271 | python_mod_compile "${myfiles[@]}" |
|
|
272 | fi |
|
|
273 | |
156 | eend $? |
274 | eend $? |
157 | } |
275 | } |
158 | |
276 | |
159 | # |
277 | # @FUNCTION: python_mod_cleanup |
160 | # name: python_mod_cleanup |
278 | # @USAGE: [ dir ] |
|
|
279 | # @DESCRIPTION: |
161 | # desc: run with optional arguments, where arguments are directories of |
280 | # Run with optional arguments, where arguments are directories of |
162 | # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9] |
281 | # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9] |
163 | # |
282 | # |
164 | # it will recursively scan all compiled python modules in the directories |
283 | # It will recursively scan all compiled python modules in the directories |
165 | # and determine if they are orphaned (eg. their corresponding .py is missing.) |
284 | # and determine if they are orphaned (eg. their corresponding .py is missing.) |
166 | # if they are, then it will remove their corresponding .pyc and .pyo |
285 | # if they are, then it will remove their corresponding .pyc and .pyo |
167 | # |
286 | # |
|
|
287 | # This function should only be run in pkg_postrm() |
168 | python_mod_cleanup() { |
288 | python_mod_cleanup() { |
169 | local SEARCH_PATH |
289 | local SEARCH_PATH=() myroot src_py |
170 | |
290 | |
171 | if [ $# -gt 0 ]; then |
291 | # Check if phase is pkg_postrm() |
172 | for path in $@; do |
292 | [[ ${EBUILD_PHASE} != postrm ]] &&\ |
173 | SEARCH_PATH="${SEARCH_PATH} ${ROOT}${path#/}" |
293 | die "${FUNCNAME} should only be run in pkg_postrm()" |
174 | done |
294 | |
175 | else |
295 | # strip trailing slash |
176 | for path in ${ROOT}usr/lib/python*/site-packages; do |
296 | myroot="${ROOT%/}" |
|
|
297 | |
|
|
298 | if (($#)); then |
|
|
299 | SEARCH_PATH=("${@#/}") |
177 | SEARCH_PATH="${SEARCH_PATH} ${path}" |
300 | SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}") |
178 | done |
301 | else |
|
|
302 | SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages) |
179 | fi |
303 | fi |
180 | |
304 | |
181 | for path in ${SEARCH_PATH}; do |
305 | for path in "${SEARCH_PATH[@]}"; do |
182 | einfo "Searching ${path} .." |
306 | einfo "Cleaning orphaned Python bytecode from ${path} .." |
183 | for obj in $(find ${path} -name *.pyc); do |
307 | while read -rd ''; do |
184 | src_py="$(echo $obj | sed 's:c$::')" |
308 | src_py="${REPLY%[co]}" |
185 | if [ ! -f "${src_py}" ]; then |
309 | [[ -f "${src_py}" ]] && continue |
186 | einfo "Purging ${src_py}[co]" |
310 | einfo "Purging ${src_py}[co]" |
187 | rm -f ${src_py}[co] |
311 | rm -f "${src_py}"[co] |
188 | fi |
312 | done < <(find "${path}" -name '*.py[co]' -print0) |
189 | done |
313 | |
|
|
314 | # attempt to remove directories that maybe empty |
|
|
315 | while read -r dir; do |
|
|
316 | rmdir "${dir}" 2>/dev/null |
|
|
317 | done < <(find "${path}" -type d | sort -r) |
190 | done |
318 | done |
191 | } |
319 | } |
192 | |
|
|
193 | |
|
|