gentoo-x86/eclass/distutils.eclass

# Copyright 1999-2010 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.72 2010/02/08 09:35:38 pva Exp $

# @ECLASS: distutils.eclass
# @MAINTAINER:
# Gentoo Python Project <python@gentoo.org>
#
# Original author: Jon Nelson <jnelson@gentoo.org>
# @BLURB: Eclass for packages with build systems using Distutils
# @DESCRIPTION:
# The distutils eclass defines phase functions for packages with build systems using Distutils.

inherit multilib python

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

if [[ -z "${PYTHON_DEPEND}" ]]; then
        DEPEND="dev-lang/python"
        RDEPEND="${DEPEND}"
fi

if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
        python="python"
else
        # Use "$(PYTHON)" instead of "${python}".
        python="die"
fi

# @ECLASS-VARIABLE: DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
# @DESCRIPTION:
# Set this to use separate source directories for each enabled version of Python.

# @ECLASS-VARIABLE: DISTUTILS_GLOBAL_OPTIONS
# @DESCRIPTION:
# Global options passed to setup.py.

# @ECLASS-VARIABLE: DISTUTILS_SRC_TEST
# @DESCRIPTION:
# Type of test command used by distutils_src_test().
# IUSE and DEPEND are automatically adjusted, unless DISTUTILS_DISABLE_TEST_DEPENDENCY is set.
# Valid values:
#   setup.py
#   nosetests
#   py.test
#   trial [arguments]

# @ECLASS-VARIABLE: DISTUTILS_DISABLE_TEST_DEPENDENCY
# @DESCRIPTION:
# Disable modification of IUSE and DEPEND caused by setting of DISTUTILS_SRC_TEST.

if [[ -n "${DISTUTILS_SRC_TEST}" && ! "${DISTUTILS_SRC_TEST}" =~ ^(setup\.py|nosetests|py\.test|trial(\ .*)?)$ ]]; then
        die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
fi

if [[ -z "${DISTUTILS_DISABLE_TEST_DEPENDENCY}" ]]; then
        if [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
                IUSE="test"
                DEPEND+="${DEPEND:+ }test? ( dev-python/nose )"
        elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
                IUSE="test"
                DEPEND+="${DEPEND:+ }test? ( dev-python/py )"
        # trial requires an argument, which is usually equal to "${PN}".
        elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
                IUSE="test"
                DEPEND+="${DEPEND:+ }test? ( dev-python/twisted )"
        fi
fi

if [[ -n "${DISTUTILS_SRC_TEST}" ]]; then
        EXPORT_FUNCTIONS src_test
fi

# @ECLASS-VARIABLE: DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS
# @DESCRIPTION:
# Set this to disable renaming of Python scripts containing versioned shebangs
# and generation of wrapper scripts.

# @ECLASS-VARIABLE: DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS
# @DESCRIPTION:
# List of paths to Python scripts, relative to ${D}, which are excluded from
# renaming and generation of wrapper scripts.

# @ECLASS-VARIABLE: DOCS
# @DESCRIPTION:
# Additional documentation files installed by distutils_src_install().

_distutils_get_build_dir() {
        if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
                echo "build-${PYTHON_ABI}"
        else
                echo "build"
        fi
}

_distutils_get_PYTHONPATH() {
        if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
                ls -d build-${PYTHON_ABI}/lib* 2> /dev/null
        else
                ls -d build/lib* 2> /dev/null
        fi
}

_distutils_hook() {
        if [[ "$#" -ne 1 ]]; then
                die "${FUNCNAME}() requires 1 argument"
        fi
        if [[ "$(type -t "distutils_src_${EBUILD_PHASE}_$1_hook")" == "function" ]]; then
                "distutils_src_${EBUILD_PHASE}_$1_hook"
        fi
}

# @FUNCTION: distutils_src_unpack
# @DESCRIPTION:
# The distutils src_unpack function. This function is exported.
distutils_src_unpack() {
        if ! has "${EAPI:-0}" 0 1; then
                die "${FUNCNAME}() cannot be used in this EAPI"
        fi

        if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
                die "${FUNCNAME}() can be used only in src_unpack() phase"
        fi

        unpack ${A}
        cd "${S}"

        distutils_src_prepare
}

# @FUNCTION: distutils_src_prepare
# @DESCRIPTION:
# The distutils src_prepare function. This function is exported.
distutils_src_prepare() {
        if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
                die "${FUNCNAME}() can be used only in src_prepare() phase"
        fi

        # Delete ez_setup files to prevent packages from installing Setuptools on their own.
        local ez_setup_existence="0"
        [[ -d ez_setup || -f ez_setup.py ]] && ez_setup_existence="1"
        rm -fr ez_setup*
        if [[ "${ez_setup_existence}" == "1" ]]; then
                echo "def use_setuptools(*args, **kwargs): pass" > ez_setup.py
        fi

        # Delete distribute_setup files to prevent packages from installing Distribute on their own.
        local distribute_setup_existence="0"
        [[ -d distribute_setup || -f distribute_setup.py ]] && distribute_setup_existence="1"
        rm -fr distribute_setup*
        if [[ "${distribute_setup_existence}" == "1" ]]; then
                echo "def use_setuptools(*args, **kwargs): pass" > distribute_setup.py
        fi

        if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
                python_copy_sources
        fi
}

# @FUNCTION: distutils_src_compile
# @DESCRIPTION:
# The distutils src_compile function. This function is exported.
# In ebuilds of packages supporting installation for multiple versions of Python, this function
# calls distutils_src_compile_pre_hook() and distutils_src_compile_post_hook(), if they are defined.
distutils_src_compile() {
        if [[ "${EBUILD_PHASE}" != "compile" ]]; then
                die "${FUNCNAME}() can be used only in src_compile() phase"
        fi

        _python_set_color_variables

        if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                distutils_building() {
                        _distutils_hook pre

                        echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@"${_NORMAL}
                        "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@" || return "$?"

                        _distutils_hook post
                }
                python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_building "$@"
        else
                echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"${_NORMAL}
                "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" || die "Building failed"
        fi
}

# @FUNCTION: distutils_src_test
# @DESCRIPTION:
# The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set.
distutils_src_test() {
        _python_set_color_variables

        if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
                if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                        distutils_testing() {
                                echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"${_NORMAL}
                                PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
                        }
                        python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
                else
                        echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@"${_NORMAL}
                        PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" || die "Testing failed"
                fi
        elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
                python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
        elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
                python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
        # trial requires an argument, which is usually equal to "${PN}".
        elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
                local trial_arguments
                if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
                        trial_arguments="${DISTUTILS_SRC_TEST#trial }"
                else
                        trial_arguments="${PN}"
                fi

                python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
        else
                die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
        fi
}

# @FUNCTION: distutils_src_install
# @DESCRIPTION:
# The distutils src_install function. This function is exported.
# In ebuilds of packages supporting installation for multiple versions of Python, this function
# calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
# It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
# KNOWN_BUGS, MAINTAINERS, MANIFEST*, NEWS, PKG-INFO, README*, TODO).
distutils_src_install() {
        if [[ "${EBUILD_PHASE}" != "install" ]]; then
                die "${FUNCNAME}() can be used only in src_install() phase"
        fi

        _python_set_color_variables

        if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
                        declare -A wrapper_scripts=()

                        rename_scripts_with_versioned_shebangs() {
                                if [[ -d "${D}usr/bin" ]]; then
                                        cd "${D}usr/bin"

                                        local nonversioned_file file
                                        for file in *; do
                                                if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]](-jython)?+$ && "$(head -n1 "${file}")" =~ ^'#!'.*(python|jython-)[[:digit:]]+\.[[:digit:]]+ ]]; then
                                                        for nonversioned_file in "${DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS[@]}"; do
                                                                [[ "${nonversioned_file}" == "/usr/bin/${file}" ]] && continue 2
                                                        done
                                                        mv "${file}" "${file}-${PYTHON_ABI}" || die "Renaming of '${file}' failed"
                                                        wrapper_scripts+=(["${D}usr/bin/${file}"]=)
                                                fi
                                        done
                                fi
                        }
                fi

                distutils_installation() {
                        _distutils_hook pre

                        echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@"${_NORMAL}
                        "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@" || return "$?"

                        if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
                                rename_scripts_with_versioned_shebangs
                        fi

                        _distutils_hook post
                }
                python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"

                if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
                        python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
                fi
                unset wrapper_scripts
        else
                # Mark the package to be rebuilt after a Python upgrade.
                python_need_rebuild

                echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"${_NORMAL}
                "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" || die "Installation failed"
        fi

        if [[ -e "${D}usr/local" ]]; then
                die "Illegal installation into /usr/local"
        fi

        local default_docs
        default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"

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

        if [[ -n "${DOCS}" ]]; then
                dodoc ${DOCS} || die "dodoc failed"
        fi
}

# @FUNCTION: distutils_pkg_postinst
# @DESCRIPTION:
# The distutils pkg_postinst function. This function is exported.
# When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
# name is equal to name of current package, if this module exists.
distutils_pkg_postinst() {
        if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
                die "${FUNCNAME}() can be used only in pkg_postinst() phase"
        fi

        local pylibdir pymod
        if [[ -z "${PYTHON_MODNAME}" ]]; then
                for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; 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
                python_mod_optimize ${PYTHON_MODNAME}
        else
                for pymod in ${PYTHON_MODNAME}; do
                        python_mod_optimize "$(python_get_sitedir)/${pymod}"
                done
        fi
}

# @FUNCTION: distutils_pkg_postrm
# @DESCRIPTION:
# The distutils pkg_postrm function. This function is exported.
# When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
# name is equal to name of current package, if this module exists.
distutils_pkg_postrm() {
        if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
                die "${FUNCNAME}() can be used only in pkg_postrm() phase"
        fi

        local pylibdir pymod
        if [[ -z "${PYTHON_MODNAME}" ]]; then
                for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; do
                        if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
                                PYTHON_MODNAME="${PN}"
                        fi
                done
        fi

        if [[ -n "${PYTHON_MODNAME}" ]]; then
                if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                        python_mod_cleanup ${PYTHON_MODNAME}
                else
                        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
                fi
        else
                python_mod_cleanup
        fi
}

# @FUNCTION: distutils_python_version
# @DESCRIPTION:
# Deprecated wrapper function for deprecated python_version().
distutils_python_version() {
        if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
                die "${FUNCNAME}() cannot be used in this EAPI"
        fi

        python_version
}

# @FUNCTION: distutils_python_tkinter
# @DESCRIPTION:
# Deprecated wrapper function for deprecated python_tkinter_exists().
distutils_python_tkinter() {
        if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
                die "${FUNCNAME}() cannot be used in this EAPI"
        fi

        python_tkinter_exists
}
1	arfrever	1.70	# Copyright 1999-2010 Gentoo Foundation
2	vapier	1.4	# Distributed under the terms of the GNU General Public License v2
3	arfrever	1.73	# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.72 2010/02/08 09:35:38 pva Exp $
4	dev-zero	1.46
5			# @ECLASS: distutils.eclass
6			# @MAINTAINER:
7	arfrever	1.70	# Gentoo Python Project <python@gentoo.org>
8	vapier	1.5	#
9	dev-zero	1.46	# Original author: Jon Nelson <jnelson@gentoo.org>
10	arfrever	1.70	# @BLURB: Eclass for packages with build systems using Distutils
11	dev-zero	1.46	# @DESCRIPTION:
12	arfrever	1.73	# The distutils eclass defines phase functions for packages with build systems using Distutils.
13	jnelson	1.1
14	pva	1.72	inherit multilib python
15	liquidx	1.16
16	pva	1.55	case "${EAPI:-0}" in
17			0\|1)
18			EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_postinst pkg_postrm
19			;;
20			*)
21	arfrever	1.73	EXPORT_FUNCTIONS src_prepare src_compile src_install pkg_postinst pkg_postrm
22	pva	1.55	;;
23			esac
24
25	arfrever	1.70	if [[ -z "${PYTHON_DEPEND}" ]]; then
26	arfrever	1.73	DEPEND="dev-lang/python"
27	arfrever	1.62	RDEPEND="${DEPEND}"
28			fi
29	arfrever	1.68
30	arfrever	1.73	if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
31	arfrever	1.68	python="python"
32			else
33	arfrever	1.73	# Use "$(PYTHON)" instead of "${python}".
34	arfrever	1.68	python="die"
35			fi
36	arfrever	1.60
37	arfrever	1.61	# @ECLASS-VARIABLE: DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
38			# @DESCRIPTION:
39			# Set this to use separate source directories for each enabled version of Python.
40
41	arfrever	1.60	# @ECLASS-VARIABLE: DISTUTILS_GLOBAL_OPTIONS
42	dev-zero	1.46	# @DESCRIPTION:
43	arfrever	1.60	# Global options passed to setup.py.
44	jnelson	1.1
45	arfrever	1.70	# @ECLASS-VARIABLE: DISTUTILS_SRC_TEST
46			# @DESCRIPTION:
47			# Type of test command used by distutils_src_test().
48			# IUSE and DEPEND are automatically adjusted, unless DISTUTILS_DISABLE_TEST_DEPENDENCY is set.
49			# Valid values:
50			# setup.py
51			# nosetests
52			# py.test
53			# trial [arguments]
54
55			# @ECLASS-VARIABLE: DISTUTILS_DISABLE_TEST_DEPENDENCY
56			# @DESCRIPTION:
57			# Disable modification of IUSE and DEPEND caused by setting of DISTUTILS_SRC_TEST.
58
59			if [[ -n "${DISTUTILS_SRC_TEST}" && ! "${DISTUTILS_SRC_TEST}" =~ ^(setup\.py\|nosetests\|py\.test\|trial(\ .*)?)$ ]]; then
60			die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
61			fi
62
63			if [[ -z "${DISTUTILS_DISABLE_TEST_DEPENDENCY}" ]]; then
64			if [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
65			IUSE="test"
66			DEPEND+="${DEPEND:+ }test? ( dev-python/nose )"
67			elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
68			IUSE="test"
69			DEPEND+="${DEPEND:+ }test? ( dev-python/py )"
70			# trial requires an argument, which is usually equal to "${PN}".
71			elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
72			IUSE="test"
73			DEPEND+="${DEPEND:+ }test? ( dev-python/twisted )"
74			fi
75			fi
76
77			if [[ -n "${DISTUTILS_SRC_TEST}" ]]; then
78			EXPORT_FUNCTIONS src_test
79			fi
80
81	arfrever	1.68	# @ECLASS-VARIABLE: DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS
82			# @DESCRIPTION:
83			# Set this to disable renaming of Python scripts containing versioned shebangs
84			# and generation of wrapper scripts.
85
86	arfrever	1.73	# @ECLASS-VARIABLE: DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS
87			# @DESCRIPTION:
88			# List of paths to Python scripts, relative to ${D}, which are excluded from
89			# renaming and generation of wrapper scripts.
90
91	dev-zero	1.46	# @ECLASS-VARIABLE: DOCS
92			# @DESCRIPTION:
93	arfrever	1.70	# Additional documentation files installed by distutils_src_install().
94
95			_distutils_get_build_dir() {
96			if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
97			echo "build-${PYTHON_ABI}"
98			else
99			echo "build"
100			fi
101			}
102
103			_distutils_get_PYTHONPATH() {
104			if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
105			ls -d build-${PYTHON_ABI}/lib* 2> /dev/null
106			else
107			ls -d build/lib* 2> /dev/null
108			fi
109			}
110	dev-zero	1.46
111	arfrever	1.67	_distutils_hook() {
112			if [[ "$#" -ne 1 ]]; then
113			die "${FUNCNAME}() requires 1 argument"
114			fi
115			if [[ "$(type -t "distutils_src_${EBUILD_PHASE}_$1_hook")" == "function" ]]; then
116			"distutils_src_${EBUILD_PHASE}_$1_hook"
117			fi
118			}
119
120	dev-zero	1.46	# @FUNCTION: distutils_src_unpack
121			# @DESCRIPTION:
122	arfrever	1.70	# The distutils src_unpack function. This function is exported.
123	lucass	1.41	distutils_src_unpack() {
124	arfrever	1.73	if ! has "${EAPI:-0}" 0 1; then
125			die "${FUNCNAME}() cannot be used in this EAPI"
126			fi
127
128	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
129			die "${FUNCNAME}() can be used only in src_unpack() phase"
130			fi
131
132	lucass	1.41	unpack ${A}
133			cd "${S}"
134
135	arfrever	1.73	distutils_src_prepare
136	pva	1.55	}
137
138			# @FUNCTION: distutils_src_prepare
139			# @DESCRIPTION:
140	arfrever	1.70	# The distutils src_prepare function. This function is exported.
141	pva	1.55	distutils_src_prepare() {
142	arfrever	1.59	if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
143			die "${FUNCNAME}() can be used only in src_prepare() phase"
144			fi
145
146	arfrever	1.70	# Delete ez_setup files to prevent packages from installing Setuptools on their own.
147	arfrever	1.66	local ez_setup_existence="0"
148	arfrever	1.63	[[ -d ez_setup \|\| -f ez_setup.py ]] && ez_setup_existence="1"
149	arfrever	1.61	rm -fr ez_setup*
150	arfrever	1.63	if [[ "${ez_setup_existence}" == "1" ]]; then
151	arfrever	1.61	echo "def use_setuptools(args, *kwargs): pass" > ez_setup.py
152			fi
153
154	arfrever	1.70	# Delete distribute_setup files to prevent packages from installing Distribute on their own.
155	arfrever	1.66	local distribute_setup_existence="0"
156			[[ -d distribute_setup \|\| -f distribute_setup.py ]] && distribute_setup_existence="1"
157			rm -fr distribute_setup*
158			if [[ "${distribute_setup_existence}" == "1" ]]; then
159			echo "def use_setuptools(args, *kwargs): pass" > distribute_setup.py
160			fi
161
162	arfrever	1.61	if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
163			python_copy_sources
164			fi
165	lucass	1.41	}
166
167	dev-zero	1.46	# @FUNCTION: distutils_src_compile
168			# @DESCRIPTION:
169	arfrever	1.70	# The distutils src_compile function. This function is exported.
170			# In ebuilds of packages supporting installation for multiple versions of Python, this function
171			# calls distutils_src_compile_pre_hook() and distutils_src_compile_post_hook(), if they are defined.
172	jnelson	1.1	distutils_src_compile() {
173	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "compile" ]]; then
174			die "${FUNCNAME}() can be used only in src_compile() phase"
175			fi
176
177	arfrever	1.73	_python_set_color_variables
178
179	arfrever	1.70	if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
180			distutils_building() {
181			_distutils_hook pre
182
183	arfrever	1.73	echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@"${_NORMAL}
184	arfrever	1.70	"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@" \|\| return "$?"
185
186			_distutils_hook post
187			}
188			python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_building "$@"
189			else
190	arfrever	1.73	echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"${_NORMAL}
191			"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" \|\| die "Building failed"
192	arfrever	1.70	fi
193			}
194	arfrever	1.67
195	arfrever	1.70	# @FUNCTION: distutils_src_test
196			# @DESCRIPTION:
197			# The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set.
198			distutils_src_test() {
199	arfrever	1.73	_python_set_color_variables
200
201	arfrever	1.70	if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
202			if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
203			distutils_testing() {
204	arfrever	1.73	echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"${_NORMAL}
205	arfrever	1.70	PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
206	arfrever	1.61	}
207	arfrever	1.70	python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
208			else
209	arfrever	1.73	echo ${_BOLD}PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@"${_NORMAL}
210			PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" \|\| die "Testing failed"
211	arfrever	1.70	fi
212			elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
213			python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
214			elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
215			python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
216			# trial requires an argument, which is usually equal to "${PN}".
217			elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
218			local trial_arguments
219			if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
220			trial_arguments="${DISTUTILS_SRC_TEST#trial }"
221	arfrever	1.61	else
222	arfrever	1.70	trial_arguments="${PN}"
223			fi
224	arfrever	1.67
225	arfrever	1.70	python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
226	arfrever	1.56	else
227	arfrever	1.70	die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
228	arfrever	1.56	fi
229	jnelson	1.1	}
230
231	dev-zero	1.46	# @FUNCTION: distutils_src_install
232			# @DESCRIPTION:
233	arfrever	1.70	# The distutils src_install function. This function is exported.
234			# In ebuilds of packages supporting installation for multiple versions of Python, this function
235			# calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
236			# It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
237			# KNOWN_BUGS, MAINTAINERS, MANIFEST, NEWS, PKG-INFO, README, TODO).
238	jnelson	1.1	distutils_src_install() {
239	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "install" ]]; then
240			die "${FUNCNAME}() can be used only in src_install() phase"
241			fi
242
243	arfrever	1.73	_python_set_color_variables
244
245	arfrever	1.70	if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
246			if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
247	arfrever	1.68	declare -A wrapper_scripts=()
248
249			rename_scripts_with_versioned_shebangs() {
250			if [[ -d "${D}usr/bin" ]]; then
251			cd "${D}usr/bin"
252
253	arfrever	1.73	local nonversioned_file file
254	arfrever	1.68	for file in *; do
255	arfrever	1.73	if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]](-jython)?+$ && "$(head -n1 "${file}")" =~ ^'#!'.*(python\|jython-)[[:digit:]]+\.[[:digit:]]+ ]]; then
256			for nonversioned_file in "${DISTUTILS_NONVERSIONED_PYTHON_SCRIPTS[@]}"; do
257			[[ "${nonversioned_file}" == "/usr/bin/${file}" ]] && continue 2
258			done
259	arfrever	1.68	mv "${file}" "${file}-${PYTHON_ABI}" \|\| die "Renaming of '${file}' failed"
260			wrapper_scripts+=(["${D}usr/bin/${file}"]=)
261			fi
262			done
263			fi
264			}
265			fi
266
267	arfrever	1.70	distutils_installation() {
268			_distutils_hook pre
269	arfrever	1.61
270	arfrever	1.73	echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@"${_NORMAL}
271	arfrever	1.70	"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@" \|\| return "$?"
272	arfrever	1.67
273	arfrever	1.70	if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
274			rename_scripts_with_versioned_shebangs
275			fi
276	arfrever	1.61
277	arfrever	1.70	_distutils_hook post
278			}
279			python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"
280	arfrever	1.67
281	arfrever	1.70	if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
282	arfrever	1.68	python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
283			fi
284			unset wrapper_scripts
285	liquidx	1.18	else
286	arfrever	1.69	# Mark the package to be rebuilt after a Python upgrade.
287			python_need_rebuild
288
289	arfrever	1.73	echo ${_BOLD}"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"${_NORMAL}
290			"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" \|\| die "Installation failed"
291	swegener	1.28	fi
292	lanius	1.20
293	arfrever	1.64	if [[ -e "${D}usr/local" ]]; then
294			die "Illegal installation into /usr/local"
295			fi
296
297	arfrever	1.62	local default_docs
298			default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
299	lanius	1.20
300	arfrever	1.56	local doc
301	arfrever	1.62	for doc in ${default_docs}; do
302			[[ -s "${doc}" ]] && dodoc "${doc}"
303	lanius	1.20	done
304
305	arfrever	1.62	if [[ -n "${DOCS}" ]]; then
306			dodoc ${DOCS} \|\| die "dodoc failed"
307			fi
308	jnelson	1.1	}
309	kutsuya	1.6
310	arfrever	1.63	# @FUNCTION: distutils_pkg_postinst
311	dev-zero	1.46	# @DESCRIPTION:
312	arfrever	1.70	# The distutils pkg_postinst function. This function is exported.
313			# When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
314			# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
315			# name is equal to name of current package, if this module exists.
316	arfrever	1.63	distutils_pkg_postinst() {
317			if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
318			die "${FUNCNAME}() can be used only in pkg_postinst() phase"
319	arfrever	1.59	fi
320
321	arfrever	1.56	local pylibdir pymod
322	hawking	1.54	if [[ -z "${PYTHON_MODNAME}" ]]; then
323	arfrever	1.73	for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; do
324	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
325			PYTHON_MODNAME="${PN}"
326	hawking	1.54	fi
327			done
328	hawking	1.49	fi
329	liquidx	1.19
330	arfrever	1.63	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
331	arfrever	1.65	python_mod_optimize ${PYTHON_MODNAME}
332	arfrever	1.56	else
333	arfrever	1.63	for pymod in ${PYTHON_MODNAME}; do
334			python_mod_optimize "$(python_get_sitedir)/${pymod}"
335			done
336	swegener	1.28	fi
337	liquidx	1.19	}
338
339	arfrever	1.63	# @FUNCTION: distutils_pkg_postrm
340	dev-zero	1.46	# @DESCRIPTION:
341	arfrever	1.70	# The distutils pkg_postrm function. This function is exported.
342			# When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
343			# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
344			# name is equal to name of current package, if this module exists.
345	arfrever	1.63	distutils_pkg_postrm() {
346			if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
347			die "${FUNCNAME}() can be used only in pkg_postrm() phase"
348	arfrever	1.59	fi
349
350	hawking	1.54	local pylibdir pymod
351			if [[ -z "${PYTHON_MODNAME}" ]]; then
352	arfrever	1.73	for pylibdir in "${ROOT}"usr/$(get_libdir)/python* "${ROOT}"/usr/share/jython-*/Lib; do
353	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
354			PYTHON_MODNAME="${PN}"
355	hawking	1.54	fi
356			done
357	hawking	1.50	fi
358	swegener	1.28
359	arfrever	1.63	if [[ -n "${PYTHON_MODNAME}" ]]; then
360	arfrever	1.65	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
361			python_mod_cleanup ${PYTHON_MODNAME}
362			else
363			for pymod in ${PYTHON_MODNAME}; do
364	arfrever	1.73	for pylibdir in "${ROOT}"usr/$(get_libdir)/python*; do
365	arfrever	1.63	if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
366	arfrever	1.73	python_mod_cleanup "${pylibdir#${ROOT%/}}/site-packages/${pymod}"
367	arfrever	1.63	fi
368			done
369	arfrever	1.65	done
370			fi
371	arfrever	1.56	else
372	arfrever	1.63	python_mod_cleanup
373	swegener	1.28	fi
374	liquidx	1.19	}
375
376	dev-zero	1.46	# @FUNCTION: distutils_python_version
377			# @DESCRIPTION:
378	arfrever	1.70	# Deprecated wrapper function for deprecated python_version().
379	liquidx	1.13	distutils_python_version() {
380	arfrever	1.73	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
381	arfrever	1.70	eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
382	arfrever	1.68	die "${FUNCNAME}() cannot be used in this EAPI"
383			fi
384
385	liquidx	1.34	python_version
386	liquidx	1.12	}
387
388	dev-zero	1.46	# @FUNCTION: distutils_python_tkinter
389			# @DESCRIPTION:
390	arfrever	1.73	# Deprecated wrapper function for deprecated python_tkinter_exists().
391	liquidx	1.12	distutils_python_tkinter() {
392	arfrever	1.73	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
393			eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
394	arfrever	1.68	die "${FUNCNAME}() cannot be used in this EAPI"
395			fi
396
397	lucass	1.40	python_tkinter_exists
398	vapier	1.8	}