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

Diff of /eclass/distutils.eclass

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

Revision 1.33 Revision 1.62
1# Copyright 1999-2004 Gentoo Foundation 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.33 2006/08/14 21:01:01 liquidx Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.62 2009/09/09 19:26:00 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
22inherit python eutils 16inherit eutils multilib python
23 17
24# This helps make it possible to add extensions to python slots. 18case "${EAPI:-0}" in
25# Normally only a -py21- ebuild would set PYTHON_SLOT_VERSION. 19 0|1)
26if [ "${PYTHON_SLOT_VERSION}" = "2.1" ] ; then 20 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
27 DEPEND="=dev-lang/python-2.1*" 21 ;;
28 python="python2.1" 22 *)
29elif [ "${PYTHON_SLOT_VERSION}" = "2.3" ] ; then 23 EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
30 DEPEND="=dev-lang/python-2.3*" 24 ;;
31 python="python2.3" 25esac
32else 26
27if [[ -z "${DISTUTILS_DISABLE_PYTHON_DEPENDENCY}" ]]; then
33 DEPEND="virtual/python" 28 DEPEND="virtual/python"
34 python="python" 29 RDEPEND="${DEPEND}"
35fi 30fi
31python="python"
36 32
33# @ECLASS-VARIABLE: DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
34# @DESCRIPTION:
35# Set this to use separate source directories for each enabled version of Python.
36
37# @ECLASS-VARIABLE: DISTUTILS_GLOBAL_OPTIONS
38# @DESCRIPTION:
39# Global options passed to setup.py.
40
41# @ECLASS-VARIABLE: DOCS
42# @DESCRIPTION:
43# Additional DOCS
44
45# @FUNCTION: distutils_src_unpack
46# @DESCRIPTION:
47# The distutils src_unpack function, this function is exported
48distutils_src_unpack() {
49 if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
50 die "${FUNCNAME}() can be used only in src_unpack() phase"
51 fi
52
53 unpack ${A}
54 cd "${S}"
55
56 has "${EAPI:-0}" 0 1 && distutils_src_prepare
57}
58
59# @FUNCTION: distutils_src_prepare
60# @DESCRIPTION:
61# The distutils src_prepare function, this function is exported
62distutils_src_prepare() {
63 if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
64 die "${FUNCNAME}() can be used only in src_prepare() phase"
65 fi
66
67 # Delete ez_setup files to prevent packages from installing
68 # setuptools on their own.
69 local ez_setup_py_existence
70 [[ -f ez_setup.py ]] && ez_setup_py_existence="1"
71 rm -fr ez_setup*
72 if [[ "${ez_setup_py_existence}" == "1" ]]; then
73 echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py
74 fi
75
76 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
77 python_copy_sources
78 fi
79}
80
81# @FUNCTION: distutils_src_compile
82# @DESCRIPTION:
83# The distutils src_compile function, this function is exported
37distutils_src_compile() { 84distutils_src_compile() {
38 ${python} setup.py build "$@" || die "compilation failed" 85 if [[ "${EBUILD_PHASE}" != "compile" ]]; then
39} 86 die "${FUNCNAME}() can be used only in src_compile() phase"
87 fi
40 88
89 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
90 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
91 building() {
92 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
93 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
94 }
95 python_execute_function -s building "$@"
96 else
97 building() {
98 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" "$@"
99 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" "$@"
100 }
101 python_execute_function building "$@"
102 fi
103 else
104 echo ${python} setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
105 ${python} setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
106 fi
107}
108
109# @FUNCTION: distutils_src_install
110# @DESCRIPTION:
111# The distutils src_install function, this function is exported.
112# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
113# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS)
41distutils_src_install() { 114distutils_src_install() {
115 if [[ "${EBUILD_PHASE}" != "install" ]]; then
116 die "${FUNCNAME}() can be used only in src_install() phase"
117 fi
42 118
119 local pylibdir
120
121 # Mark the package to be rebuilt after a python upgrade.
122 python_need_rebuild
123
124 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
125 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
126 installation() {
127 # need this for python-2.5 + setuptools in cases where
128 # a package uses distutils but does not install anything
129 # in site-packages. (eg. dev-java/java-config-2.x)
130 # - liquidx (14/08/2006)
131 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
132 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
133
134 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
135 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
136 }
137 python_execute_function -s installation "$@"
138 else
139 installation() {
140 # need this for python-2.5 + setuptools in cases where
141 # a package uses distutils but does not install anything
142 # in site-packages. (eg. dev-java/java-config-2.x)
143 # - liquidx (14/08/2006)
144 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
145 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
146
147 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
148 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
149 }
150 python_execute_function installation "$@"
151 fi
152 else
43 # need this for python-2.5 + setuptools in cases where 153 # need this for python-2.5 + setuptools in cases where
44 # a package uses distutils but does not install anything 154 # a package uses distutils but does not install anything
45 # in site-packages. (eg. dev-java/java-config-2.x) 155 # in site-packages. (eg. dev-java/java-config-2.x)
46 # - liquidx (14/08/2006) 156 # - liquidx (14/08/2006)
47 pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print get_python_lib()')" 157 pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
48 [ -n "${pylibdir}" ] && dodir "${pylibdir}" 158 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
49
50 if has_version ">=dev-lang/python-2.3"; then
51 ${python} setup.py install --root=${D} --no-compile "$@" || die
52 else
53 ${python} setup.py install --root=${D} "$@" || die
54 fi
55 159
56 DDOCS="CHANGELOG COPYRIGHT KNOWN_BUGS MAINTAINERS PKG-INFO" 160 echo ${python} setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
57 DDOCS="${DDOCS} CONTRIBUTORS TODO" 161 ${python} setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
58 DDOCS="${DDOCS} Change* MANIFEST* README*" 162 fi
59 163
60 for doc in ${DDOCS}; do 164 local default_docs
165 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
166
167 local doc
168 for doc in ${default_docs}; do
61 [ -s "$doc" ] && dodoc $doc 169 [[ -s "${doc}" ]] && dodoc "${doc}"
62 done 170 done
63 171
64 [ -n "${DOCS}" ] && dodoc ${DOCS} 172 if [[ -n "${DOCS}" ]]; then
65 173 dodoc ${DOCS} || die "dodoc failed"
66 # deprecated! please use DOCS instead. 174 fi
67 [ -n "${mydoc}" ] && dodoc ${mydoc}
68} 175}
69 176
70# generic pyc/pyo cleanup script. 177# @FUNCTION: distutils_pkg_postrm
71 178# @DESCRIPTION:
179# Generic pyc/pyo cleanup script. This function is exported.
72distutils_pkg_postrm() { 180distutils_pkg_postrm() {
73 PYTHON_MODNAME=${PYTHON_MODNAME:-${PN}} 181 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
182 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
183 fi
74 184
75 if has_version ">=dev-lang/python-2.3"; then 185 local pylibdir pymod
76 ebegin "Performing Python Module Cleanup .." 186 if [[ -z "${PYTHON_MODNAME}" ]]; then
187 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
188 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
189 PYTHON_MODNAME="${PN}"
190 fi
191 done
192 fi
193
77 if [ -n "${PYTHON_MODNAME}" ]; then 194 if [[ -n "${PYTHON_MODNAME}" ]]; then
78 for pymod in ${PYTHON_MODNAME}; do 195 for pymod in ${PYTHON_MODNAME}; do
79 for moddir in "`ls -d --color=none -1 ${ROOT}usr/$(get_libdir)/python*/site-packages/${pymod} 2> /dev/null`"; do 196 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
197 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
198 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
80 python_mod_cleanup ${moddir} 199 python_mod_cleanup "${pymod}"
81 done 200 else
201 python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
202 fi
203 fi
82 done 204 done
205 done
83 else 206 else
84 python_mod_cleanup 207 python_mod_cleanup
85 fi 208 fi
86 eend 0
87 fi
88} 209}
89 210
211# @FUNCTION: distutils_pkg_postinst
212# @DESCRIPTION:
90# this is a generic optimization, you should override it if your package 213# This is a generic optimization, you should override it if your package
91# installs things in another directory 214# installs modules in another directory. This function is exported.
92
93distutils_pkg_postinst() { 215distutils_pkg_postinst() {
94 PYTHON_MODNAME=${PYTHON_MODNAME:-${PN}} 216 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
217 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
218 fi
95 219
96 if has_version ">=dev-lang/python-2.3"; then 220 local pylibdir pymod
221 if [[ -z "${PYTHON_MODNAME}" ]]; then
222 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
223 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
224 PYTHON_MODNAME="${PN}"
225 fi
226 done
227 fi
228
229 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
230 for pymod in ${PYTHON_MODNAME}; do
231 python_mod_optimize "${pymod}"
232 done
233 else
97 python_version 234 python_version
98 for pymod in ${PYTHON_MODNAME}; do 235 for pymod in ${PYTHON_MODNAME}; do
99 if [ -d "${ROOT}usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}" ]; then
100 python_mod_optimize ${ROOT}usr/$(get_libdir)/python${PYVER}/site-packages/${pymod} 236 python_mod_optimize "/usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}"
237 done
101 fi 238 fi
102 done
103 fi
104} 239}
105 240
241# @FUNCTION: distutils_python_version
242# @DESCRIPTION:
243# Calls python_version, so that you can use something like
106# e.g. insinto ${ROOT}/usr/include/python${PYVER} 244# e.g. insinto ${ROOT}/usr/include/python${PYVER}
107
108distutils_python_version() { 245distutils_python_version() {
109 local tmpstr="$(${python} -V 2>&1 )" 246 python_version
110 export PYVER_ALL="${tmpstr#Python }"
111
112 export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1)
113 export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2)
114 export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-)
115 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
116} 247}
117 248
249# @FUNCTION: distutils_python_tkinter
250# @DESCRIPTION:
118# checks for if tkinter support is compiled into python 251# Checks for if tkinter support is compiled into python
119distutils_python_tkinter() { 252distutils_python_tkinter() {
120 if ! python -c "import Tkinter" >/dev/null 2>&1; then 253 python_tkinter_exists
121 eerror "You need to recompile python with Tkinter support."
122 eerror "Try adding 'dev-lang/python X tk' to:"
123 eerror "/etc/portage/package.use"
124 echo
125 die "missing tkinter support with installed python"
126 fi
127} 254}
128
129EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_postrm
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.62
  ViewVC Help
Powered by ViewVC 1.1.20