gentoo-x86/eclass/distutils.eclass

# Copyright 1999-2008 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.54 2008/10/28 21:29:28 hawking Exp $

# @ECLASS: distutils.eclass
# @MAINTAINER:
# <python@gentoo.org>
#
# Original author: Jon Nelson <jnelson@gentoo.org>
# @BLURB: This eclass allows easier installation of distutils-based python modules
# @DESCRIPTION:
# The distutils eclass is designed to allow easier installation of
# distutils-based python modules and their incorporation into
# the Gentoo Linux system.
#
# It inherits python, multilib, and eutils

inherit python multilib eutils

case "${EAPI:-0}" in
        0|1)
                EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
                ;;
        *)
                EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
                ;;
esac

# @ECLASS-VARIABLE: PYTHON_SLOT_VERSION
# @DESCRIPTION:
# This helps make it possible to add extensions to python slots.
# Normally only a -py21- ebuild would set PYTHON_SLOT_VERSION.
if [ "${PYTHON_SLOT_VERSION}" = "2.1" ] ; then
        DEPEND="=dev-lang/python-2.1*"
        python="python2.1"
elif [ "${PYTHON_SLOT_VERSION}" = "2.3" ] ; then
        DEPEND="=dev-lang/python-2.3*"
        python="python2.3"
else
        DEPEND="virtual/python"
        python="python"
fi

# @ECLASS-VARIABLE: DOCS
# @DESCRIPTION:
# Additional DOCS

# @FUNCTION: distutils_src_unpack
# @DESCRIPTION:
# The distutils src_unpack function, this function is exported
distutils_src_unpack() {
        unpack ${A}
        cd "${S}"

        has ${EAPI:-0} 0 1 && distutils_src_prepare
}

# @FUNCTION: distutils_src_prepare
# @DESCRIPTION:
# The distutils src_prepare function, this function is exported
distutils_src_prepare() {
        # remove ez_setup stuff to prevent packages
        # from installing setuptools on their own
        rm -rf ez_setup*
        echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py
}

# @FUNCTION: distutils_src_compile
# @DESCRIPTION:
# The distutils src_compile function, this function is exported
distutils_src_compile() {
        ${python} setup.py build "$@" || die "compilation failed"
}

# @FUNCTION: distutils_src_install
# @DESCRIPTION:
# The distutils src_install function, this function is exported.
# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST*, README*, and AUTHORS)
distutils_src_install() {

        # Mark the package to be rebuilt after a python upgrade.
        python_need_rebuild

        # need this for python-2.5 + setuptools in cases where
        # a package uses distutils but does not install anything
        # in site-packages. (eg. dev-java/java-config-2.x)
        # - liquidx (14/08/2006)
        pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print get_python_lib()')"
        [ -n "${pylibdir}" ] && dodir "${pylibdir}"

        if has_version ">=dev-lang/python-2.3"; then
                ${python} setup.py install --root="${D}" --no-compile "$@" ||\
                        die "python setup.py install failed"
        else
                ${python} setup.py install --root="${D}" "$@" ||\
                        die "python setup.py install failed"
        fi

        DDOCS="CHANGELOG KNOWN_BUGS MAINTAINERS PKG-INFO CONTRIBUTORS TODO NEWS"
        DDOCS="${DDOCS} Change* MANIFEST* README* AUTHORS"

        for doc in ${DDOCS}; do
                [ -s "$doc" ] && dodoc $doc
        done

        [ -n "${DOCS}" ] && dodoc ${DOCS}
}

# @FUNCTION: distutils_pkg_postrm
# @DESCRIPTION:
# Generic pyc/pyo cleanup script. This function is exported.
distutils_pkg_postrm() {
        local moddir pylibdir pymod
        if [[ -z "${PYTHON_MODNAME}" ]]; then
                for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
                        if [[ -d "${pylibdir}"/site-packages/${PN} ]]; then
                                PYTHON_MODNAME=${PN}
                        fi
                done
        fi

        if has_version ">=dev-lang/python-2.3"; then
                ebegin "Performing Python Module Cleanup .."
                if [[ -n "${PYTHON_MODNAME}" ]]; then
                        for pymod in ${PYTHON_MODNAME}; do
                                for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
                                        if [[ -d "${pylibdir}"/site-packages/${pymod} ]]; then
                                                python_mod_cleanup "${pylibdir#${ROOT}}"/site-packages/${pymod}
                                        fi
                                done
                        done
                else
                        python_mod_cleanup
                fi
                eend 0
        fi
}

# @FUNCTION: distutils_pkg_postinst
# @DESCRIPTION:
# This is a generic optimization, you should override it if your package
# installs things in another directory. This function is exported
distutils_pkg_postinst() {
        local pylibdir pymod
        if [[ -z "${PYTHON_MODNAME}" ]]; then
                for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
                        if [[ -d "${pylibdir}"/site-packages/${PN} ]]; then
                                PYTHON_MODNAME=${PN}
                        fi
                done
        fi

        if has_version ">=dev-lang/python-2.3"; then
                python_version
                for pymod in ${PYTHON_MODNAME}; do
                        python_mod_optimize \
                                /usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}
                done
        fi
}

# @FUNCTION: distutils_python_version
# @DESCRIPTION:
# Calls python_version, so that you can use something like
#  e.g. insinto ${ROOT}/usr/include/python${PYVER}
distutils_python_version() {
        python_version
}

# @FUNCTION: distutils_python_tkinter
# @DESCRIPTION:
# Checks for if tkinter support is compiled into python
distutils_python_tkinter() {
        python_tkinter_exists
}
1	dev-zero	1.46	# Copyright 1999-2008 Gentoo Foundation
2	vapier	1.4	# Distributed under the terms of the GNU General Public License v2
3	pva	1.55	# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.54 2008/10/28 21:29:28 hawking Exp $
4	dev-zero	1.46
5			# @ECLASS: distutils.eclass
6			# @MAINTAINER:
7	hawking	1.48	# <python@gentoo.org>
8	vapier	1.5	#
9	dev-zero	1.46	# Original author: Jon Nelson <jnelson@gentoo.org>
10			# @BLURB: This eclass allows easier installation of distutils-based python modules
11			# @DESCRIPTION:
12	jnelson	1.1	# The distutils eclass is designed to allow easier installation of
13	swegener	1.28	# distutils-based python modules and their incorporation into
14	jnelson	1.1	# the Gentoo Linux system.
15	liquidx	1.12	#
16	dev-zero	1.46	# It inherits python, multilib, and eutils
17	jnelson	1.1
18	kloeri	1.37	inherit python multilib eutils
19	liquidx	1.16
20	pva	1.55	case "${EAPI:-0}" in
21			0\|1)
22			EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
23			;;
24			*)
25			EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
26			;;
27			esac
28
29	dev-zero	1.46	# @ECLASS-VARIABLE: PYTHON_SLOT_VERSION
30			# @DESCRIPTION:
31	kutsuya	1.6	# This helps make it possible to add extensions to python slots.
32	kutsuya	1.9	# Normally only a -py21- ebuild would set PYTHON_SLOT_VERSION.
33	radek	1.31	if [ "${PYTHON_SLOT_VERSION}" = "2.1" ] ; then
34	mr_bones_	1.23	DEPEND="=dev-lang/python-2.1*"
35	kutsuya	1.6	python="python2.1"
36	radek	1.31	elif [ "${PYTHON_SLOT_VERSION}" = "2.3" ] ; then
37			DEPEND="=dev-lang/python-2.3*"
38			python="python2.3"
39	kutsuya	1.6	else
40	mr_bones_	1.23	DEPEND="virtual/python"
41	kutsuya	1.6	python="python"
42			fi
43	jnelson	1.1
44	dev-zero	1.46	# @ECLASS-VARIABLE: DOCS
45			# @DESCRIPTION:
46			# Additional DOCS
47
48			# @FUNCTION: distutils_src_unpack
49			# @DESCRIPTION:
50			# The distutils src_unpack function, this function is exported
51	lucass	1.41	distutils_src_unpack() {
52			unpack ${A}
53			cd "${S}"
54
55	pva	1.55	has ${EAPI:-0} 0 1 && distutils_src_prepare
56			}
57
58			# @FUNCTION: distutils_src_prepare
59			# @DESCRIPTION:
60			# The distutils src_prepare function, this function is exported
61			distutils_src_prepare() {
62	lucass	1.41	# remove ez_setup stuff to prevent packages
63			# from installing setuptools on their own
64			rm -rf ez_setup*
65	hawking	1.42	echo "def use_setuptools(args, *kwargs): pass" > ez_setup.py
66	lucass	1.41	}
67
68	dev-zero	1.46	# @FUNCTION: distutils_src_compile
69			# @DESCRIPTION:
70			# The distutils src_compile function, this function is exported
71	jnelson	1.1	distutils_src_compile() {
72	liquidx	1.15	${python} setup.py build "$@" \|\| die "compilation failed"
73	jnelson	1.1	}
74
75	dev-zero	1.46	# @FUNCTION: distutils_src_install
76			# @DESCRIPTION:
77			# The distutils src_install function, this function is exported.
78			# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
79			# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST, README, and AUTHORS)
80	jnelson	1.1	distutils_src_install() {
81	liquidx	1.33
82	hawking	1.53	# Mark the package to be rebuilt after a python upgrade.
83			python_need_rebuild
84
85	liquidx	1.33	# need this for python-2.5 + setuptools in cases where
86			# a package uses distutils but does not install anything
87			# in site-packages. (eg. dev-java/java-config-2.x)
88			# - liquidx (14/08/2006)
89			pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print get_python_lib()')"
90			[ -n "${pylibdir}" ] && dodir "${pylibdir}"
91	swegener	1.36
92	liquidx	1.18	if has_version ">=dev-lang/python-2.3"; then
93	hawking	1.52	${python} setup.py install --root="${D}" --no-compile "$@" \|\|\
94			die "python setup.py install failed"
95	liquidx	1.18	else
96	hawking	1.52	${python} setup.py install --root="${D}" "$@" \|\|\
97			die "python setup.py install failed"
98	swegener	1.28	fi
99	lanius	1.20
100	betelgeuse	1.39	DDOCS="CHANGELOG KNOWN_BUGS MAINTAINERS PKG-INFO CONTRIBUTORS TODO NEWS"
101	dev-zero	1.43	DDOCS="${DDOCS} Change* MANIFEST* README* AUTHORS"
102	lanius	1.20
103			for doc in ${DDOCS}; do
104			[ -s "$doc" ] && dodoc $doc
105			done
106
107	liquidx	1.12	[ -n "${DOCS}" ] && dodoc ${DOCS}
108	jnelson	1.1	}
109	kutsuya	1.6
110	dev-zero	1.46	# @FUNCTION: distutils_pkg_postrm
111			# @DESCRIPTION:
112			# Generic pyc/pyo cleanup script. This function is exported.
113	liquidx	1.19	distutils_pkg_postrm() {
114	hawking	1.54	local moddir pylibdir pymod
115			if [[ -z "${PYTHON_MODNAME}" ]]; then
116			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
117			if [[ -d "${pylibdir}"/site-packages/${PN} ]]; then
118			PYTHON_MODNAME=${PN}
119			fi
120			done
121	hawking	1.49	fi
122	liquidx	1.19
123			if has_version ">=dev-lang/python-2.3"; then
124			ebegin "Performing Python Module Cleanup .."
125	hawking	1.54	if [[ -n "${PYTHON_MODNAME}" ]]; then
126	liquidx	1.22	for pymod in ${PYTHON_MODNAME}; do
127	hawking	1.54	for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
128			if [[ -d "${pylibdir}"/site-packages/${pymod} ]]; then
129			python_mod_cleanup "${pylibdir#${ROOT}}"/site-packages/${pymod}
130			fi
131	liquidx	1.19	done
132			done
133			else
134			python_mod_cleanup
135	swegener	1.28	fi
136	liquidx	1.19	eend 0
137	swegener	1.28	fi
138	liquidx	1.19	}
139
140	dev-zero	1.46	# @FUNCTION: distutils_pkg_postinst
141			# @DESCRIPTION:
142			# This is a generic optimization, you should override it if your package
143			# installs things in another directory. This function is exported
144	liquidx	1.19	distutils_pkg_postinst() {
145	hawking	1.54	local pylibdir pymod
146			if [[ -z "${PYTHON_MODNAME}" ]]; then
147			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
148			if [[ -d "${pylibdir}"/site-packages/${PN} ]]; then
149			PYTHON_MODNAME=${PN}
150			fi
151			done
152	hawking	1.50	fi
153	swegener	1.28
154	liquidx	1.19	if has_version ">=dev-lang/python-2.3"; then
155			python_version
156	marienz	1.30	for pymod in ${PYTHON_MODNAME}; do
157	hawking	1.47	python_mod_optimize \
158			/usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}
159	swegener	1.28	done
160			fi
161	liquidx	1.19	}
162
163	dev-zero	1.46	# @FUNCTION: distutils_python_version
164			# @DESCRIPTION:
165			# Calls python_version, so that you can use something like
166			# e.g. insinto ${ROOT}/usr/include/python${PYVER}
167	liquidx	1.13	distutils_python_version() {
168	liquidx	1.34	python_version
169	liquidx	1.12	}
170
171	dev-zero	1.46	# @FUNCTION: distutils_python_tkinter
172			# @DESCRIPTION:
173			# Checks for if tkinter support is compiled into python
174	liquidx	1.12	distutils_python_tkinter() {
175	lucass	1.40	python_tkinter_exists
176	vapier	1.8	}