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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.52 - (hide annotations) (download)
Mon Oct 27 00:17:28 2008 UTC (6 years ago) by hawking
Branch: MAIN
Changes since 1.51: +9 -1 lines
Add python_need_rebuild marker function. The first step for a faster python-updater :)

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.52 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.51 2008/10/26 21:54:32 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_version
40     # @DESCRIPTION:
41     # Run without arguments and it will export the version of python
42     # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
43 liquidx 1.18 __python_version_extract() {
44 hawking 1.45 local verstr=$1
45 liquidx 1.18 export PYVER_MAJOR=${verstr:0:1}
46     export PYVER_MINOR=${verstr:2:1}
47 hawking 1.47 if [[ ${verstr:3:1} == . ]]; then
48 swegener 1.29 export PYVER_MICRO=${verstr:4}
49 liquidx 1.28 fi
50 swegener 1.21 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
51 liquidx 1.18 }
52    
53 liquidx 1.1 python_version() {
54 hawking 1.44 [[ -n "${PYVER}" ]] && return 0
55 liquidx 1.1 local tmpstr
56     python=${python:-/usr/bin/python}
57     tmpstr="$(${python} -V 2>&1 )"
58     export PYVER_ALL="${tmpstr#Python }"
59 liquidx 1.18 __python_version_extract $PYVER_ALL
60 liquidx 1.1 }
61    
62 hawking 1.46 # @FUNCTION: python_disable_pyc
63     # @DESCRIPTION:
64     # Tells python not to automatically recompile modules to .pyc/.pyo
65     # even if the timestamps/version stamps don't match. This is done
66     # to protect sandbox.
67     #
68     # note: supported by >=dev-lang/python-2.2.3-r3 only.
69     #
70     python_disable_pyc() {
71     python_version
72     if [[ ${PYVER/./,} -ge 2,6 ]]; then
73     export PYTHONDONTWRITEBYTECODE=1
74     else
75     export PYTHON_DONTCOMPILE=1
76     fi
77     }
78    
79     # @FUNCTION: python_enable_pyc
80     # @DESCRIPTION:
81     # Tells python to automatically recompile modules to .pyc/.pyo if the
82     # timestamps/version stamps change
83     python_enable_pyc() {
84     python_version
85     if [[ ${PYVER/./,} -ge 2,6 ]]; then
86     unset PYTHONDONTWRITEBYTECODE
87     else
88     unset PYTHON_DONTCOMPILE
89     fi
90     }
91    
92     python_disable_pyc
93    
94 hawking 1.52 # @FUNCTION: python_need_rebuild
95     # @DESCRIPTION: Run without arguments, specifies that the package should be
96     # rebuilt after a python upgrade.
97     python_need_rebuild() {
98     python_version
99     export PYTHON_NEED_REBUILD=${PYVER}
100     }
101    
102 pythonhead 1.43 # @FUNCTION: python_get_libdir
103     # @DESCRIPTION:
104 pythonhead 1.42 # Run without arguments, returns the python library dir
105 pythonhead 1.43 python_get_libdir() {
106 pythonhead 1.42 python_version
107     echo "/usr/$(get_libdir)/python${PYVER}"
108     }
109    
110 pythonhead 1.43 # @FUNCTION: python_get_sitedir
111     # @DESCRIPTION:
112 pythonhead 1.42 # Run without arguments, returns the python site-packages dir
113 pythonhead 1.43 python_get_sitedir() {
114     echo "$(python_get_libdir)/site-packages"
115 pythonhead 1.42 }
116    
117 dev-zero 1.33 # @FUNCTION: python_makesym
118     # @DESCRIPTION:
119     # Run without arguments, it will create the /usr/bin/python symlinks
120     # to the latest installed version
121 liquidx 1.1 python_makesym() {
122 liquidx 1.10 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
123     alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
124 liquidx 1.1 }
125    
126 dev-zero 1.33 # @FUNCTION: python_tkinter_exists
127     # @DESCRIPTION:
128     # Run without arguments, checks if python was compiled with Tkinter
129     # support. If not, prints an error message and dies.
130 liquidx 1.1 python_tkinter_exists() {
131     if ! python -c "import Tkinter" >/dev/null 2>&1; then
132     eerror "You need to recompile python with Tkinter support."
133 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
134 liquidx 1.27 eerror "in to /etc/portage/package.use"
135 liquidx 1.1 echo
136     die "missing tkinter support with installed python"
137     fi
138     }
139    
140 dev-zero 1.33 # @FUNCTION: python_mod_exists
141     # @USAGE: < module >
142     # @DESCRIPTION:
143     # Run with the module name as an argument. it will check if a
144     # python module is installed and loadable. it will return
145     # TRUE(0) if the module exists, and FALSE(1) if the module does
146     # not exist.
147 liquidx 1.1 #
148 dev-zero 1.33 # Example:
149 liquidx 1.1 # if python_mod_exists gtk; then
150 liquidx 1.28 # echo "gtk support enabled"
151 liquidx 1.1 # fi
152     python_mod_exists() {
153 hawking 1.47 [[ "$1" ]] && die "${FUNCNAME} requires an argument!"
154     python -c "import $1" >/dev/null 2>&1
155 liquidx 1.1 }
156    
157 dev-zero 1.33 # @FUNCTION: python_mod_compile
158 hawking 1.35 # @USAGE: < file > [more files ...]
159 dev-zero 1.33 # @DESCRIPTION:
160 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
161 hawking 1.37 # This function should only be run in pkg_postinst()
162 liquidx 1.1 #
163 dev-zero 1.33 # Example:
164 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
165 liquidx 1.1 #
166     python_mod_compile() {
167 hawking 1.48 local f myroot myfiles=()
168 hawking 1.37
169     # Check if phase is pkg_postinst()
170     [[ ${EBUILD_PHASE} != postinst ]] &&\
171 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
172 hawking 1.37
173 liquidx 1.5 # allow compiling for older python versions
174 hawking 1.48 if [[ "${PYTHON_OVERRIDE_PYVER}" ]]; then
175 liquidx 1.5 PYVER=${PYTHON_OVERRIDE_PYVER}
176 pythonhead 1.7 else
177 liquidx 1.5 python_version
178     fi
179 pythonhead 1.7
180 hawking 1.35 # strip trailing slash
181     myroot="${ROOT%/}"
182    
183     # respect ROOT
184 hawking 1.51 for f in "$@"; do
185 hawking 1.48 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
186 hawking 1.35 done
187    
188 hawking 1.48 if ((${#myfiles[@]})); then
189     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
190     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py "${myfiles[@]}"
191 liquidx 1.1 else
192 hawking 1.35 ewarn "No files to compile!"
193 pythonhead 1.7 fi
194 liquidx 1.1 }
195    
196 dev-zero 1.33 # @FUNCTION: python_mod_optimize
197     # @USAGE: [ path ]
198     # @DESCRIPTION:
199     # If no arguments supplied, it will recompile all modules under
200     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
201     # no recursively
202 liquidx 1.1 #
203 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
204     # in the supplied directory
205 hawking 1.37 # This function should only be run in pkg_postinst()
206 dev-zero 1.33 #
207 hawking 1.39 # Options passed to this function are passed to compileall.py
208     #
209 dev-zero 1.33 # Example:
210 hawking 1.36 # python_mod_optimize /usr/share/codegen
211 liquidx 1.1 python_mod_optimize() {
212 hawking 1.49 local myroot mydirs=() myfiles=() myopts=()
213 hawking 1.37
214     # Check if phase is pkg_postinst()
215     [[ ${EBUILD_PHASE} != postinst ]] &&\
216 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
217 hawking 1.37
218 liquidx 1.13 # strip trailing slash
219 liquidx 1.16 myroot="${ROOT%/}"
220 liquidx 1.13
221 hawking 1.39 # respect ROOT and options passed to compileall.py
222 hawking 1.49 while (($#)); do
223 hawking 1.39 case $1 in
224     -l|-f|-q)
225 hawking 1.49 myopts+=("$1")
226 hawking 1.39 ;;
227     -d|-x)
228 hawking 1.49 myopts+=("$1" "$2")
229 hawking 1.39 shift
230     ;;
231     -*)
232     ewarn "${FUNCNAME}: Ignoring compile option $1"
233     ;;
234     *)
235 hawking 1.49 if [[ -d "${myroot}"/$1 ]]; then
236     mydirs+=("${myroot}/$1")
237     elif [[ -f "${myroot}"/$1 ]]; then
238     # Files are passed to python_mod_compile which is ROOT-aware
239     myfiles+=("$1")
240     elif [[ -e "${myroot}/$1" ]]; then
241     ewarn "${myroot}/$1 is not a file or directory!"
242     else
243     ewarn "${myroot}/$1 doesn't exist!"
244     fi
245 hawking 1.39 ;;
246     esac
247     shift
248 hawking 1.36 done
249    
250 liquidx 1.5 # allow compiling for older python versions
251     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
252     PYVER=${PYTHON_OVERRIDE_PYVER}
253 pythonhead 1.7 else
254 liquidx 1.5 python_version
255     fi
256 pythonhead 1.7
257 hawking 1.41 # set additional opts
258 hawking 1.49 myopts+=(-q)
259 pythonhead 1.7
260 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
261 hawking 1.49 if ((${#mydirs[@]})); then
262 hawking 1.36 python${PYVER} \
263 hawking 1.49 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
264     "${myopts[@]}" "${mydirs[@]}"
265 hawking 1.36 python${PYVER} -O \
266 hawking 1.49 "${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
267     "${myopts[@]}" "${mydirs[@]}"
268 hawking 1.36 fi
269    
270 hawking 1.49 if ((${#myfiles[@]})); then
271     python_mod_compile "${myfiles[@]}"
272 hawking 1.36 fi
273    
274 liquidx 1.5 eend $?
275 liquidx 1.1 }
276    
277 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
278     # @USAGE: [ dir ]
279     # @DESCRIPTION:
280     # Run with optional arguments, where arguments are directories of
281     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
282     #
283     # It will recursively scan all compiled python modules in the directories
284     # and determine if they are orphaned (eg. their corresponding .py is missing.)
285     # if they are, then it will remove their corresponding .pyc and .pyo
286 hawking 1.37 #
287     # This function should only be run in pkg_postrm()
288 liquidx 1.1 python_mod_cleanup() {
289 hawking 1.50 local SEARCH_PATH=() myroot src_py
290 liquidx 1.16
291 hawking 1.38 # Check if phase is pkg_postrm()
292 hawking 1.37 [[ ${EBUILD_PHASE} != postrm ]] &&\
293 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postrm()"
294 hawking 1.37
295 liquidx 1.13 # strip trailing slash
296 liquidx 1.16 myroot="${ROOT%/}"
297 liquidx 1.1
298 hawking 1.50 if (($#)); then
299     SEARCH_PATH=("${@#/}")
300     SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
301 liquidx 1.5 else
302 hawking 1.50 SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
303 liquidx 1.5 fi
304 pythonhead 1.7
305 hawking 1.50 for path in "${SEARCH_PATH[@]}"; do
306 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
307 hawking 1.50 while read -rd ''; do
308     src_py="${REPLY%[co]}"
309     [[ -f "${src_py}" ]] && continue
310     einfo "Purging ${src_py}[co]"
311     rm -f "${src_py}"[co]
312     done < <(find "${path}" -name '*.py[co]' -print0)
313    
314 liquidx 1.12 # attempt to remove directories that maybe empty
315 hawking 1.50 while read -r dir; do
316     rmdir "${dir}" 2>/dev/null
317     done < <(find "${path}" -type d | sort -r)
318 pythonhead 1.7 done
319 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20