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

Diff of /eclass/python.eclass

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

Revision 1.24 Revision 1.34
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.24 2006/06/10 16:19:54 swegener Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.34 2008/03/28 07:11:57 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
22 15
23if [[ -n "${NEED_PYTHON}" ]] ; then 16if [[ -n "${NEED_PYTHON}" ]] ; then
24 DEPEND=">=dev-lang/python-${NEED_PYTHON}" 17 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
25 RDEPEND="${DEPEND}" 18 RDEPEND="${DEPEND}"
36 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 29 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
37 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 30 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
38 __python_version_extract 2.4 31 __python_version_extract 2.4
39 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR" 32 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
40 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO" 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"
41} 37}
42 38
43# 39# @FUNCTION: python_disable_pyc
44# name: python_disable/enable_pyc 40# @DESCRIPTION:
45# desc: tells python not to automatically recompile modules to .pyc/.pyo 41# Tells python not to automatically recompile modules to .pyc/.pyo
46# even if the timestamps/version stamps don't match. this is 42# even if the timestamps/version stamps don't match. This is done
47# done to protect sandbox. 43# to protect sandbox.
48# 44#
49# note: supported by >=dev-lang/python-2.2.3-r3 only. 45# note: supported by >=dev-lang/python-2.2.3-r3 only.
50# 46#
51python_disable_pyc() { 47python_disable_pyc() {
52 export PYTHON_DONTCOMPILE=1 48 export PYTHON_DONTCOMPILE=1
53} 49}
54 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
55python_enable_pyc() { 55python_enable_pyc() {
56 unset PYTHON_DONTCOMPILE 56 unset PYTHON_DONTCOMPILE
57} 57}
58 58
59python_disable_pyc 59python_disable_pyc
60 60
61# 61# @FUNCTION: python_version
62# name: python_version 62# @DESCRIPTION:
63# desc: run without arguments and it will export the version of python 63# Run without arguments and it will export the version of python
64# currently in use as $PYVER 64# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65#
66
67__python_version_extract() { 65__python_version_extract() {
68 verstr=$1 66 verstr=$1
69 export PYVER_MAJOR=${verstr:0:1} 67 export PYVER_MAJOR=${verstr:0:1}
70 export PYVER_MINOR=${verstr:2:1} 68 export PYVER_MINOR=${verstr:2:1}
69 if [ "${verstr:3}x" = ".x" ]; then
71 export PYVER_MICRO=${verstr:4} 70 export PYVER_MICRO=${verstr:4}
71 fi
72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}" 72 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73} 73}
74 74
75python_version() { 75python_version() {
76 local tmpstr 76 local tmpstr
78 tmpstr="$(${python} -V 2>&1 )" 78 tmpstr="$(${python} -V 2>&1 )"
79 export PYVER_ALL="${tmpstr#Python }" 79 export PYVER_ALL="${tmpstr#Python }"
80 __python_version_extract $PYVER_ALL 80 __python_version_extract $PYVER_ALL
81} 81}
82 82
83# 83# @FUNCTION: python_makesym
84# name: python_makesym 84# @DESCRIPTION:
85# desc: run without arguments, it will create the /usr/bin/python symlinks 85# Run without arguments, it will create the /usr/bin/python symlinks
86# to the latest installed version 86# to the latest installed version
87#
88python_makesym() { 87python_makesym() {
89 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]" 88 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
90 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]" 89 alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
91} 90}
92 91
93#
94# name: python_tkinter_exists 92# @FUNCTION: python_tkinter_exists
93# @DESCRIPTION:
95# desc: run without arguments, checks if python was compiled with Tkinter 94# Run without arguments, checks if python was compiled with Tkinter
96# support. If not, prints an error message and dies. 95# support. If not, prints an error message and dies.
97#
98python_tkinter_exists() { 96python_tkinter_exists() {
99 if ! python -c "import Tkinter" >/dev/null 2>&1; then 97 if ! python -c "import Tkinter" >/dev/null 2>&1; then
100 eerror "You need to recompile python with Tkinter support." 98 eerror "You need to recompile python with Tkinter support."
101 eerror "That means: USE='tcltk' emerge python" 99 eerror "Try adding: 'dev-lang/python tk'"
100 eerror "in to /etc/portage/package.use"
102 echo 101 echo
103 die "missing tkinter support with installed python" 102 die "missing tkinter support with installed python"
104 fi 103 fi
105} 104}
106 105
107# 106# @FUNCTION: python_mod_exists
108# name: python_mod_exists 107# @USAGE: < module >
108# @DESCRIPTION:
109# desc: run with the module name as an argument. it will check if a 109# Run with the module name as an argument. it will check if a
110# python module is installed and loadable. it will return 110# python module is installed and loadable. it will return
111# TRUE(0) if the module exists, and FALSE(1) if the module does 111# TRUE(0) if the module exists, and FALSE(1) if the module does
112# not exist. 112# not exist.
113# exam: 113#
114# Example:
114# if python_mod_exists gtk; then 115# if python_mod_exists gtk; then
115# echo "gtk support enabled 116# echo "gtk support enabled"
116# fi 117# fi
117#
118python_mod_exists() { 118python_mod_exists() {
119 [ -z "$1" ] && die "${FUNCTION} requires an argument!" 119 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 if ! python -c "import $1" >/dev/null 2>&1; then 120 if ! python -c "import $1" >/dev/null 2>&1; then
121 return 1 121 return 1
122 fi 122 fi
123 return 0 123 return 0
124} 124}
125 125
126# 126# @FUNCTION: python_mod_compile
127# name: python_mod_compile 127# @USAGE: < file >
128# @DESCRIPTION:
128# desc: given a filename, it will pre-compile the module's .pyc and .pyo. 129# Given a filename, it will pre-compile the module's .pyc and .pyo.
129# should only be run in pkg_postinst() 130# should only be run in pkg_postinst()
130# exam: 131#
132# Example:
131# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py 133# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
132# 134#
133python_mod_compile() { 135python_mod_compile() {
134 # allow compiling for older python versions 136 # allow compiling for older python versions
135 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then 137 if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
146 else 148 else
147 ewarn "Unable to find ${1}" 149 ewarn "Unable to find ${1}"
148 fi 150 fi
149} 151}
150 152
151#
152# name: python_mod_optimize 153# @FUNCTION: python_mod_optimize
154# @USAGE: [ path ]
155# @DESCRIPTION:
153# desc: if no arguments supplied, it will recompile all modules under 156# If no arguments supplied, it will recompile all modules under
154# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..) 157# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
155# no recursively 158# no recursively
156# 159#
157# if supplied with arguments, it will recompile all modules recursively 160# If supplied with arguments, it will recompile all modules recursively
158# in the supplied directory 161# in the supplied directory
159# exam: 162#
163# Example:
160# python_mod_optimize ${ROOT}usr/share/codegen 164# python_mod_optimize ${ROOT}usr/share/codegen
161#
162python_mod_optimize() { 165python_mod_optimize() {
163 local myroot 166 local myroot
164 # strip trailing slash 167 # strip trailing slash
165 myroot="${ROOT%/}" 168 myroot="${ROOT%/}"
166 169
177 else 180 else
178 compileopts="-q" 181 compileopts="-q"
179 fi 182 fi
180 183
181 ebegin "Byte compiling python modules for python-${PYVER} .." 184 ebegin "Byte compiling python modules for python-${PYVER} .."
182 python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 185 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
183 python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@ 186 python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
184 eend $? 187 eend $?
185} 188}
186 189
187# 190# @FUNCTION: python_mod_cleanup
188# name: python_mod_cleanup 191# @USAGE: [ dir ]
192# @DESCRIPTION:
189# desc: run with optional arguments, where arguments are directories of 193# Run with optional arguments, where arguments are directories of
190# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9] 194# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
191# 195#
192# it will recursively scan all compiled python modules in the directories 196# It will recursively scan all compiled python modules in the directories
193# and determine if they are orphaned (eg. their corresponding .py is missing.) 197# and determine if they are orphaned (eg. their corresponding .py is missing.)
194# if they are, then it will remove their corresponding .pyc and .pyo 198# if they are, then it will remove their corresponding .pyc and .pyo
195#
196python_mod_cleanup() { 199python_mod_cleanup() {
197 local SEARCH_PATH myroot 200 local SEARCH_PATH myroot
198 201
199 # strip trailing slash 202 # strip trailing slash
200 myroot="${ROOT%/}" 203 myroot="${ROOT%/}"
209 done 212 done
210 fi 213 fi
211 214
212 for path in ${SEARCH_PATH}; do 215 for path in ${SEARCH_PATH}; do
213 einfo "Cleaning orphaned Python bytecode from ${path} .." 216 einfo "Cleaning orphaned Python bytecode from ${path} .."
214 for obj in $(find ${path} -name *.pyc); do 217 for obj in $(find ${path} -name '*.py[co]'); do
215 src_py="${obj%c}" 218 src_py="${obj%[co]}"
216 if [ ! -f "${src_py}" ]; then 219 if [ ! -f "${src_py}" ]; then
217 einfo "Purging ${src_py}[co]" 220 einfo "Purging ${src_py}[co]"
218 rm -f ${src_py}[co] 221 rm -f ${src_py}[co]
219 fi 222 fi
220 done 223 done

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.34

  ViewVC Help
Powered by ViewVC 1.1.20