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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.35 - (hide annotations) (download)
Thu May 29 14:10:48 2008 UTC (6 years, 4 months ago) by hawking
Branch: MAIN
Changes since 1.34: +17 -10 lines
python_mod_compile is now ROOT aware and can accept more than one files as argument.

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.35 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.34 2008/03/28 07:11:57 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 dev-zero 1.33 # 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 liquidx 1.5 # allow compiling for older python versions
138     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
139     PYVER=${PYTHON_OVERRIDE_PYVER}
140 pythonhead 1.7 else
141 liquidx 1.5 python_version
142     fi
143 pythonhead 1.7
144 hawking 1.35 # strip trailing slash
145     myroot="${ROOT%/}"
146    
147     # respect ROOT
148     for f in $@; do
149     [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
150     done
151    
152     if [ -n "${myfiles}" ]; then
153     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
154     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
155 liquidx 1.1 else
156 hawking 1.35 ewarn "No files to compile!"
157 pythonhead 1.7 fi
158 liquidx 1.1 }
159    
160 dev-zero 1.33 # @FUNCTION: python_mod_optimize
161     # @USAGE: [ path ]
162     # @DESCRIPTION:
163     # If no arguments supplied, it will recompile all modules under
164     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
165     # no recursively
166 liquidx 1.1 #
167 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
168     # in the supplied directory
169     #
170     # Example:
171 liquidx 1.1 # python_mod_optimize ${ROOT}usr/share/codegen
172     python_mod_optimize() {
173 liquidx 1.13 local myroot
174     # strip trailing slash
175 liquidx 1.16 myroot="${ROOT%/}"
176 liquidx 1.13
177 liquidx 1.5 # allow compiling for older python versions
178     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
179     PYVER=${PYTHON_OVERRIDE_PYVER}
180 pythonhead 1.7 else
181 liquidx 1.5 python_version
182     fi
183 pythonhead 1.7
184 liquidx 1.5 # set opts
185     if [ "${PYVER}" = "2.2" ]; then
186     compileopts=""
187     else
188     compileopts="-q"
189     fi
190 pythonhead 1.7
191 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
192 kloeri 1.32 python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
193     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py ${compileopts} $@
194 liquidx 1.5 eend $?
195 liquidx 1.1 }
196    
197 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
198     # @USAGE: [ dir ]
199     # @DESCRIPTION:
200     # Run with optional arguments, where arguments are directories of
201     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
202     #
203     # It will recursively scan all compiled python modules in the directories
204     # and determine if they are orphaned (eg. their corresponding .py is missing.)
205     # if they are, then it will remove their corresponding .pyc and .pyo
206 liquidx 1.1 python_mod_cleanup() {
207 liquidx 1.13 local SEARCH_PATH myroot
208 liquidx 1.16
209 liquidx 1.13 # strip trailing slash
210 liquidx 1.16 myroot="${ROOT%/}"
211 liquidx 1.1
212 liquidx 1.5 if [ $# -gt 0 ]; then
213     for path in $@; do
214 liquidx 1.13 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
215 pythonhead 1.7 done
216 liquidx 1.5 else
217 eradicator 1.15 for path in ${myroot}/usr/lib*/python*/site-packages; do
218 liquidx 1.5 SEARCH_PATH="${SEARCH_PATH} ${path}"
219     done
220     fi
221 pythonhead 1.7
222 liquidx 1.1 for path in ${SEARCH_PATH}; do
223 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
224 hawking 1.34 for obj in $(find ${path} -name '*.py[co]'); do
225 kloeri 1.31 src_py="${obj%[co]}"
226 liquidx 1.1 if [ ! -f "${src_py}" ]; then
227     einfo "Purging ${src_py}[co]"
228     rm -f ${src_py}[co]
229     fi
230 liquidx 1.12 done
231     # attempt to remove directories that maybe empty
232     for dir in $(find ${path} -type d | sort -r); do
233     rmdir ${dir} 2>/dev/null
234 liquidx 1.1 done
235 pythonhead 1.7 done
236 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20