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

Diff of /eclass/distutils.eclass

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

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