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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.38 - (hide annotations) (download)
Thu May 29 20:01:55 2008 UTC (6 years, 6 months ago) by hawking
Branch: MAIN
Changes since 1.37: +2 -2 lines
Fixed typo in python_mod_cleanup.

1 dev-zero 1.33 # Copyright 1999-2008 Gentoo Foundation
2 liquidx 1.1 # Distributed under the terms of the GNU General Public License v2
3 hawking 1.38 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.37 2008/05/29 18:36:20 hawking Exp $
4 liquidx 1.1
5 dev-zero 1.33 # @ECLASS: python.eclass
6     # @MAINTAINER:
7     # python@gentoo.org
8     #
9     # original author: Alastair Tse <liquidx@gentoo.org>
10     # @BLURB: A Utility Eclass that should be inherited by anything that deals with Python or Python modules.
11     # @DESCRIPTION:
12     # Some useful functions for dealing with python.
13 kloeri 1.32 inherit alternatives multilib
14 liquidx 1.1
15 liquidx 1.2
16 carlo 1.23 if [[ -n "${NEED_PYTHON}" ]] ; then
17 swegener 1.24 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18     RDEPEND="${DEPEND}"
19 carlo 1.22 fi
20 liquidx 1.18
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 liquidx 1.28 __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 liquidx 1.18 }
38    
39 dev-zero 1.33 # @FUNCTION: python_disable_pyc
40     # @DESCRIPTION:
41     # Tells python not to automatically recompile modules to .pyc/.pyo
42     # even if the timestamps/version stamps don't match. This is done
43     # to protect sandbox.
44 liquidx 1.5 #
45     # note: supported by >=dev-lang/python-2.2.3-r3 only.
46     #
47 liquidx 1.2 python_disable_pyc() {
48 liquidx 1.3 export PYTHON_DONTCOMPILE=1
49 liquidx 1.2 }
50 liquidx 1.1
51 dev-zero 1.33 # @FUNCTION: python_enable_pyc
52     # @DESCRIPTION:
53     # Tells python to automatically recompile modules to .pyc/.pyo if the
54     # timestamps/version stamps change
55 liquidx 1.4 python_enable_pyc() {
56     unset PYTHON_DONTCOMPILE
57     }
58    
59     python_disable_pyc
60    
61 dev-zero 1.33 # @FUNCTION: python_version
62     # @DESCRIPTION:
63     # Run without arguments and it will export the version of python
64     # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65 liquidx 1.18 __python_version_extract() {
66     verstr=$1
67     export PYVER_MAJOR=${verstr:0:1}
68     export PYVER_MINOR=${verstr:2:1}
69 liquidx 1.28 if [ "${verstr:3}x" = ".x" ]; then
70 swegener 1.29 export PYVER_MICRO=${verstr:4}
71 liquidx 1.28 fi
72 swegener 1.21 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
73 liquidx 1.18 }
74    
75 liquidx 1.1 python_version() {
76     local tmpstr
77     python=${python:-/usr/bin/python}
78     tmpstr="$(${python} -V 2>&1 )"
79     export PYVER_ALL="${tmpstr#Python }"
80 liquidx 1.18 __python_version_extract $PYVER_ALL
81 liquidx 1.1 }
82    
83 dev-zero 1.33 # @FUNCTION: python_makesym
84     # @DESCRIPTION:
85     # Run without arguments, it will create the /usr/bin/python symlinks
86     # to the latest installed version
87 liquidx 1.1 python_makesym() {
88 liquidx 1.10 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
89     alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
90 liquidx 1.1 }
91    
92 dev-zero 1.33 # @FUNCTION: python_tkinter_exists
93     # @DESCRIPTION:
94     # Run without arguments, checks if python was compiled with Tkinter
95     # support. If not, prints an error message and dies.
96 liquidx 1.1 python_tkinter_exists() {
97     if ! python -c "import Tkinter" >/dev/null 2>&1; then
98     eerror "You need to recompile python with Tkinter support."
99 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
100 liquidx 1.27 eerror "in to /etc/portage/package.use"
101 liquidx 1.1 echo
102     die "missing tkinter support with installed python"
103     fi
104     }
105    
106 dev-zero 1.33 # @FUNCTION: python_mod_exists
107     # @USAGE: < module >
108     # @DESCRIPTION:
109     # Run with the module name as an argument. it will check if a
110     # python module is installed and loadable. it will return
111     # TRUE(0) if the module exists, and FALSE(1) if the module does
112     # not exist.
113 liquidx 1.1 #
114 dev-zero 1.33 # Example:
115 liquidx 1.1 # if python_mod_exists gtk; then
116 liquidx 1.28 # echo "gtk support enabled"
117 liquidx 1.1 # fi
118     python_mod_exists() {
119 liquidx 1.16 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
120 pythonhead 1.7 if ! python -c "import $1" >/dev/null 2>&1; then
121 liquidx 1.1 return 1
122     fi
123     return 0
124     }
125    
126 dev-zero 1.33 # @FUNCTION: python_mod_compile
127 hawking 1.35 # @USAGE: < file > [more files ...]
128 dev-zero 1.33 # @DESCRIPTION:
129 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
130 hawking 1.37 # This function should only be run in pkg_postinst()
131 liquidx 1.1 #
132 dev-zero 1.33 # Example:
133 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
134 liquidx 1.1 #
135     python_mod_compile() {
136 hawking 1.35 local f myroot
137 hawking 1.37
138     # Check if phase is pkg_postinst()
139     [[ ${EBUILD_PHASE} != postinst ]] &&\
140     die "${FUNCNAME} should only be run in pkg_postinst()"
141    
142 liquidx 1.5 # allow compiling for older python versions
143     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
144     PYVER=${PYTHON_OVERRIDE_PYVER}
145 pythonhead 1.7 else
146 liquidx 1.5 python_version
147     fi
148 pythonhead 1.7
149 hawking 1.35 # strip trailing slash
150     myroot="${ROOT%/}"
151    
152     # respect ROOT
153     for f in $@; do
154     [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
155     done
156    
157     if [ -n "${myfiles}" ]; then
158     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
159     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
160 liquidx 1.1 else
161 hawking 1.35 ewarn "No files to compile!"
162 pythonhead 1.7 fi
163 liquidx 1.1 }
164    
165 dev-zero 1.33 # @FUNCTION: python_mod_optimize
166     # @USAGE: [ path ]
167     # @DESCRIPTION:
168     # If no arguments supplied, it will recompile all modules under
169     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
170     # no recursively
171 liquidx 1.1 #
172 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
173     # in the supplied directory
174 hawking 1.37 # This function should only be run in pkg_postinst()
175 dev-zero 1.33 #
176     # Example:
177 hawking 1.36 # python_mod_optimize /usr/share/codegen
178 liquidx 1.1 python_mod_optimize() {
179 hawking 1.36 local mydirs myfiles myroot path
180 hawking 1.37
181     # Check if phase is pkg_postinst()
182     [[ ${EBUILD_PHASE} != postinst ]] &&\
183     die "${FUNCNAME} should only be run in pkg_postinst()"
184    
185 liquidx 1.13 # strip trailing slash
186 liquidx 1.16 myroot="${ROOT%/}"
187 liquidx 1.13
188 hawking 1.36 # respect ROOT
189     for path in $@; do
190     [ ! -e "${myroot}/${path}" ] && ewarn "${myroot}/${path} doesn't exist!"
191     [ -d "${myroot}/${path#/}" ] && mydirs="${mydirs} ${myroot}/${path#/}"
192     # Files are passed to python_mod_compile which is ROOT-aware
193     [ -f "${myroot}/${path}" ] && myfiles="${myfiles} ${path}"
194     done
195    
196 liquidx 1.5 # allow compiling for older python versions
197     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
198     PYVER=${PYTHON_OVERRIDE_PYVER}
199 pythonhead 1.7 else
200 liquidx 1.5 python_version
201     fi
202 pythonhead 1.7
203 liquidx 1.5 # set opts
204     if [ "${PYVER}" = "2.2" ]; then
205     compileopts=""
206     else
207     compileopts="-q"
208     fi
209 pythonhead 1.7
210 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
211 hawking 1.36 if [ -n "${mydirs}" ]; then
212     python${PYVER} \
213     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
214     ${compileopts} ${mydirs}
215     python${PYVER} -O \
216     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
217     ${compileopts} ${mydirs}
218     fi
219    
220     if [ -n "${myfiles}" ]; then
221     python_mod_compile ${myfiles}
222     fi
223    
224 liquidx 1.5 eend $?
225 liquidx 1.1 }
226    
227 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
228     # @USAGE: [ dir ]
229     # @DESCRIPTION:
230     # Run with optional arguments, where arguments are directories of
231     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
232     #
233     # It will recursively scan all compiled python modules in the directories
234     # and determine if they are orphaned (eg. their corresponding .py is missing.)
235     # if they are, then it will remove their corresponding .pyc and .pyo
236 hawking 1.37 #
237     # This function should only be run in pkg_postrm()
238 liquidx 1.1 python_mod_cleanup() {
239 liquidx 1.13 local SEARCH_PATH myroot
240 liquidx 1.16
241 hawking 1.38 # Check if phase is pkg_postrm()
242 hawking 1.37 [[ ${EBUILD_PHASE} != postrm ]] &&\
243     die "${FUNCNAME} should only be run in pkg_postrm()"
244    
245 liquidx 1.13 # strip trailing slash
246 liquidx 1.16 myroot="${ROOT%/}"
247 liquidx 1.1
248 liquidx 1.5 if [ $# -gt 0 ]; then
249     for path in $@; do
250 liquidx 1.13 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
251 pythonhead 1.7 done
252 liquidx 1.5 else
253 eradicator 1.15 for path in ${myroot}/usr/lib*/python*/site-packages; do
254 liquidx 1.5 SEARCH_PATH="${SEARCH_PATH} ${path}"
255     done
256     fi
257 pythonhead 1.7
258 liquidx 1.1 for path in ${SEARCH_PATH}; do
259 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
260 hawking 1.34 for obj in $(find ${path} -name '*.py[co]'); do
261 kloeri 1.31 src_py="${obj%[co]}"
262 liquidx 1.1 if [ ! -f "${src_py}" ]; then
263     einfo "Purging ${src_py}[co]"
264     rm -f ${src_py}[co]
265     fi
266 liquidx 1.12 done
267     # attempt to remove directories that maybe empty
268     for dir in $(find ${path} -type d | sort -r); do
269     rmdir ${dir} 2>/dev/null
270 liquidx 1.1 done
271 pythonhead 1.7 done
272 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20