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

Diff of /eclass/distutils.eclass

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

Revision 1.57 Revision 1.69
1# Copyright 1999-2009 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.57 2009/08/02 00:30:29 arfrever Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.69 2010/01/10 17:24:32 arfrever Exp $
4 4
5# @ECLASS: distutils.eclass 5# @ECLASS: distutils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# <python@gentoo.org> 7# <python@gentoo.org>
8# 8#
10# @BLURB: This eclass allows easier installation of distutils-based python modules 10# @BLURB: This eclass allows easier installation of distutils-based python modules
11# @DESCRIPTION: 11# @DESCRIPTION:
12# The distutils eclass is designed to allow easier installation of 12# The distutils eclass is designed to allow easier installation of
13# distutils-based python modules and their incorporation into 13# distutils-based python modules and their incorporation into
14# the Gentoo Linux system. 14# the Gentoo Linux system.
15#
16# It inherits python, multilib, and eutils
17 15
18inherit python multilib eutils 16inherit eutils multilib python
19 17
20case "${EAPI:-0}" in 18case "${EAPI:-0}" in
21 0|1) 19 0|1)
22 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm 20 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
23 ;; 21 ;;
24 *) 22 *)
25 EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm 23 EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
26 ;; 24 ;;
27esac 25esac
28 26
29# @ECLASS-VARIABLE: PYTHON_SLOT_VERSION 27if [[ -z "${DISTUTILS_DISABLE_PYTHON_DEPENDENCY}" ]]; then
30# @DESCRIPTION: 28 DEPEND="virtual/python"
31# This helps make it possible to add extensions to python slots. 29 RDEPEND="${DEPEND}"
32# Normally only a -py21- ebuild would set PYTHON_SLOT_VERSION. 30fi
33if [ "${PYTHON_SLOT_VERSION}" = "2.1" ] ; then 31
34 DEPEND="=dev-lang/python-2.1*" 32if has "${EAPI:-0}" 0 1 2; then
35 python="python2.1" 33 python="python"
36elif [ "${PYTHON_SLOT_VERSION}" = "2.3" ] ; then
37 DEPEND="=dev-lang/python-2.3*"
38 python="python2.3"
39else 34else
40 DEPEND="virtual/python" 35 python="die"
41 python="python"
42fi 36fi
43 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
44# @ECLASS-VARIABLE: DOCS 51# @ECLASS-VARIABLE: DOCS
45# @DESCRIPTION: 52# @DESCRIPTION:
46# Additional DOCS 53# Additional DOCS
47 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
48# @FUNCTION: distutils_src_unpack 64# @FUNCTION: distutils_src_unpack
49# @DESCRIPTION: 65# @DESCRIPTION:
50# The distutils src_unpack function, this function is exported 66# The distutils src_unpack function, this function is exported.
51distutils_src_unpack() { 67distutils_src_unpack() {
68 if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
69 die "${FUNCNAME}() can be used only in src_unpack() phase"
70 fi
71
52 unpack ${A} 72 unpack ${A}
53 cd "${S}" 73 cd "${S}"
54 74
55 has "${EAPI:-0}" 0 1 && distutils_src_prepare 75 has "${EAPI:-0}" 0 1 && distutils_src_prepare
56} 76}
57 77
58# @FUNCTION: distutils_src_prepare 78# @FUNCTION: distutils_src_prepare
59# @DESCRIPTION: 79# @DESCRIPTION:
60# The distutils src_prepare function, this function is exported 80# The distutils src_prepare function, this function is exported.
61distutils_src_prepare() { 81distutils_src_prepare() {
62 # remove ez_setup stuff to prevent packages 82 if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
63 # from installing setuptools on their own 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"
64 rm -rf ez_setup* 90 rm -fr ez_setup*
91 if [[ "${ez_setup_existence}" == "1" ]]; then
65 echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py 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
66} 107}
67 108
68# @FUNCTION: distutils_src_compile 109# @FUNCTION: distutils_src_compile
69# @DESCRIPTION: 110# @DESCRIPTION:
70# The distutils src_compile function, this function is exported 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.
71distutils_src_compile() { 114distutils_src_compile() {
115 if [[ "${EBUILD_PHASE}" != "compile" ]]; then
116 die "${FUNCNAME}() can be used only in src_compile() phase"
117 fi
118
72 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 119 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
73 build_modules() { 120 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
74 echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@" 121 building() {
75 "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@" 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
76 } 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 }
77 python_execute_function build_modules "$@" 139 python_execute_function building "$@"
140 fi
78 else 141 else
79 ${python} setup.py build "$@" || die "compilation failed" 142 echo "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
143 "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
80 fi 144 fi
81} 145}
82 146
83# @FUNCTION: distutils_src_install 147# @FUNCTION: distutils_src_install
84# @DESCRIPTION: 148# @DESCRIPTION:
85# The distutils src_install function, this function is exported. 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.
86# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS, 152# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
87# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS) 153# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS)
88distutils_src_install() { 154distutils_src_install() {
155 if [[ "${EBUILD_PHASE}" != "install" ]]; then
156 die "${FUNCNAME}() can be used only in src_install() phase"
157 fi
89 158
90 # Mark the package to be rebuilt after a python upgrade. 159 local pylibdir
91 python_need_rebuild
92 160
93 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 161 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
94 install_modules() { 162 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
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
95 # need this for python-2.5 + setuptools in cases where 184 # need this for python-2.5 + setuptools in cases where
96 # a package uses distutils but does not install anything 185 # a package uses distutils but does not install anything
97 # in site-packages. (eg. dev-java/java-config-2.x) 186 # in site-packages. (eg. dev-java/java-config-2.x)
98 # - liquidx (14/08/2006) 187 # - liquidx (14/08/2006)
99 pylibdir="$("$(get_python)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')" 188 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
100 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}" 189 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
101 190
102 echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@" 191 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
103 "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" 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
104 } 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 }
105 python_execute_function install_modules "$@" 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
106 else 228 else
229 # Mark the package to be rebuilt after a Python upgrade.
230 python_need_rebuild
231
107 # need this for python-2.5 + setuptools in cases where 232 # need this for python-2.5 + setuptools in cases where
108 # a package uses distutils but does not install anything 233 # a package uses distutils but does not install anything
109 # in site-packages. (eg. dev-java/java-config-2.x) 234 # in site-packages. (eg. dev-java/java-config-2.x)
110 # - liquidx (14/08/2006) 235 # - liquidx (14/08/2006)
111 pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')" 236 pylibdir="$("$(PYTHON -A)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
112 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}" 237 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
113 238
114 ${python} setup.py install --root="${D}" --no-compile "$@" || die "python setup.py install failed" 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"
115 fi 241 fi
116 242
117 DDOCS="CHANGELOG KNOWN_BUGS MAINTAINERS PKG-INFO CONTRIBUTORS TODO NEWS" 243 if [[ -e "${D}usr/local" ]]; then
118 DDOCS="${DDOCS} Change* MANIFEST* README* AUTHORS" 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"
119 249
120 local doc 250 local doc
121 for doc in ${DDOCS}; do 251 for doc in ${default_docs}; do
122 [[ -s "$doc" ]] && dodoc $doc 252 [[ -s "${doc}" ]] && dodoc "${doc}"
123 done 253 done
124 254
125 [[ -n "${DOCS}" ]] && dodoc ${DOCS} 255 if [[ -n "${DOCS}" ]]; then
256 dodoc ${DOCS} || die "dodoc failed"
257 fi
126} 258}
127 259
128# @FUNCTION: distutils_pkg_postrm 260# @FUNCTION: distutils_pkg_postinst
129# @DESCRIPTION: 261# @DESCRIPTION:
130# Generic pyc/pyo cleanup script. This function is exported. 262# This is a generic optimization, you should override it if your package
263# installs modules in another directory. This function is exported.
131distutils_pkg_postrm() { 264distutils_pkg_postinst() {
265 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
266 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
267 fi
268
132 local pylibdir pymod 269 local pylibdir pymod
133 if [[ -z "${PYTHON_MODNAME}" ]]; then 270 if [[ -z "${PYTHON_MODNAME}" ]]; then
134 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do 271 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
135 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then 272 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
136 PYTHON_MODNAME="${PN}" 273 PYTHON_MODNAME="${PN}"
137 fi 274 fi
138 done 275 done
139 fi 276 fi
140 277
141 ebegin "Performing cleanup of Python modules..." 278 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
142 if [[ -n "${PYTHON_MODNAME}" ]]; then 279 python_mod_optimize ${PYTHON_MODNAME}
280 else
143 for pymod in ${PYTHON_MODNAME}; do 281 for pymod in ${PYTHON_MODNAME}; do
144 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do 282 python_mod_optimize "$(python_get_sitedir)/${pymod}"
145 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
146 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
147 python_mod_cleanup "${pymod}"
148 else
149 python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
150 fi
151 fi
152 done
153 done 283 done
154 else
155 python_mod_cleanup
156 fi 284 fi
157 eend 0
158} 285}
159 286
160# @FUNCTION: distutils_pkg_postinst 287# @FUNCTION: distutils_pkg_postrm
161# @DESCRIPTION: 288# @DESCRIPTION:
162# This is a generic optimization, you should override it if your package 289# Generic pyc/pyo cleanup script. This function is exported.
163# installs modules in another directory. This function is exported.
164distutils_pkg_postinst() { 290distutils_pkg_postrm() {
291 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
292 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
293 fi
294
165 local pylibdir pymod 295 local pylibdir pymod
166 if [[ -z "${PYTHON_MODNAME}" ]]; then 296 if [[ -z "${PYTHON_MODNAME}" ]]; then
167 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do 297 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
168 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then 298 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
169 PYTHON_MODNAME="${PN}" 299 PYTHON_MODNAME="${PN}"
170 fi 300 fi
171 done 301 done
172 fi 302 fi
173 303
304 if [[ -n "${PYTHON_MODNAME}" ]]; then
174 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 305 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
306 python_mod_cleanup ${PYTHON_MODNAME}
307 else
175 for pymod in ${PYTHON_MODNAME}; do 308 for pymod in ${PYTHON_MODNAME}; do
176 python_mod_optimize "${pymod}" 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
177 done 314 done
315 fi
178 else 316 else
179 python_version 317 python_mod_cleanup
180 for pymod in ${PYTHON_MODNAME}; do
181 python_mod_optimize "/usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}"
182 done
183 fi 318 fi
184} 319}
185 320
186# @FUNCTION: distutils_python_version 321# @FUNCTION: distutils_python_version
187# @DESCRIPTION: 322# @DESCRIPTION:
188# Calls python_version, so that you can use something like 323# Calls python_version, so that you can use something like
189# e.g. insinto ${ROOT}/usr/include/python${PYVER} 324# e.g. insinto $(python_get_includedir)
190distutils_python_version() { 325distutils_python_version() {
326 if ! has "${EAPI:-0}" 0 1 2; then
327 die "${FUNCNAME}() cannot be used in this EAPI"
328 fi
329
191 python_version 330 python_version
192} 331}
193 332
194# @FUNCTION: distutils_python_tkinter 333# @FUNCTION: distutils_python_tkinter
195# @DESCRIPTION: 334# @DESCRIPTION:
196# Checks for if tkinter support is compiled into python 335# Checks for if tkinter support is compiled into python
197distutils_python_tkinter() { 336distutils_python_tkinter() {
337 if ! has "${EAPI:-0}" 0 1 2; then
338 die "${FUNCNAME}() cannot be used in this EAPI"
339 fi
340
198 python_tkinter_exists 341 python_tkinter_exists
199} 342}

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

  ViewVC Help
Powered by ViewVC 1.1.20