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

Diff of /eclass/distutils.eclass

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

Revision 1.14 Revision 1.69
1# Copyright 1999-2003 Gentoo Technologies, Inc. 1# Copyright 1999-2009 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.14 2003/09/09 22:50:02 liquidx Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.69 2010/01/10 17:24:32 arfrever Exp $
4
5# @ECLASS: distutils.eclass
6# @MAINTAINER:
7# <python@gentoo.org>
4# 8#
5# Author: Jon Nelson <jnelson@gentoo.org> 9# Original author: Jon Nelson <jnelson@gentoo.org>
6# Current Maintainer: Alastair Tse <liquidx@gentoo.org> 10# @BLURB: This eclass allows easier installation of distutils-based python modules
7# 11# @DESCRIPTION:
8# The distutils eclass is designed to allow easier installation of 12# The distutils eclass is designed to allow easier installation of
9# distutils-based python modules and their incorporation into 13# distutils-based python modules and their incorporation into
10# the Gentoo Linux system. 14# the Gentoo Linux system.
11#
12# - Features:
13# distutils_src_compile() - does python setup.py build
14# distutils_src_install() - does python setup.py install and install docs
15# distutils_python_version() - sets PYVER/PYVER_MAJOR/PYVER_MINOR
16# distutils_python_tkinter() - checks for tkinter support in python
17#
18# - Variables:
19# PYTHON_SLOT_VERSION - for Zope support
20# DOCS - additional DOCS
21 15
22ECLASS=distutils 16inherit eutils multilib python
23INHERITED="$INHERITED $ECLASS"
24 17
25# This helps make it possible to add extensions to python slots. 18case "${EAPI:-0}" in
26# Normally only a -py21- ebuild would set PYTHON_SLOT_VERSION. 19 0|1)
27if [ "${PYTHON_SLOT_VERSION}" = 2.1 ] ; then 20 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
28 newdepend "=dev-lang/python-2.1*" 21 ;;
22 *)
23 EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
24 ;;
25esac
26
27if [[ -z "${DISTUTILS_DISABLE_PYTHON_DEPENDENCY}" ]]; then
28 DEPEND="virtual/python"
29 RDEPEND="${DEPEND}"
30fi
31
32if has "${EAPI:-0}" 0 1 2; then
29 python="python2.1" 33 python="python"
30else 34else
31 newdepend "virtual/python" 35 python="die"
32 python="python"
33fi 36fi
34 37
38# @ECLASS-VARIABLE: DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
39# @DESCRIPTION:
40# Set this to use separate source directories for each enabled version of Python.
41
42# @ECLASS-VARIABLE: DISTUTILS_GLOBAL_OPTIONS
43# @DESCRIPTION:
44# Global options passed to setup.py.
45
46# @ECLASS-VARIABLE: DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS
47# @DESCRIPTION:
48# Set this to disable renaming of Python scripts containing versioned shebangs
49# and generation of wrapper scripts.
50
51# @ECLASS-VARIABLE: DOCS
52# @DESCRIPTION:
53# Additional DOCS
54
55_distutils_hook() {
56 if [[ "$#" -ne 1 ]]; then
57 die "${FUNCNAME}() requires 1 argument"
58 fi
59 if [[ "$(type -t "distutils_src_${EBUILD_PHASE}_$1_hook")" == "function" ]]; then
60 "distutils_src_${EBUILD_PHASE}_$1_hook"
61 fi
62}
63
64# @FUNCTION: distutils_src_unpack
65# @DESCRIPTION:
66# The distutils src_unpack function, this function is exported.
67distutils_src_unpack() {
68 if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
69 die "${FUNCNAME}() can be used only in src_unpack() phase"
70 fi
71
72 unpack ${A}
73 cd "${S}"
74
75 has "${EAPI:-0}" 0 1 && distutils_src_prepare
76}
77
78# @FUNCTION: distutils_src_prepare
79# @DESCRIPTION:
80# The distutils src_prepare function, this function is exported.
81distutils_src_prepare() {
82 if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
83 die "${FUNCNAME}() can be used only in src_prepare() phase"
84 fi
85
86 # Delete ez_setup files to prevent packages from installing
87 # Setuptools on their own.
88 local ez_setup_existence="0"
89 [[ -d ez_setup || -f ez_setup.py ]] && ez_setup_existence="1"
90 rm -fr ez_setup*
91 if [[ "${ez_setup_existence}" == "1" ]]; then
92 echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py
93 fi
94
95 # Delete distribute_setup files to prevent packages from installing
96 # Distribute on their own.
97 local distribute_setup_existence="0"
98 [[ -d distribute_setup || -f distribute_setup.py ]] && distribute_setup_existence="1"
99 rm -fr distribute_setup*
100 if [[ "${distribute_setup_existence}" == "1" ]]; then
101 echo "def use_setuptools(*args, **kwargs): pass" > distribute_setup.py
102 fi
103
104 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
105 python_copy_sources
106 fi
107}
108
109# @FUNCTION: distutils_src_compile
110# @DESCRIPTION:
111# The distutils src_compile function, this function is exported.
112# In newer EAPIs this function calls distutils_src_compile_pre_hook() and
113# distutils_src_compile_post_hook(), if they are defined.
35distutils_src_compile() { 114distutils_src_compile() {
36 ${python} setup.py build ${@} || die "compilation failed" 115 if [[ "${EBUILD_PHASE}" != "compile" ]]; then
37} 116 die "${FUNCNAME}() can be used only in src_compile() phase"
117 fi
38 118
119 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
120 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
121 building() {
122 _distutils_hook pre
123
124 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
125 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || return "$?"
126
127 _distutils_hook post
128 }
129 python_execute_function -s building "$@"
130 else
131 building() {
132 _distutils_hook pre
133
134 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" "$@"
135 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" "$@" || return "$?"
136
137 _distutils_hook post
138 }
139 python_execute_function building "$@"
140 fi
141 else
142 echo "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
143 "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
144 fi
145}
146
147# @FUNCTION: distutils_src_install
148# @DESCRIPTION:
149# The distutils src_install function, this function is exported.
150# In newer EAPIs this function calls distutils_src_install_pre_hook() and
151# distutils_src_install_post_hook(), if they are defined.
152# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
153# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS)
39distutils_src_install() { 154distutils_src_install() {
40 ${python} setup.py install --root=${D} ${@} || die 155 if [[ "${EBUILD_PHASE}" != "install" ]]; then
41 156 die "${FUNCNAME}() can be used only in src_install() phase"
42 dodoc CHANGELOG COPYRIGHT KNOWN_BUGS MAINTAINERS 157 fi
43 dodoc CONTRIBUTORS LICENSE COPYING* 158
44 dodoc Change* MANIFEST* README* 159 local pylibdir
45 160
46 [ -n "${DOCS}" ] && dodoc ${DOCS} 161 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
47 162 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
48 # deprecated! please use DOCS instead. 163 declare -A wrapper_scripts=()
164
165 rename_scripts_with_versioned_shebangs() {
166 if [[ -d "${D}usr/bin" ]]; then
167 cd "${D}usr/bin"
168
169 local file
170 for file in *; do
171 if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]]+$ && "$(head -n1 "${file}")" =~ ^'#!'.*python[[:digit:]]+\.[[:digit:]]+ ]]; then
172 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
173 wrapper_scripts+=(["${D}usr/bin/${file}"]=)
174 fi
175 done
176 fi
177 }
178 fi
179
180 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
181 installation() {
182 _distutils_hook pre
183
184 # need this for python-2.5 + setuptools in cases where
185 # a package uses distutils but does not install anything
186 # in site-packages. (eg. dev-java/java-config-2.x)
187 # - liquidx (14/08/2006)
188 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
189 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
190
191 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
192 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || return "$?"
193
194 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
195 rename_scripts_with_versioned_shebangs
196 fi
197
198 _distutils_hook post
199 }
200 python_execute_function -s installation "$@"
201 else
202 installation() {
203 _distutils_hook pre
204
205 # need this for python-2.5 + setuptools in cases where
206 # a package uses distutils but does not install anything
207 # in site-packages. (eg. dev-java/java-config-2.x)
208 # - liquidx (14/08/2006)
209 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
210 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
211
212 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
213 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@" || return "$?"
214
215 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
216 rename_scripts_with_versioned_shebangs
217 fi
218
219 _distutils_hook post
220 }
221 python_execute_function installation "$@"
222 fi
223
224 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne "0" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
225 python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
226 fi
227 unset wrapper_scripts
228 else
229 # Mark the package to be rebuilt after a Python upgrade.
230 python_need_rebuild
231
232 # need this for python-2.5 + setuptools in cases where
233 # a package uses distutils but does not install anything
234 # in site-packages. (eg. dev-java/java-config-2.x)
235 # - liquidx (14/08/2006)
236 pylibdir="$("$(PYTHON -A)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
237 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
238
239 echo "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
240 "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
241 fi
242
243 if [[ -e "${D}usr/local" ]]; then
244 die "Illegal installation into /usr/local"
245 fi
246
247 local default_docs
248 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
249
250 local doc
251 for doc in ${default_docs}; do
49 [ -n "${mydoc}" ] && dodoc ${mydoc} 252 [[ -s "${doc}" ]] && dodoc "${doc}"
50} 253 done
51 254
52# e.g. insinto ${ROOT}/usr/include/python${PYVER} 255 if [[ -n "${DOCS}" ]]; then
256 dodoc ${DOCS} || die "dodoc failed"
257 fi
258}
53 259
260# @FUNCTION: distutils_pkg_postinst
261# @DESCRIPTION:
262# This is a generic optimization, you should override it if your package
263# installs modules in another directory. This function is exported.
264distutils_pkg_postinst() {
265 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
266 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
267 fi
268
269 local pylibdir pymod
270 if [[ -z "${PYTHON_MODNAME}" ]]; then
271 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
272 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
273 PYTHON_MODNAME="${PN}"
274 fi
275 done
276 fi
277
278 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
279 python_mod_optimize ${PYTHON_MODNAME}
280 else
281 for pymod in ${PYTHON_MODNAME}; do
282 python_mod_optimize "$(python_get_sitedir)/${pymod}"
283 done
284 fi
285}
286
287# @FUNCTION: distutils_pkg_postrm
288# @DESCRIPTION:
289# Generic pyc/pyo cleanup script. This function is exported.
290distutils_pkg_postrm() {
291 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
292 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
293 fi
294
295 local pylibdir pymod
296 if [[ -z "${PYTHON_MODNAME}" ]]; then
297 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
298 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
299 PYTHON_MODNAME="${PN}"
300 fi
301 done
302 fi
303
304 if [[ -n "${PYTHON_MODNAME}" ]]; then
305 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
306 python_mod_cleanup ${PYTHON_MODNAME}
307 else
308 for pymod in ${PYTHON_MODNAME}; do
309 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
310 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
311 python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
312 fi
313 done
314 done
315 fi
316 else
317 python_mod_cleanup
318 fi
319}
320
321# @FUNCTION: distutils_python_version
322# @DESCRIPTION:
323# Calls python_version, so that you can use something like
324# e.g. insinto $(python_get_includedir)
54distutils_python_version() { 325distutils_python_version() {
55 local tmpstr="$(${python} -V 2>&1 )" 326 if ! has "${EAPI:-0}" 0 1 2; then
56 export PYVER_ALL="${tmpstr#Python }" 327 die "${FUNCNAME}() cannot be used in this EAPI"
328 fi
57 329
58 export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1) 330 python_version
59 export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2)
60 export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-)
61 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
62} 331}
63 332
333# @FUNCTION: distutils_python_tkinter
334# @DESCRIPTION:
64# checks for if tkinter support is compiled into python 335# Checks for if tkinter support is compiled into python
65distutils_python_tkinter() { 336distutils_python_tkinter() {
66 if ! python -c "import Tkinter" >/dev/null 2>&1; then 337 if ! has "${EAPI:-0}" 0 1 2; then
67 eerror "You need to recompile python with Tkinter support." 338 die "${FUNCNAME}() cannot be used in this EAPI"
68 eerror "That means: USE='tcltk' emerge python"
69 echo
70 die "missing tkinter support with installed python"
71 fi 339 fi
72}
73 340
74 341 python_tkinter_exists
75EXPORT_FUNCTIONS src_compile src_install 342}
76

Legend:
Removed from v.1.14  
changed lines
  Added in v.1.69

  ViewVC Help
Powered by ViewVC 1.1.20