Add a new Python-distutils eclass for Python, distutils-based packages.

2 files changed, 389 insertions, 0 deletions

diff --git a/eclass/python-distutils-ng.eclass b/eclass/python-distutils-ng.eclass
new file mode 100644
index 0000000..880b525
--- /dev/null
+++ b/eclass/python-distutils-ng.eclass
@@ -0,0 +1,375 @@
+# Copyright 1999-2012 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+# $Header$
+
+# @ECLASS: python-distutils-ng
+# @MAINTAINER:
+# Python herd <python@gentoo.org>
+# @AUTHOR:
+# Author: Krzysztof Pawlik <nelchael@gentoo.org>
+# @BLURB: An eclass for installing Python packages using distutils with proper
+# support for multiple Python slots.
+# @DESCRIPTION:
+# The Python eclass is designed to allow an easier installation of Python
+# packages and their incorporation into the Gentoo Linux system.
+#
+# TODO: Document implementations!
+
+# @ECLASS-VARIABLE: USE_PYTHON
+# @DESCRIPTION:
+# This variable contains a space separated list of targets (see above) a package
+# is compatible to. It must be set before the `inherit' call. The default is to
+# enable all targets.
+
+if [[ -z "${USE_PYTHON}" ]]; then
+	# Default: pure python, support all implementations
+	USE_PYTHON="  python25 python26 python27"
+	USE_PYTHON+=" python31 python32"
+	USE_PYTHON+=" jython25"
+	USE_PYTHON+=" pypy17 pypy18"
+fi
+
+# @ECLASS-VARIABLE: PYTHON_OPTIONAL
+# @DESCRIPTION:
+# Set the value to "yes" to make the dependency on a Python interpreter
+# optional.
+
+# @ECLASS-VARIABLE: PYTHON_DISABLE_COMPILATION
+# @DESCRIPTION:
+# Set the value to "yes" to skip compilation and/or optimization of Python
+# modules.
+
+EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_test src_install
+
+case "${EAPI}" in
+	0|1|2|3)
+		die "Unsupported EAPI=${EAPI} (too old) for python-distutils-ng.eclass" ;;
+	4)
+		# EAPI=4 needed for REQUIRED_USE
+		S="${S:-${WORKDIR}/${P}}"
+		;;
+	*)
+		die "Unsupported EAPI=${EAPI} (unknown) for python-distutils-ng.eclass" ;;
+esac
+
+# @FUNCTION: _python-distutils-ng_generate_depend
+# @USAGE: implementation
+# @RETURN: Package atom of a Python implementation for *DEPEND.
+# @DESCRIPTION:
+# This function returns the full package atom of a Python implementation.
+#
+# `implementation' has to be one of the valid values for USE_PYTHON.
+_python-distutils-ng_generate_depend() {
+	case "${1}" in
+		python??)
+			echo "dev-lang/${1::-2}:${1: -2:-1}.${1: -1}" ;;
+		jython??)
+			echo "dev-java/${1::-2}:${1: -2:-1}.${1: -1}" ;;
+		pypy??)
+			echo "dev-python/${1::-2}:${1: -2:-1}.${1: -1}" ;;
+		*)
+			die "Unsupported implementation: ${1}" ;;
+	esac
+}
+
+# @FUNCTION: _python-distutils-ng_get_binary_for_implementation
+# @USAGE: implementation
+# @RETURN: Full path to Python binary for given implementation.
+# @DESCRIPTION:
+# This function returns full path for Python binary for given implementation.
+#
+# Binary returned by this function should be used instead of simply calling
+# `python'.
+_python-distutils-ng_get_binary_for_implementation() {
+	case "${1}" in
+		python??|jython??)
+			echo "/usr/bin/${1::-1}.${1: -1}" ;;
+		pypy??)
+			echo "TODO" ;;
+		*)
+			die "Unsupported implementation: ${1}" ;;
+	esac
+}
+
+required_use_str=" || (
+	python_targets_python25 python_targets_python26 python_targets_python27
+	python_targets_python31 python_targets_python32
+	python_targets_jython25
+	python_targets_pypy17 python_targets_pypy18 )"
+if [[ "${PYTHON_OPTIONAL}" = "yes" ]]; then
+	IUSE+="python"
+	REQUIRED_USE+=" python? ( ${required_use_str} )"
+else
+	REQUIRED_USE+="${required_use_str}"
+fi
+
+for impl in ${USE_PYTHON}; do
+	IUSE+=" python_targets_${impl} "
+	local dep_str="python_targets_${impl}? ( $(_python-distutils-ng_generate_depend "${impl}") )"
+
+	if [[ "${PYTHON_OPTIONAL}" = "yes" ]]; then
+		RDEPEND="${RDEPEND} python? ( ${dep_str} )"
+		DEPEND="${DEPEND} python? ( ${dep_str} )"
+	else
+		RDEPEND="${RDEPEND} ${dep_str}"
+		DEPEND="${DEPEND} ${dep_str}"
+	fi
+done
+
+PACKAGE_SPECIFIC_S="${S#${WORKDIR}/}"
+
+# @FUNCTION: _python-distutils-ng_run_for_impl
+# @USAGE: implementation command_to_run
+# @DESCRIPTION:
+# Run command_to_run using specified Python implementation.
+#
+# This will run the command_to_run in implementation-specific working directory.
+_python-distutils-ng_run_for_impl() {
+	local impl="${1}"
+	local command="${2}"
+
+	S="${WORKDIR}/impl_${impl}/${PACKAGE_SPECIFIC_S}"
+	PYTHON="$(_python-distutils-ng_get_binary_for_implementation "${impl}")"
+
+	einfo "Running ${command} in ${S} for ${impl}"
+
+	pushd "${S}" &> /dev/null
+	"${command}" "${impl}" "${PYTHON}"
+	popd &> /dev/null
+}
+
+# @FUNCTION: _python-distutils-ng_run_for_all_impls
+# @USAGE: command_to_run
+# @DESCRIPTION:
+# Run command_to_run for all enabled Python implementations.
+#
+# See also _python-distutils-ng_run_for_impl
+_python-distutils-ng_run_for_all_impls() {
+	local command="${1}"
+
+	for impl in ${USE_PYTHON}; do
+		use "python_targets_${impl}" ${USE_PYTHON} || continue
+		_python-distutils-ng_run_for_impl "${impl}" "${command}"
+	done
+}
+
+# @FUNCTION: _python-distutils-ng_default_distutils_compile
+# @DESCRIPTION:
+# Default src_compile for distutils-based packages.
+_python-distutils-ng_default_distutils_compile() {
+	"${PYTHON}" setup.py build || die
+}
+
+# @FUNCTION: _python-distutils-ng_default_distutils_install
+# @DESCRIPTION:
+# Default src_install for distutils-based packages.
+_python-distutils-ng_default_distutils_install() {
+	"${PYTHON}" setup.py install --no-compile --root="${D}/" || die
+}
+
+# @FUNCTION: _python-distutils-ng_has_compileall
+# @USAGE: implementation
+# @RETURN: 0 if given implementation has compileall module
+# @DESCRIPTION:
+# This function is used to decide whenever to compile Python modules for given
+# implementation.
+_python-distutils-ng_has_compileall() {
+	case "${1}" in
+		python??|jython??)
+			return 0 ;;
+		*)
+			return 1 ;;
+	esac
+}
+
+# @FUNCTION: _python-distutils-ng_has_compileall_opt
+# @USAGE: implementation
+# @RETURN: 0 if given implementation has compileall module and supports # optimizations
+# @DESCRIPTION:
+# This function is used to decide whenever to compile and optimize Python
+# modules for given implementation.
+_python-distutils-ng_has_compileall_opt() {
+	case "${1}" in
+		python??)
+			return 0 ;;
+		*)
+			return 1 ;;
+	esac
+}
+
+# @FUNCTION: python-distutils-ng_doscript
+# @USAGE: script_file_name
+# @DESCRIPTION:
+# Install given script file in /usr/bin/ for all enabled implementations using
+# original script name as a base name.
+#
+# See also python-distutils-ng_newscript
+python-distutils-ng_doscript() {
+	python-distutils-ng_newscript "${1}" "$(basename "${1}")"
+}
+
+# @FUNCTION: python-distutils-ng_newscript
+# @USAGE: script_file_name new_file_name
+# @DESCRIPTION:
+# Install given script file in /usr/bin/ for all enabled implementations using
+# new_file_name as a base name.
+#
+# Each script copy will have the name mangled to "new_file_name-IMPLEMENTATION"
+# and new hash-bang line will be inserted to reference specific Python
+# interpreter.
+#
+# There will be also a symlink with name equal to new_file_name that will be a
+# symlink to default implementation, which defaults to value of
+# PYTHON_DEFAULT_IMPLEMENTATION, if not specified the function will pick default
+# implementation: it will the be first enabled from the following list:
+#   python27, python26, python25, python32, python31, pypy18, pypy17, jython25
+python-distutils-ng_newscript() {
+	[[ -n "${1}" ]] || die "Missing source file name"
+	[[ -n "${2}" ]] || die "Missing destination file name"
+	local source_file="${1}"
+	local destination_file="${2}"
+	local default_impl="${PYTHON_DEFAULT_IMPLEMENTATION}"
+
+	if [[ -z "${default_impl}" ]]; then
+		# TODO: Pick default implementation
+		for impl in python{27,26,25,32,21} pypy{18,17} jython25; do
+			use "python_targets_${impl}" || continue
+			default_impl="${impl}"
+			break;
+		done
+	else
+		use "python_targets_${impl}" || \
+			die "default implementation ${default_impl} not enabled"
+	fi
+
+	[[ -n "${default_impl}" ]] || die "Could not select default implementation"
+
+	einfo "Installing ${source_file} for multiple implementations (default: ${default_impl})"
+	insinto /usr/bin
+	for impl in ${USE_PYTHON}; do
+		use "python_targets_${impl}" ${USE_PYTHON} || continue
+
+		newins "${source_file}" "${destination_file}-${impl}"
+		fperms 755 "/usr/bin/${destination_file}-${impl}"
+		sed -i \
+			-e "1i#!$(_python-distutils-ng_get_binary_for_implementation "${impl}")" \
+			"${D}/usr/bin/${destination_file}-${impl}" || die
+	done
+
+	dosym "${destination_file}-${default_impl}" "/usr/bin/${destination_file}"
+}
+
+# Phase function: src_unpack
+python-distutils-ng_src_unpack() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	if type python_unpack &> /dev/null; then
+		# This should not run anything specific to any single Python
+		# implementation, keep it generic:
+		python_unpack_all
+	else
+		[[ -n ${A} ]] && unpack ${A}
+	fi
+}
+
+# Phase function: src_prepare
+python-distutils-ng_src_prepare() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	# Try to run binary for each implementation:
+	for impl in ${USE_PYTHON}; do
+		use "python_targets_${impl}" ${USE_PYTHON} || continue
+		$(_python-distutils-ng_get_binary_for_implementation "${impl}") \
+			-c "import sys" || die
+	done
+
+	# Run prepare shared by all implementations:
+	if type python_prepare_all &> /dev/null; then
+		einfo "Running python_prepare_all in ${S} for all"
+		python_prepare_all
+	fi
+
+	# Create a copy of S for each implementation:
+	for impl in ${USE_PYTHON}; do
+		use "python_targets_${impl}" ${USE_PYTHON} || continue
+
+		einfo "Creating copy for ${impl} in ${WORKDIR}/impl_${impl}"
+		mkdir -p "${WORKDIR}/impl_${impl}" || die
+		cp -pr "${S}" "${WORKDIR}/impl_${impl}/${PACKAGE_SPECIFIC_S}" || die
+	done
+
+	# Run python_prepare for each implementation:
+	if type python_prepare &> /dev/null; then
+		_python-distutils-ng_run_for_all_impls python_prepare
+	fi
+}
+
+# Phase function: src_configure
+python-distutils-ng_src_configure() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	if type python_configure &> /dev/null; then
+		_python-distutils-ng_run_for_all_impls python_configure
+	fi
+}
+
+# Phase function: src_compile
+python-distutils-ng_src_compile() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	if type python_compile &> /dev/null; then
+		_python-distutils-ng_run_for_all_impls python_compile
+	else
+		_python-distutils-ng_run_for_all_impls \
+			_python-distutils-ng_default_distutils_compile
+	fi
+}
+
+# Phase function: src_test
+python-distutils-ng_src_test() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	if type python_test &> /dev/null; then
+		_python-distutils-ng_run_for_all_impls python_test
+	fi
+}
+
+# Phase function: src_install
+python-distutils-ng_src_install() {
+	[[ "${PYTHON_OPTIONAL}" = "yes" ]] && { use python || return; }
+
+	if type python_install &> /dev/null; then
+		_python-distutils-ng_run_for_all_impls python_install
+	else
+		_python-distutils-ng_run_for_all_impls \
+			_python-distutils-ng_default_distutils_install
+	fi
+
+	S="${WORKDIR}/${PACKAGE_SPECIFIC_S}"
+	if type python_install_all &> /dev/null; then
+		einfo "Running python_install_all in ${S} for all"
+		python_install_all
+	fi
+
+	for impl in ${USE_PYTHON}; do
+		[[ "${PYTHON_DISABLE_COMPILATION}" = "yes" ]] && continue
+		use "python_targets_${impl}" ${USE_PYTHON} || continue
+
+		PYTHON="$(_python-distutils-ng_get_binary_for_implementation "${impl}")"
+		for accessible_path in $(${PYTHON} -c 'import sys; print " ".join(sys.path)'); do
+			[[ -d "${D}/${accessible_path}" ]] || continue
+
+			_python-distutils-ng_has_compileall "${impl}" || continue
+			ebegin "Compiling ${accessible_path} for ${impl}"
+			${PYTHON} \
+				-m compileall -q -f "${D}/${accessible_path}" || die
+			eend $?
+
+			_python-distutils-ng_has_compileall_opt "${impl}" || continue
+			ebegin "Optimizing ${accessible_path} for ${impl}"
+			PYTHONOPTIMIZE=1 ${PYTHON} \
+				-m compileall -q -f "${D}/${accessible_path}" || die
+			eend $?
+		done;
+	done
+}
diff --git a/profiles/desc/python_targets.desc b/profiles/desc/python_targets.desc
new file mode 100644
index 0000000..350fa10
--- /dev/null
+++ b/profiles/desc/python_targets.desc
@@ -0,0 +1,14 @@
+# Copyright 2009-2012 Gentoo Foundation.
+# Distributed under the terms of the GNU General Public License v2
+# $Header$
+
+# This file contains descriptions of PYTHON_TARGETS USE_EXPAND flags.
+
+python25 - Build with Python 2.5
+python26 - Build with Python 2.6
+python27 - Build with Python 2.7
+python31 - Build with Python 3.1
+python32 - Build with Python 3.2
+jython25 - Build with Jythin 2.5
+pypy17 - Build with PyPy 1.7
+pypy18 - Build with PyPy 1.8