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

Diff of /eclass/distutils.eclass

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

Revision 1.5 Revision 1.76
1# Copyright 1999-2003 Gentoo Technologies, Inc. 1# Copyright 1999-2010 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/distutils.eclass,v 1.5 2003/02/16 04:26:21 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.76 2010/07/17 23:03:29 arfrever Exp $
4
5# @ECLASS: distutils.eclass
6# @MAINTAINER:
7# Gentoo Python Project <python@gentoo.org>
4# 8#
5# Author: Jon Nelson <jnelson@gentoo.org> 9# Original author: Jon Nelson <jnelson@gentoo.org>
6# 10# @BLURB: Eclass for packages with build systems using Distutils
7# The distutils eclass is designed to allow easier installation of 11# @DESCRIPTION:
8# distutils-based python modules, and their incorporation into 12# The distutils eclass defines phase functions for packages with build systems using Distutils.
9# the Gentoo Linux system.
10 13
11ECLASS=distutils 14inherit multilib python
12INHERITED="$INHERITED $ECLASS"
13 15
14EXPORT_FUNCTIONS src_compile src_install 16case "${EAPI:-0}" in
17 0|1)
18 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
19 ;;
20 *)
21 EXPORT_FUNCTIONS src_prepare src_compile src_install pkg_postinst pkg_postrm
22 ;;
23esac
15 24
16newdepend "virtual/python" 25if [[ -z "$(declare -p PYTHON_DEPEND 2> /dev/null)" ]]; then
26 DEPEND="dev-lang/python"
27 RDEPEND="${DEPEND}"
28fi
17 29
30# 'python' variable is deprecated. Use PYTHON() instead.
31if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
32 python="python"
33else
34 python="die"
35fi
36
37# @ECLASS-VARIABLE: DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
38# @DESCRIPTION:
39# Set this to use separate source directories for each enabled version of Python.
40
41# @ECLASS-VARIABLE: DISTUTILS_SETUP_FILES
42# @DESCRIPTION:
43# Paths to setup files.
44
45# @ECLASS-VARIABLE: DISTUTILS_GLOBAL_OPTIONS
46# @DESCRIPTION:
47# Global options passed to setup files.
48
49# @ECLASS-VARIABLE: DISTUTILS_SRC_TEST
50# @DESCRIPTION:
51# Type of test command used by distutils_src_test().
52# IUSE and DEPEND are automatically adjusted, unless DISTUTILS_DISABLE_TEST_DEPENDENCY is set.
53# Valid values:
54# setup.py
55# nosetests
56# py.test
57# trial [arguments]
58
59# @ECLASS-VARIABLE: DISTUTILS_DISABLE_TEST_DEPENDENCY
60# @DESCRIPTION:
61# Disable modification of IUSE and DEPEND caused by setting of DISTUTILS_SRC_TEST.
62
63if [[ -n "${DISTUTILS_SRC_TEST}" && ! "${DISTUTILS_SRC_TEST}" =~ ^(setup\.py|nosetests|py\.test|trial(\ .*)?)$ ]]; then
64 die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
65fi
66
67if [[ -z "${DISTUTILS_DISABLE_TEST_DEPENDENCY}" ]]; then
68 if [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
69 IUSE="test"
70 DEPEND+="${DEPEND:+ }test? ( dev-python/nose )"
71 elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
72 IUSE="test"
73 DEPEND+="${DEPEND:+ }test? ( dev-python/py )"
74 # trial requires an argument, which is usually equal to "${PN}".
75 elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
76 IUSE="test"
77 DEPEND+="${DEPEND:+ }test? ( dev-python/twisted )"
78 fi
79fi
80
81if [[ -n "${DISTUTILS_SRC_TEST}" ]]; then
82 EXPORT_FUNCTIONS src_test
83fi
84
85# @ECLASS-VARIABLE: DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS
86# @DESCRIPTION:
87# Set this to disable renaming of Python scripts containing versioned shebangs
88# and generation of wrapper scripts.
89
90# @ECLASS-VARIABLE: DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS
91# @DESCRIPTION:
92# List of paths to Python scripts, relative to ${ED}, which are excluded from
93# renaming and generation of wrapper scripts.
94
95# @ECLASS-VARIABLE: DOCS
96# @DESCRIPTION:
97# Additional documentation files installed by distutils_src_install().
98
99_distutils_get_build_dir() {
100 if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
101 echo "build-${PYTHON_ABI}"
102 else
103 echo "build"
104 fi
105}
106
107_distutils_get_PYTHONPATH() {
108 if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
109 ls -d build-${PYTHON_ABI}/lib* 2> /dev/null
110 else
111 ls -d build/lib* 2> /dev/null
112 fi
113}
114
115_distutils_hook() {
116 if [[ "$#" -ne 1 ]]; then
117 die "${FUNCNAME}() requires 1 argument"
118 fi
119 if [[ "$(type -t "distutils_src_${EBUILD_PHASE}_$1_hook")" == "function" ]]; then
120 "distutils_src_${EBUILD_PHASE}_$1_hook"
121 fi
122}
123
124# @FUNCTION: distutils_src_unpack
125# @DESCRIPTION:
126# The distutils src_unpack function. This function is exported.
127distutils_src_unpack() {
128 if ! has "${EAPI:-0}" 0 1; then
129 die "${FUNCNAME}() cannot be used in this EAPI"
130 fi
131
132 if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
133 die "${FUNCNAME}() can be used only in src_unpack() phase"
134 fi
135
136 unpack ${A}
137 cd "${S}"
138
139 distutils_src_prepare
140}
141
142# @FUNCTION: distutils_src_prepare
143# @DESCRIPTION:
144# The distutils src_prepare function. This function is exported.
145distutils_src_prepare() {
146 if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
147 die "${FUNCNAME}() can be used only in src_prepare() phase"
148 fi
149
150 # Delete ez_setup files to prevent packages from installing Setuptools on their own.
151 local ez_setup_existence="0"
152 [[ -d ez_setup || -f ez_setup.py ]] && ez_setup_existence="1"
153 rm -fr ez_setup*
154 if [[ "${ez_setup_existence}" == "1" ]]; then
155 echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py
156 fi
157
158 # Delete distribute_setup files to prevent packages from installing Distribute on their own.
159 local distribute_setup_existence="0"
160 [[ -d distribute_setup || -f distribute_setup.py ]] && distribute_setup_existence="1"
161 rm -fr distribute_setup*
162 if [[ "${distribute_setup_existence}" == "1" ]]; then
163 echo "def use_setuptools(*args, **kwargs): pass" > distribute_setup.py
164 fi
165
166 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
167 python_copy_sources
168 fi
169}
170
171# @FUNCTION: distutils_src_compile
172# @DESCRIPTION:
173# The distutils src_compile function. This function is exported.
174# In ebuilds of packages supporting installation for multiple versions of Python, this function
175# calls distutils_src_compile_pre_hook() and distutils_src_compile_post_hook(), if they are defined.
18distutils_src_compile() { 176distutils_src_compile() {
19 python setup.py build || die "compilation failed" 177 if [[ "${EBUILD_PHASE}" != "compile" ]]; then
20} 178 die "${FUNCNAME}() can be used only in src_compile() phase"
179 fi
21 180
181 _python_set_color_variables
182
183 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
184 distutils_building() {
185 _distutils_hook pre
186
187 local setup_file
188 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
189 echo ${_BOLD}"$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@"${_NORMAL}
190 "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@" || return "$?"
191 done
192
193 _distutils_hook post
194 }
195 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_building "$@"
196 else
197 local setup_file
198 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
199 echo ${_BOLD}"$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"${_NORMAL}
200 "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
201 done
202 fi
203}
204
205_distutils_src_test_hook() {
206 if [[ "$#" -ne 1 ]]; then
207 die "${FUNCNAME}() requires 1 arguments"
208 fi
209
210 if [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
211 return
212 fi
213
214 if [[ "$(type -t "distutils_src_test_pre_hook")" == "function" ]]; then
215 eval "python_execute_$1_pre_hook() {
216 distutils_src_test_pre_hook
217 }"
218 fi
219
220 if [[ "$(type -t "distutils_src_test_post_hook")" == "function" ]]; then
221 eval "python_execute_$1_post_hook() {
222 distutils_src_test_post_hook
223 }"
224 fi
225}
226
227# @FUNCTION: distutils_src_test
228# @DESCRIPTION:
229# The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set.
230# In ebuilds of packages supporting installation for multiple versions of Python, this function
231# calls distutils_src_test_pre_hook() and distutils_src_test_post_hook(), if they are defined.
232distutils_src_test() {
233 if [[ "${EBUILD_PHASE}" != "test" ]]; then
234 die "${FUNCNAME}() can be used only in src_test() phase"
235 fi
236
237 _python_set_color_variables
238
239 if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
240 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
241 distutils_testing() {
242 _distutils_hook pre
243
244 local setup_file
245 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
246 echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"${_NORMAL}
247 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@" || return "$?"
248 done
249
250 _distutils_hook post
251 }
252 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
253 else
254 local setup_file
255 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
256 echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@"${_NORMAL}
257 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" || die "Testing failed"
258 done
259 fi
260 elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
261 _distutils_src_test_hook nosetests
262
263 python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
264 elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
265 _distutils_src_test_hook py.test
266
267 python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
268 # trial requires an argument, which is usually equal to "${PN}".
269 elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
270 local trial_arguments
271 if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
272 trial_arguments="${DISTUTILS_SRC_TEST#trial }"
273 else
274 trial_arguments="${PN}"
275 fi
276
277 _distutils_src_test_hook trial
278
279 python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
280 else
281 die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
282 fi
283}
284
285# @FUNCTION: distutils_src_install
286# @DESCRIPTION:
287# The distutils src_install function. This function is exported.
288# In ebuilds of packages supporting installation for multiple versions of Python, this function
289# calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
290# It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
291# KNOWN_BUGS, MAINTAINERS, MANIFEST*, NEWS, PKG-INFO, README*, TODO).
22distutils_src_install() { 292distutils_src_install() {
23 python setup.py install --root=${D} || die 293 if [[ "${EBUILD_PHASE}" != "install" ]]; then
24 dodoc CHANGELOG COPYRIGHT KNOWN_BUGS MAINTAINERS 294 die "${FUNCNAME}() can be used only in src_install() phase"
25 dodoc CONTRIBUTORS LICENSE COPYING* 295 fi
26 dodoc Change* MANIFEST* README* ${mydoc} 296
297 _python_initialize_prefix_variables
298 _python_set_color_variables
299
300 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
301 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
302 declare -A wrapper_scripts=()
303
304 rename_scripts_with_versioned_shebangs() {
305 if [[ -d "${ED}usr/bin" ]]; then
306 cd "${ED}usr/bin"
307
308 local nonversioned_file file
309 for file in *; do
310 if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]](-jython)?+$ && "$(head -n1 "${file}")" =~ ^'#!'.*(python|jython-)[[:digit:]]+\.[[:digit:]]+ ]]; then
311 for nonversioned_file in "${DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS[@]}"; do
312 [[ "${nonversioned_file}" == "/usr/bin/${file}" ]] && continue 2
313 done
314 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
315 wrapper_scripts+=(["${ED}usr/bin/${file}"]=)
316 fi
317 done
318 fi
319 }
320 fi
321
322 distutils_installation() {
323 _distutils_hook pre
324
325 local setup_file
326 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
327 echo ${_BOLD}"$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@"${_NORMAL}
328 "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@" || return "$?"
329 done
330
331 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
332 rename_scripts_with_versioned_shebangs
333 fi
334
335 _distutils_hook post
336 }
337 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"
338
339 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
340 python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
341 fi
342 unset wrapper_scripts
343 else
344 # Mark the package to be rebuilt after a Python upgrade.
345 python_need_rebuild
346
347 local setup_file
348 for setup_file in "${DISTUTILS_SETUP_FILES[@]-setup.py}"; do
349 echo ${_BOLD}"$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"${_NORMAL}
350 "$(PYTHON)" "${setup_file}" "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
351 done
352 fi
353
354 if [[ -e "${ED}usr/local" ]]; then
355 die "Illegal installation into /usr/local"
356 fi
357
358 local default_docs
359 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
360
361 local doc
362 for doc in ${default_docs}; do
363 [[ -s "${doc}" ]] && dodoc "${doc}"
364 done
365
366 if [[ -n "${DOCS}" ]]; then
367 dodoc ${DOCS} || die "dodoc failed"
368 fi
27} 369}
370
371# @FUNCTION: distutils_pkg_postinst
372# @DESCRIPTION:
373# The distutils pkg_postinst function. This function is exported.
374# When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
375# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
376# name is equal to name of current package, if this module exists.
377distutils_pkg_postinst() {
378 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
379 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
380 fi
381
382 _python_initialize_prefix_variables
383
384 local pylibdir pymod
385 if [[ -z "$(declare -p PYTHON_MODNAME 2> /dev/null)" ]]; then
386 for pylibdir in "${EROOT}"usr/$(get_libdir)/python* "${EROOT}"/usr/share/jython-*/Lib; do
387 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
388 PYTHON_MODNAME="${PN}"
389 fi
390 done
391 fi
392
393 if [[ -n "${PYTHON_MODNAME}" ]]; then
394 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
395 python_mod_optimize ${PYTHON_MODNAME}
396 else
397 for pymod in ${PYTHON_MODNAME}; do
398 python_mod_optimize "$(python_get_sitedir)/${pymod}"
399 done
400 fi
401 fi
402}
403
404# @FUNCTION: distutils_pkg_postrm
405# @DESCRIPTION:
406# The distutils pkg_postrm function. This function is exported.
407# When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
408# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
409# name is equal to name of current package, if this module exists.
410distutils_pkg_postrm() {
411 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
412 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
413 fi
414
415 _python_initialize_prefix_variables
416
417 local pylibdir pymod
418 if [[ -z "$(declare -p PYTHON_MODNAME 2> /dev/null)" ]]; then
419 for pylibdir in "${EROOT}"usr/$(get_libdir)/python* "${EROOT}"/usr/share/jython-*/Lib; do
420 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
421 PYTHON_MODNAME="${PN}"
422 fi
423 done
424 fi
425
426 if [[ -n "${PYTHON_MODNAME}" ]]; then
427 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
428 python_mod_cleanup ${PYTHON_MODNAME}
429 else
430 for pymod in ${PYTHON_MODNAME}; do
431 for pylibdir in "${EROOT}"usr/$(get_libdir)/python*; do
432 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
433 python_mod_cleanup "${pylibdir#${EROOT%/}}/site-packages/${pymod}"
434 fi
435 done
436 done
437 fi
438 fi
439}
440
441# Scheduled for deletion on 2011-01-01.
442distutils_python_version() {
443 eerror "Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables."
444 die "${FUNCNAME}() is banned"
445}
446
447# Scheduled for deletion on 2011-01-01.
448distutils_python_tkinter() {
449 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
450 die "${FUNCNAME}() is banned"
451}

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.76

  ViewVC Help
Powered by ViewVC 1.1.20