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

Diff of /eclass/python.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20