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

Contents of /eclass/distutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.74 - (show annotations) (download)
Thu Mar 4 17:49:03 2010 UTC (4 years, 7 months ago) by arfrever
Branch: MAIN
Changes since 1.73: +66 -13 lines
Use prefix variables (bug #307669).
Support hooks in distutils_src_test().
Print deprecation warnings in distutils_python_version() and distutils_python_tkinter().

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

  ViewVC Help
Powered by ViewVC 1.1.20