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

Contents of /eclass/distutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.68 - (show annotations) (download)
Thu Dec 24 04:21:39 2009 UTC (4 years, 11 months ago) by arfrever
Branch: MAIN
Changes since 1.67: +51 -2 lines
Disallow using of ${python}, distutils_python_version() and distutils_python_tkinter() in EAPI >=3. Add renaming of Python scripts containing versioned shebangs and generation of wrapper scripts.

1 # Copyright 1999-2009 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.67 2009/11/28 18:39:27 arfrever Exp $
4
5 # @ECLASS: distutils.eclass
6 # @MAINTAINER:
7 # <python@gentoo.org>
8 #
9 # Original author: Jon Nelson <jnelson@gentoo.org>
10 # @BLURB: This eclass allows easier installation of distutils-based python modules
11 # @DESCRIPTION:
12 # The distutils eclass is designed to allow easier installation of
13 # distutils-based python modules and their incorporation into
14 # the Gentoo Linux system.
15
16 inherit eutils multilib python
17
18 case "${EAPI:-0}" in
19 0|1)
20 EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
21 ;;
22 *)
23 EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
24 ;;
25 esac
26
27 if [[ -z "${DISTUTILS_DISABLE_PYTHON_DEPENDENCY}" ]]; then
28 DEPEND="virtual/python"
29 RDEPEND="${DEPEND}"
30 fi
31
32 if has "${EAPI:-0}" 0 1 2; then
33 python="python"
34 else
35 python="die"
36 fi
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.
67 distutils_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.
81 distutils_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.
114 distutils_src_compile() {
115 if [[ "${EBUILD_PHASE}" != "compile" ]]; then
116 die "${FUNCNAME}() can be used only in src_compile() phase"
117 fi
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 python_version
143 echo "$(PYTHON "${PYVER}")" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
144 "$(PYTHON "${PYVER}")" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
145 fi
146 }
147
148 # @FUNCTION: distutils_src_install
149 # @DESCRIPTION:
150 # The distutils src_install function, this function is exported.
151 # In newer EAPIs this function calls distutils_src_install_pre_hook() and
152 # distutils_src_install_post_hook(), if they are defined.
153 # It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
154 # PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS)
155 distutils_src_install() {
156 if [[ "${EBUILD_PHASE}" != "install" ]]; then
157 die "${FUNCNAME}() can be used only in src_install() phase"
158 fi
159
160 local pylibdir
161
162 # Mark the package to be rebuilt after a python upgrade.
163 python_need_rebuild
164
165 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
166 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
167 declare -A wrapper_scripts=()
168
169 rename_scripts_with_versioned_shebangs() {
170 if [[ -d "${D}usr/bin" ]]; then
171 cd "${D}usr/bin"
172
173 local file
174 for file in *; do
175 if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]]+$ && "$(head -n1 "${file}")" =~ ^'#!'.*python[[:digit:]]+\.[[:digit:]]+ ]]; then
176 mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
177 wrapper_scripts+=(["${D}usr/bin/${file}"]=)
178 fi
179 done
180 fi
181 }
182 fi
183
184 if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
185 installation() {
186 _distutils_hook pre
187
188 # need this for python-2.5 + setuptools in cases where
189 # a package uses distutils but does not install anything
190 # in site-packages. (eg. dev-java/java-config-2.x)
191 # - liquidx (14/08/2006)
192 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
193 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
194
195 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
196 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || return "$?"
197
198 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
199 rename_scripts_with_versioned_shebangs
200 fi
201
202 _distutils_hook post
203 }
204 python_execute_function -s installation "$@"
205 else
206 installation() {
207 _distutils_hook pre
208
209 # need this for python-2.5 + setuptools in cases where
210 # a package uses distutils but does not install anything
211 # in site-packages. (eg. dev-java/java-config-2.x)
212 # - liquidx (14/08/2006)
213 pylibdir="$("$(PYTHON)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
214 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
215
216 echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
217 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@" || return "$?"
218
219 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
220 rename_scripts_with_versioned_shebangs
221 fi
222
223 _distutils_hook post
224 }
225 python_execute_function installation "$@"
226 fi
227
228 if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne "0" && "${BASH_VERSINFO[0]}" -ge "4" ]]; then
229 python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
230 fi
231 unset wrapper_scripts
232 else
233 # need this for python-2.5 + setuptools in cases where
234 # a package uses distutils but does not install anything
235 # in site-packages. (eg. dev-java/java-config-2.x)
236 # - liquidx (14/08/2006)
237 pylibdir="$("$(PYTHON "${PYVER}")" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
238 [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
239
240 echo "$(PYTHON "${PYVER}")" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
241 "$(PYTHON "${PYVER}")" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
242 fi
243
244 if [[ -e "${D}usr/local" ]]; then
245 die "Illegal installation into /usr/local"
246 fi
247
248 local default_docs
249 default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
250
251 local doc
252 for doc in ${default_docs}; do
253 [[ -s "${doc}" ]] && dodoc "${doc}"
254 done
255
256 if [[ -n "${DOCS}" ]]; then
257 dodoc ${DOCS} || die "dodoc failed"
258 fi
259 }
260
261 # @FUNCTION: distutils_pkg_postinst
262 # @DESCRIPTION:
263 # This is a generic optimization, you should override it if your package
264 # installs modules in another directory. This function is exported.
265 distutils_pkg_postinst() {
266 if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
267 die "${FUNCNAME}() can be used only in pkg_postinst() phase"
268 fi
269
270 local pylibdir pymod
271 if [[ -z "${PYTHON_MODNAME}" ]]; then
272 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
273 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
274 PYTHON_MODNAME="${PN}"
275 fi
276 done
277 fi
278
279 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
280 python_mod_optimize ${PYTHON_MODNAME}
281 else
282 for pymod in ${PYTHON_MODNAME}; do
283 python_mod_optimize "$(python_get_sitedir)/${pymod}"
284 done
285 fi
286 }
287
288 # @FUNCTION: distutils_pkg_postrm
289 # @DESCRIPTION:
290 # Generic pyc/pyo cleanup script. This function is exported.
291 distutils_pkg_postrm() {
292 if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
293 die "${FUNCNAME}() can be used only in pkg_postrm() phase"
294 fi
295
296 local pylibdir pymod
297 if [[ -z "${PYTHON_MODNAME}" ]]; then
298 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
299 if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
300 PYTHON_MODNAME="${PN}"
301 fi
302 done
303 fi
304
305 if [[ -n "${PYTHON_MODNAME}" ]]; then
306 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
307 python_mod_cleanup ${PYTHON_MODNAME}
308 else
309 for pymod in ${PYTHON_MODNAME}; do
310 for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
311 if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
312 python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
313 fi
314 done
315 done
316 fi
317 else
318 python_mod_cleanup
319 fi
320 }
321
322 # @FUNCTION: distutils_python_version
323 # @DESCRIPTION:
324 # Calls python_version, so that you can use something like
325 # e.g. insinto ${ROOT}/usr/include/python${PYVER}
326 distutils_python_version() {
327 if ! has "${EAPI:-0}" 0 1 2; then
328 die "${FUNCNAME}() cannot be used in this EAPI"
329 fi
330
331 python_version
332 }
333
334 # @FUNCTION: distutils_python_tkinter
335 # @DESCRIPTION:
336 # Checks for if tkinter support is compiled into python
337 distutils_python_tkinter() {
338 if ! has "${EAPI:-0}" 0 1 2; then
339 die "${FUNCNAME}() cannot be used in this EAPI"
340 fi
341
342 python_tkinter_exists
343 }

  ViewVC Help
Powered by ViewVC 1.1.20