gentoo-x86/eclass/distutils.eclass

# Copyright 1999-2009 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.56 2009/08/01 22:36:20 arfrever 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() {
        if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                build_modules() {
                        echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@"
                        "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@"
                }
                python_execute_function build_modules "$@"
        else
                ${python} setup.py build "$@" || die "compilation failed"
        fi
}

# @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

        if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                install_modules() {
                        # 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="$("$(get_python)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
                        [[ -n "${pylibdir}" ]] && dodir "${pylibdir}"

                        echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
                        "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
                }
                python_execute_function install_modules "$@"
        else
                # 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}"

                ${python} setup.py install --root="${D}" --no-compile "$@" || die "python setup.py install failed"
        fi

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

        local doc
        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 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

        ebegin "Performing cleanup of Python modules..."
        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
                                        if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                                                python_mod_cleanup "${pymod}"
                                        else
                                                python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
                                        fi
                                fi
                        done
                done
        else
                python_mod_cleanup
        fi
        eend 0
}

# @FUNCTION: distutils_pkg_postinst
# @DESCRIPTION:
# This is a generic optimization, you should override it if your package
# installs modules 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 "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                for pymod in ${PYTHON_MODNAME}; do
                        python_mod_optimize "${pymod}"
                done
        else
                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	arfrever	1.56	# Copyright 1999-2009 Gentoo Foundation
2	vapier	1.4	# Distributed under the terms of the GNU General Public License v2
3	arfrever	1.57	# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.56 2009/08/01 22:36:20 arfrever 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	arfrever	1.56	has "${EAPI:-0}" 0 1 && distutils_src_prepare
56	pva	1.55	}
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	arfrever	1.56	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
73			build_modules() {
74	arfrever	1.57	echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@"
75			"$(get_python)" setup.py build -b "build-${PYTHON_ABI}" "$@"
76	arfrever	1.56	}
77			python_execute_function build_modules "$@"
78			else
79			${python} setup.py build "$@" \|\| die "compilation failed"
80			fi
81	jnelson	1.1	}
82
83	dev-zero	1.46	# @FUNCTION: distutils_src_install
84			# @DESCRIPTION:
85			# The distutils src_install function, this function is exported.
86			# It also installs the "standard docs" (CHANGELOG, Change*, KNOWN_BUGS, MAINTAINERS,
87			# PKG-INFO, CONTRIBUTORS, TODO, NEWS, MANIFEST, README, and AUTHORS)
88	jnelson	1.1	distutils_src_install() {
89	liquidx	1.33
90	hawking	1.53	# Mark the package to be rebuilt after a python upgrade.
91			python_need_rebuild
92
93	arfrever	1.56	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
94			install_modules() {
95			# need this for python-2.5 + setuptools in cases where
96			# a package uses distutils but does not install anything
97			# in site-packages. (eg. dev-java/java-config-2.x)
98			# - liquidx (14/08/2006)
99	arfrever	1.57	pylibdir="$("$(get_python)" -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
100	arfrever	1.56	[[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
101
102	arfrever	1.57	echo "$(get_python)" setup.py build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
103			"$(get_python)" setup.py build -b "build-${PYTHON_ABI}" install --root="${D}" --no-compile "$@"
104	arfrever	1.56	}
105			python_execute_function install_modules "$@"
106	liquidx	1.18	else
107	arfrever	1.56	# need this for python-2.5 + setuptools in cases where
108			# a package uses distutils but does not install anything
109			# in site-packages. (eg. dev-java/java-config-2.x)
110			# - liquidx (14/08/2006)
111			pylibdir="$(${python} -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
112			[[ -n "${pylibdir}" ]] && dodir "${pylibdir}"
113
114			${python} setup.py install --root="${D}" --no-compile "$@" \|\| die "python setup.py install failed"
115	swegener	1.28	fi
116	lanius	1.20
117	betelgeuse	1.39	DDOCS="CHANGELOG KNOWN_BUGS MAINTAINERS PKG-INFO CONTRIBUTORS TODO NEWS"
118	dev-zero	1.43	DDOCS="${DDOCS} Change* MANIFEST* README* AUTHORS"
119	lanius	1.20
120	arfrever	1.56	local doc
121	lanius	1.20	for doc in ${DDOCS}; do
122	arfrever	1.56	[[ -s "$doc" ]] && dodoc $doc
123	lanius	1.20	done
124
125	arfrever	1.56	[[ -n "${DOCS}" ]] && dodoc ${DOCS}
126	jnelson	1.1	}
127	kutsuya	1.6
128	dev-zero	1.46	# @FUNCTION: distutils_pkg_postrm
129			# @DESCRIPTION:
130			# Generic pyc/pyo cleanup script. This function is exported.
131	liquidx	1.19	distutils_pkg_postrm() {
132	arfrever	1.56	local pylibdir pymod
133	hawking	1.54	if [[ -z "${PYTHON_MODNAME}" ]]; then
134			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
135	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
136			PYTHON_MODNAME="${PN}"
137	hawking	1.54	fi
138			done
139	hawking	1.49	fi
140	liquidx	1.19
141	arfrever	1.56	ebegin "Performing cleanup of Python modules..."
142			if [[ -n "${PYTHON_MODNAME}" ]]; then
143			for pymod in ${PYTHON_MODNAME}; do
144			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
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	hawking	1.54	fi
151	arfrever	1.56	fi
152	liquidx	1.19	done
153	arfrever	1.56	done
154			else
155			python_mod_cleanup
156	swegener	1.28	fi
157	arfrever	1.56	eend 0
158	liquidx	1.19	}
159
160	dev-zero	1.46	# @FUNCTION: distutils_pkg_postinst
161			# @DESCRIPTION:
162			# This is a generic optimization, you should override it if your package
163	arfrever	1.56	# installs modules in another directory. This function is exported.
164	liquidx	1.19	distutils_pkg_postinst() {
165	hawking	1.54	local pylibdir pymod
166			if [[ -z "${PYTHON_MODNAME}" ]]; then
167			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
168	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
169			PYTHON_MODNAME="${PN}"
170	hawking	1.54	fi
171			done
172	hawking	1.50	fi
173	swegener	1.28
174	arfrever	1.56	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
175			for pymod in ${PYTHON_MODNAME}; do
176			python_mod_optimize "${pymod}"
177			done
178			else
179	liquidx	1.19	python_version
180	marienz	1.30	for pymod in ${PYTHON_MODNAME}; do
181	arfrever	1.56	python_mod_optimize "/usr/$(get_libdir)/python${PYVER}/site-packages/${pymod}"
182	swegener	1.28	done
183			fi
184	liquidx	1.19	}
185
186	dev-zero	1.46	# @FUNCTION: distutils_python_version
187			# @DESCRIPTION:
188			# Calls python_version, so that you can use something like
189			# e.g. insinto ${ROOT}/usr/include/python${PYVER}
190	liquidx	1.13	distutils_python_version() {
191	liquidx	1.34	python_version
192	liquidx	1.12	}
193
194	dev-zero	1.46	# @FUNCTION: distutils_python_tkinter
195			# @DESCRIPTION:
196			# Checks for if tkinter support is compiled into python
197	liquidx	1.12	distutils_python_tkinter() {
198	lucass	1.40	python_tkinter_exists
199	vapier	1.8	}