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

Contents of /eclass/distutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.73 - (show annotations) (download)
Sun Feb 28 11:52:22 2010 UTC (4 years, 6 months ago) by arfrever
Branch: MAIN
Changes since 1.72: +44 -26 lines
Do not export distutils_src_unpack() in EAPI >=2 and disallow using of distutils_src_unpack() in EAPI >=2.
Improve output of distutils_src_compile(), distutils_src_test() and distutils_src_install().
Check for Jython-related directories in 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.72 2010/02/08 09:35:38 pva 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 "${PYTHON_DEPEND}" ]]; then
26 DEPEND="dev-lang/python"
27 RDEPEND="${DEPEND}"
28 fi
29
30 if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
31 python="python"
32 else
33 # Use "$(PYTHON)" instead of "${python}".
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 ${D}, 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 # @FUNCTION: distutils_src_test
196 # @DESCRIPTION:
197 # The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set.
198 distutils_src_test() {
199 _python_set_color_variables
200
201 if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
202 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
203 distutils_testing() {
204 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}
205 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
206 }
207 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
208 else
209 echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@"${_NORMAL}
210 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" || die "Testing failed"
211 fi
212 elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
213 python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
214 elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
215 python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
216 # trial requires an argument, which is usually equal to "${PN}".
217 elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
218 local trial_arguments
219 if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
220 trial_arguments="${DISTUTILS_SRC_TEST#trial }"
221 else
222 trial_arguments="${PN}"
223 fi
224
225 python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
226 else
227 die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
228 fi
229 }
230
231 # @FUNCTION: distutils_src_install
232 # @DESCRIPTION:
233 # The distutils src_install function. This function is exported.
234 # In ebuilds of packages supporting installation for multiple versions of Python, this function
235 # calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
236 # It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
237 # KNOWN_BUGS, MAINTAINERS, MANIFEST*, NEWS, PKG-INFO, README*, TODO).
238 distutils_src_install() {
239 if [[ "${EBUILD_PHASE}" != "install" ]]; then
240 die "${FUNCNAME}() can be used only in src_install() phase"
241 fi
242
243 _python_set_color_variables
244
245 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
246 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
247 declare -A wrapper_scripts=()
248
249 rename_scripts_with_versioned_shebangs() {
250 if [[ -d "${D}usr/bin" ]]; then
251 cd "${D}usr/bin"
252
253 local nonversioned_file file
254 for file in *; do
255 if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]](-jython)?+$ && "$(head -n1 "${file}")" =~ ^'#!'.*(python|jython-)[[:digit:]]+\.[[:digit:]]+ ]]; then
256 for nonversioned_file in "${DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS[@]}"; do
257 [[ "${nonversioned_file}" == "/usr/bin/${file}" ]] && continue 2
258 done
259 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
260 wrapper_scripts+=(["${D}usr/bin/${file}"]=)
261 fi
262 done
263 fi
264 }
265 fi
266
267 distutils_installation() {
268 _distutils_hook pre
269
270 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}
271 "$(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 "$?"
272
273 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
274 rename_scripts_with_versioned_shebangs
275 fi
276
277 _distutils_hook post
278 }
279 python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"
280
281 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
282 python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
283 fi
284 unset wrapper_scripts
285 else
286 # Mark the package to be rebuilt after a Python upgrade.
287 python_need_rebuild
288
289 echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"${_NORMAL}
290 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
291 fi
292
293 if [[ -e "${D}usr/local" ]]; then
294 die "Illegal installation into /usr/local"
295 fi
296
297 local default_docs
298 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
299
300 local doc
301 for doc in ${default_docs}; do
302 [[ -s "${doc}" ]] && dodoc "${doc}"
303 done
304
305 if [[ -n "${DOCS}" ]]; then
306 dodoc ${DOCS} || die "dodoc failed"
307 fi
308 }
309
310 # @FUNCTION: distutils_pkg_postinst
311 # @DESCRIPTION:
312 # The distutils pkg_postinst function. This function is exported.
313 # When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
314 # specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
315 # name is equal to name of current package, if this module exists.
316 distutils_pkg_postinst() {
317 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
318 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
319 fi
320
321 local pylibdir pymod
322 if [[ -z "${PYTHON_MODNAME}" ]]; then
323 for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; do
324 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
325 PYTHON_MODNAME="${PN}"
326 fi
327 done
328 fi
329
330 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
331 python_mod_optimize ${PYTHON_MODNAME}
332 else
333 for pymod in ${PYTHON_MODNAME}; do
334 python_mod_optimize "$(python_get_sitedir)/${pymod}"
335 done
336 fi
337 }
338
339 # @FUNCTION: distutils_pkg_postrm
340 # @DESCRIPTION:
341 # The distutils pkg_postrm function. This function is exported.
342 # When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
343 # specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
344 # name is equal to name of current package, if this module exists.
345 distutils_pkg_postrm() {
346 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
347 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
348 fi
349
350 local pylibdir pymod
351 if [[ -z "${PYTHON_MODNAME}" ]]; then
352 for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; do
353 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
354 PYTHON_MODNAME="${PN}"
355 fi
356 done
357 fi
358
359 if [[ -n "${PYTHON_MODNAME}" ]]; then
360 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
361 python_mod_cleanup ${PYTHON_MODNAME}
362 else
363 for pymod in ${PYTHON_MODNAME}; do
364 for pylibdir in "${ROOT}"usr/$(get_libdir)/python*; do
365 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
366 python_mod_cleanup "${pylibdir#${ROOT%/}}/site-packages/${pymod}"
367 fi
368 done
369 done
370 fi
371 else
372 python_mod_cleanup
373 fi
374 }
375
376 # @FUNCTION: distutils_python_version
377 # @DESCRIPTION:
378 # Deprecated wrapper function for deprecated python_version().
379 distutils_python_version() {
380 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
381 eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
382 die "${FUNCNAME}() cannot be used in this EAPI"
383 fi
384
385 python_version
386 }
387
388 # @FUNCTION: distutils_python_tkinter
389 # @DESCRIPTION:
390 # Deprecated wrapper function for deprecated python_tkinter_exists().
391 distutils_python_tkinter() {
392 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
393 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
394 die "${FUNCNAME}() cannot be used in this EAPI"
395 fi
396
397 python_tkinter_exists
398 }

  ViewVC Help
Powered by ViewVC 1.1.20