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

Diff of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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