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

Contents of /eclass/distutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.75 - (show annotations) (download)
Tue May 25 15:07:04 2010 UTC (4 years, 6 months ago) by arfrever
Branch: MAIN
Changes since 1.74: +15 -11 lines
Add sanity check in distutils_src_test().
Improve distutils_pkg_postinst() and distutils_pkg_postrm().

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.74 2010/03/04 17:49:03 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 if [[ "${EBUILD_PHASE}" != "test" ]]; then
224 die "${FUNCNAME}() can be used only in src_test() phase"
225 fi
226
227 _python_set_color_variables
228
229 if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
230 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
231 distutils_testing() {
232 _distutils_hook pre
233
234 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}
235 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 "$?"
236
237 _distutils_hook post
238 }
239 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
240 else
241 echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@"${_NORMAL}
242 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" || die "Testing failed"
243 fi
244 elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
245 _distutils_src_test_hook nosetests
246
247 python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
248 elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
249 _distutils_src_test_hook py.test
250
251 python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
252 # trial requires an argument, which is usually equal to "${PN}".
253 elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
254 local trial_arguments
255 if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
256 trial_arguments="${DISTUTILS_SRC_TEST#trial }"
257 else
258 trial_arguments="${PN}"
259 fi
260
261 _distutils_src_test_hook trial
262
263 python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
264 else
265 die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
266 fi
267 }
268
269 # @FUNCTION: distutils_src_install
270 # @DESCRIPTION:
271 # The distutils src_install function. This function is exported.
272 # In ebuilds of packages supporting installation for multiple versions of Python, this function
273 # calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
274 # It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
275 # KNOWN_BUGS, MAINTAINERS, MANIFEST*, NEWS, PKG-INFO, README*, TODO).
276 distutils_src_install() {
277 if [[ "${EBUILD_PHASE}" != "install" ]]; then
278 die "${FUNCNAME}() can be used only in src_install() phase"
279 fi
280
281 _python_initialize_prefix_variables
282 _python_set_color_variables
283
284 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
285 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
286 declare -A wrapper_scripts=()
287
288 rename_scripts_with_versioned_shebangs() {
289 if [[ -d "${ED}usr/bin" ]]; then
290 cd "${ED}usr/bin"
291
292 local nonversioned_file file
293 for file in *; do
294 if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]](-jython)?+$ && "$(head -n1 "${file}")" =~ ^'#!'.*(python|jython-)[[:digit:]]+\.[[:digit:]]+ ]]; then
295 for nonversioned_file in "${DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS[@]}"; do
296 [[ "${nonversioned_file}" == "/usr/bin/${file}" ]] && continue 2
297 done
298 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
299 wrapper_scripts+=(["${ED}usr/bin/${file}"]=)
300 fi
301 done
302 fi
303 }
304 fi
305
306 distutils_installation() {
307 _distutils_hook pre
308
309 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}
310 "$(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 "$?"
311
312 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
313 rename_scripts_with_versioned_shebangs
314 fi
315
316 _distutils_hook post
317 }
318 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"
319
320 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
321 python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
322 fi
323 unset wrapper_scripts
324 else
325 # Mark the package to be rebuilt after a Python upgrade.
326 python_need_rebuild
327
328 echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"${_NORMAL}
329 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
330 fi
331
332 if [[ -e "${ED}usr/local" ]]; then
333 die "Illegal installation into /usr/local"
334 fi
335
336 local default_docs
337 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
338
339 local doc
340 for doc in ${default_docs}; do
341 [[ -s "${doc}" ]] && dodoc "${doc}"
342 done
343
344 if [[ -n "${DOCS}" ]]; then
345 dodoc ${DOCS} || die "dodoc failed"
346 fi
347 }
348
349 # @FUNCTION: distutils_pkg_postinst
350 # @DESCRIPTION:
351 # The distutils pkg_postinst function. This function is exported.
352 # When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
353 # specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
354 # name is equal to name of current package, if this module exists.
355 distutils_pkg_postinst() {
356 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
357 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
358 fi
359
360 _python_initialize_prefix_variables
361
362 local pylibdir pymod
363 if [[ -z "$(declare -p PYTHON_MODNAME 2> /dev/null)" ]]; then
364 for pylibdir in "${EROOT}"usr/$(get_libdir)/python* "${EROOT}"/usr/share/jython-*/Lib; do
365 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
366 PYTHON_MODNAME="${PN}"
367 fi
368 done
369 fi
370
371 if [[ -n "${PYTHON_MODNAME}" ]]; then
372 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
373 python_mod_optimize ${PYTHON_MODNAME}
374 else
375 for pymod in ${PYTHON_MODNAME}; do
376 python_mod_optimize "$(python_get_sitedir)/${pymod}"
377 done
378 fi
379 fi
380 }
381
382 # @FUNCTION: distutils_pkg_postrm
383 # @DESCRIPTION:
384 # The distutils pkg_postrm function. This function is exported.
385 # When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
386 # specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
387 # name is equal to name of current package, if this module exists.
388 distutils_pkg_postrm() {
389 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
390 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
391 fi
392
393 _python_initialize_prefix_variables
394
395 local pylibdir pymod
396 if [[ -z "$(declare -p PYTHON_MODNAME 2> /dev/null)" ]]; then
397 for pylibdir in "${EROOT}"usr/$(get_libdir)/python* "${EROOT}"/usr/share/jython-*/Lib; do
398 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
399 PYTHON_MODNAME="${PN}"
400 fi
401 done
402 fi
403
404 if [[ -n "${PYTHON_MODNAME}" ]]; then
405 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
406 python_mod_cleanup ${PYTHON_MODNAME}
407 else
408 for pymod in ${PYTHON_MODNAME}; do
409 for pylibdir in "${EROOT}"usr/$(get_libdir)/python*; do
410 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
411 python_mod_cleanup "${pylibdir#${EROOT%/}}/site-packages/${pymod}"
412 fi
413 done
414 done
415 fi
416 fi
417 }
418
419 # @FUNCTION: distutils_python_version
420 # @DESCRIPTION:
421 # Deprecated wrapper function for deprecated python_version().
422 distutils_python_version() {
423 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
424 eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
425 die "${FUNCNAME}() cannot be used in this EAPI"
426 fi
427
428 _python_set_color_variables
429
430 eerror
431 eerror "${_RED}Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01.${_NORMAL}"
432 eerror "${_RED}Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables.${_NORMAL}"
433 eerror
434
435 python_version
436 }
437
438 # @FUNCTION: distutils_python_tkinter
439 # @DESCRIPTION:
440 # Deprecated wrapper function for deprecated python_tkinter_exists().
441 distutils_python_tkinter() {
442 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
443 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
444 die "${FUNCNAME}() cannot be used in this EAPI"
445 fi
446
447 _python_set_color_variables
448
449 eerror
450 eerror "${_RED}Deprecation Warning: ${FUNCNAME}() is deprecated and will be banned on 2010-07-01.${_NORMAL}"
451 eerror "${_RED}Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}().${_NORMAL}"
452 eerror
453
454 python_tkinter_exists
455 }

  ViewVC Help
Powered by ViewVC 1.1.20