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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.44 - (hide annotations) (download)
Fri Aug 29 19:28:08 2008 UTC (5 years, 10 months ago) by hawking
Branch: MAIN
Changes since 1.43: +2 -1 lines
Make python_version return if PYVER is already set.

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.44 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.43 2008/08/01 22:22:21 pythonhead 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 hawking 1.44 [[ -n "${PYVER}" ]] && return 0
77 liquidx 1.1 local tmpstr
78     python=${python:-/usr/bin/python}
79     tmpstr="$(${python} -V 2>&1 )"
80     export PYVER_ALL="${tmpstr#Python }"
81 liquidx 1.18 __python_version_extract $PYVER_ALL
82 liquidx 1.1 }
83    
84 pythonhead 1.43 # @FUNCTION: python_get_libdir
85     # @DESCRIPTION:
86 pythonhead 1.42 # Run without arguments, returns the python library dir
87 pythonhead 1.43 python_get_libdir() {
88 pythonhead 1.42 python_version
89     echo "/usr/$(get_libdir)/python${PYVER}"
90     }
91    
92 pythonhead 1.43 # @FUNCTION: python_get_sitedir
93     # @DESCRIPTION:
94 pythonhead 1.42 # Run without arguments, returns the python site-packages dir
95 pythonhead 1.43 python_get_sitedir() {
96     echo "$(python_get_libdir)/site-packages"
97 pythonhead 1.42 }
98    
99 dev-zero 1.33 # @FUNCTION: python_makesym
100     # @DESCRIPTION:
101     # Run without arguments, it will create the /usr/bin/python symlinks
102     # to the latest installed version
103 liquidx 1.1 python_makesym() {
104 liquidx 1.10 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
105     alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
106 liquidx 1.1 }
107    
108 dev-zero 1.33 # @FUNCTION: python_tkinter_exists
109     # @DESCRIPTION:
110     # Run without arguments, checks if python was compiled with Tkinter
111     # support. If not, prints an error message and dies.
112 liquidx 1.1 python_tkinter_exists() {
113     if ! python -c "import Tkinter" >/dev/null 2>&1; then
114     eerror "You need to recompile python with Tkinter support."
115 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
116 liquidx 1.27 eerror "in to /etc/portage/package.use"
117 liquidx 1.1 echo
118     die "missing tkinter support with installed python"
119     fi
120     }
121    
122 dev-zero 1.33 # @FUNCTION: python_mod_exists
123     # @USAGE: < module >
124     # @DESCRIPTION:
125     # Run with the module name as an argument. it will check if a
126     # python module is installed and loadable. it will return
127     # TRUE(0) if the module exists, and FALSE(1) if the module does
128     # not exist.
129 liquidx 1.1 #
130 dev-zero 1.33 # Example:
131 liquidx 1.1 # if python_mod_exists gtk; then
132 liquidx 1.28 # echo "gtk support enabled"
133 liquidx 1.1 # fi
134     python_mod_exists() {
135 liquidx 1.16 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
136 pythonhead 1.7 if ! python -c "import $1" >/dev/null 2>&1; then
137 liquidx 1.1 return 1
138     fi
139     return 0
140     }
141    
142 dev-zero 1.33 # @FUNCTION: python_mod_compile
143 hawking 1.35 # @USAGE: < file > [more files ...]
144 dev-zero 1.33 # @DESCRIPTION:
145 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
146 hawking 1.37 # This function should only be run in pkg_postinst()
147 liquidx 1.1 #
148 dev-zero 1.33 # Example:
149 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
150 liquidx 1.1 #
151     python_mod_compile() {
152 hawking 1.35 local f myroot
153 hawking 1.37
154     # Check if phase is pkg_postinst()
155     [[ ${EBUILD_PHASE} != postinst ]] &&\
156 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
157 hawking 1.37
158 liquidx 1.5 # allow compiling for older python versions
159     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
160     PYVER=${PYTHON_OVERRIDE_PYVER}
161 pythonhead 1.7 else
162 liquidx 1.5 python_version
163     fi
164 pythonhead 1.7
165 hawking 1.35 # 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    
173     if [ -n "${myfiles}" ]; then
174     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
175     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
176 liquidx 1.1 else
177 hawking 1.35 ewarn "No files to compile!"
178 pythonhead 1.7 fi
179 liquidx 1.1 }
180    
181 dev-zero 1.33 # @FUNCTION: python_mod_optimize
182     # @USAGE: [ path ]
183     # @DESCRIPTION:
184     # If no arguments supplied, it will recompile all modules under
185     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
186     # no recursively
187 liquidx 1.1 #
188 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
189     # in the supplied directory
190 hawking 1.37 # This function should only be run in pkg_postinst()
191 dev-zero 1.33 #
192 hawking 1.39 # Options passed to this function are passed to compileall.py
193     #
194 dev-zero 1.33 # Example:
195 hawking 1.36 # python_mod_optimize /usr/share/codegen
196 liquidx 1.1 python_mod_optimize() {
197 hawking 1.40 local mydirs myfiles myroot myopts
198 hawking 1.37
199     # Check if phase is pkg_postinst()
200     [[ ${EBUILD_PHASE} != postinst ]] &&\
201 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
202 hawking 1.37
203 liquidx 1.13 # strip trailing slash
204 liquidx 1.16 myroot="${ROOT%/}"
205 liquidx 1.13
206 hawking 1.39 # 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 hawking 1.41 myopts="${myopts} $1 $2"
214 hawking 1.39 shift
215     ;;
216     -*)
217     ewarn "${FUNCNAME}: Ignoring compile option $1"
218     ;;
219     *)
220 hawking 1.40 [ ! -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 hawking 1.39 ;;
225     esac
226     shift
227 hawking 1.36 done
228    
229 liquidx 1.5 # allow compiling for older python versions
230     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
231     PYVER=${PYTHON_OVERRIDE_PYVER}
232 pythonhead 1.7 else
233 liquidx 1.5 python_version
234     fi
235 pythonhead 1.7
236 hawking 1.41 # set additional opts
237     myopts="${myopts} -q"
238 pythonhead 1.7
239 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
240 hawking 1.36 if [ -n "${mydirs}" ]; then
241     python${PYVER} \
242     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
243 hawking 1.41 ${myopts} ${mydirs}
244 hawking 1.36 python${PYVER} -O \
245     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
246 hawking 1.41 ${myopts} ${mydirs}
247 hawking 1.36 fi
248    
249     if [ -n "${myfiles}" ]; then
250     python_mod_compile ${myfiles}
251     fi
252    
253 liquidx 1.5 eend $?
254 liquidx 1.1 }
255    
256 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
257     # @USAGE: [ dir ]
258     # @DESCRIPTION:
259     # Run with optional arguments, where arguments are directories of
260     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
261     #
262     # It will recursively scan all compiled python modules in the directories
263     # and determine if they are orphaned (eg. their corresponding .py is missing.)
264     # if they are, then it will remove their corresponding .pyc and .pyo
265 hawking 1.37 #
266     # This function should only be run in pkg_postrm()
267 liquidx 1.1 python_mod_cleanup() {
268 liquidx 1.13 local SEARCH_PATH myroot
269 liquidx 1.16
270 hawking 1.38 # Check if phase is pkg_postrm()
271 hawking 1.37 [[ ${EBUILD_PHASE} != postrm ]] &&\
272 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postrm()"
273 hawking 1.37
274 liquidx 1.13 # strip trailing slash
275 liquidx 1.16 myroot="${ROOT%/}"
276 liquidx 1.1
277 liquidx 1.5 if [ $# -gt 0 ]; then
278     for path in $@; do
279 liquidx 1.13 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
280 pythonhead 1.7 done
281 liquidx 1.5 else
282 eradicator 1.15 for path in ${myroot}/usr/lib*/python*/site-packages; do
283 liquidx 1.5 SEARCH_PATH="${SEARCH_PATH} ${path}"
284     done
285     fi
286 pythonhead 1.7
287 liquidx 1.1 for path in ${SEARCH_PATH}; do
288 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
289 hawking 1.34 for obj in $(find ${path} -name '*.py[co]'); do
290 kloeri 1.31 src_py="${obj%[co]}"
291 liquidx 1.1 if [ ! -f "${src_py}" ]; then
292     einfo "Purging ${src_py}[co]"
293     rm -f ${src_py}[co]
294     fi
295 liquidx 1.12 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 liquidx 1.1 done
300 pythonhead 1.7 done
301 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20