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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.16

  ViewVC Help
Powered by ViewVC 1.1.20