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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.20