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.71 2010/02/07 21:17:15 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_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
                ;;
esac

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

if has "${EAPI:-0}" 0 1 2; then
        python="python"
else
        # Use "$(PYTHON)" or "$(PYTHON -A)" 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: 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 [[ "${EBUILD_PHASE}" != "unpack" ]]; then
                die "${FUNCNAME}() can be used only in src_unpack() phase"
        fi

        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() {
        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

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

                        echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@"
                        "$(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 "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
                "$(PYTHON -A)" 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() {
        if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
                if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
                        distutils_testing() {
                                echo PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
                                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 PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" || die "Testing failed"
                        PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON -A)" 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

        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 file
                                        for file in *; do
                                                if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]]+$ && "$(head -n1 "${file}")" =~ ^'#!'.*python[[:digit:]]+\.[[:digit:]]+ ]]; then
                                                        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 "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@"
                        "$(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 "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
                "$(PYTHON -A)" 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*; 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*; 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; 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 python_tkinter_exists().
distutils_python_tkinter() {
        if ! has "${EAPI:-0}" 0 1 2; then
                eerror "Use python_tkinter_exists() 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	pva	1.72	# $Header: /var/cvsroot/gentoo-x86/eclass/distutils.eclass,v 1.71 2010/02/07 21:17:15 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.70	# 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			EXPORT_FUNCTIONS src_unpack src_prepare src_compile src_install pkg_postinst pkg_postrm
22			;;
23			esac
24
25	arfrever	1.70	if [[ -z "${PYTHON_DEPEND}" ]]; then
26	arfrever	1.62	DEPEND="virtual/python"
27			RDEPEND="${DEPEND}"
28			fi
29	arfrever	1.68
30			if has "${EAPI:-0}" 0 1 2; then
31			python="python"
32			else
33	arfrever	1.70	# Use "$(PYTHON)" or "$(PYTHON -A)" 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	dev-zero	1.46	# @ECLASS-VARIABLE: DOCS
87			# @DESCRIPTION:
88	arfrever	1.70	# Additional documentation files installed by distutils_src_install().
89
90			_distutils_get_build_dir() {
91			if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
92			echo "build-${PYTHON_ABI}"
93			else
94			echo "build"
95			fi
96			}
97
98			_distutils_get_PYTHONPATH() {
99			if [[ -n "${SUPPORT_PYTHON_ABIS}" && -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
100			ls -d build-${PYTHON_ABI}/lib* 2> /dev/null
101			else
102			ls -d build/lib* 2> /dev/null
103			fi
104			}
105	dev-zero	1.46
106	arfrever	1.67	_distutils_hook() {
107			if [[ "$#" -ne 1 ]]; then
108			die "${FUNCNAME}() requires 1 argument"
109			fi
110			if [[ "$(type -t "distutils_src_${EBUILD_PHASE}_$1_hook")" == "function" ]]; then
111			"distutils_src_${EBUILD_PHASE}_$1_hook"
112			fi
113			}
114
115	dev-zero	1.46	# @FUNCTION: distutils_src_unpack
116			# @DESCRIPTION:
117	arfrever	1.70	# The distutils src_unpack function. This function is exported.
118	lucass	1.41	distutils_src_unpack() {
119	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "unpack" ]]; then
120			die "${FUNCNAME}() can be used only in src_unpack() phase"
121			fi
122
123	lucass	1.41	unpack ${A}
124			cd "${S}"
125
126	arfrever	1.56	has "${EAPI:-0}" 0 1 && distutils_src_prepare
127	pva	1.55	}
128
129			# @FUNCTION: distutils_src_prepare
130			# @DESCRIPTION:
131	arfrever	1.70	# The distutils src_prepare function. This function is exported.
132	pva	1.55	distutils_src_prepare() {
133	arfrever	1.59	if ! has "${EAPI:-0}" 0 1 && [[ "${EBUILD_PHASE}" != "prepare" ]]; then
134			die "${FUNCNAME}() can be used only in src_prepare() phase"
135			fi
136
137	arfrever	1.70	# Delete ez_setup files to prevent packages from installing Setuptools on their own.
138	arfrever	1.66	local ez_setup_existence="0"
139	arfrever	1.63	[[ -d ez_setup \|\| -f ez_setup.py ]] && ez_setup_existence="1"
140	arfrever	1.61	rm -fr ez_setup*
141	arfrever	1.63	if [[ "${ez_setup_existence}" == "1" ]]; then
142	arfrever	1.61	echo "def use_setuptools(args, *kwargs): pass" > ez_setup.py
143			fi
144
145	arfrever	1.70	# Delete distribute_setup files to prevent packages from installing Distribute on their own.
146	arfrever	1.66	local distribute_setup_existence="0"
147			[[ -d distribute_setup \|\| -f distribute_setup.py ]] && distribute_setup_existence="1"
148			rm -fr distribute_setup*
149			if [[ "${distribute_setup_existence}" == "1" ]]; then
150			echo "def use_setuptools(args, *kwargs): pass" > distribute_setup.py
151			fi
152
153	arfrever	1.61	if [[ -n "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]]; then
154			python_copy_sources
155			fi
156	lucass	1.41	}
157
158	dev-zero	1.46	# @FUNCTION: distutils_src_compile
159			# @DESCRIPTION:
160	arfrever	1.70	# The distutils src_compile function. This function is exported.
161			# In ebuilds of packages supporting installation for multiple versions of Python, this function
162			# calls distutils_src_compile_pre_hook() and distutils_src_compile_post_hook(), if they are defined.
163	jnelson	1.1	distutils_src_compile() {
164	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "compile" ]]; then
165			die "${FUNCNAME}() can be used only in src_compile() phase"
166			fi
167
168	arfrever	1.70	if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
169			distutils_building() {
170			_distutils_hook pre
171
172			echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@"
173			"$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build -b "$(_distutils_get_build_dir)" "$@" \|\| return "$?"
174
175			_distutils_hook post
176			}
177			python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_building "$@"
178			else
179			echo "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@"
180			"$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" build "$@" \|\| die "Building failed"
181			fi
182			}
183	arfrever	1.67
184	arfrever	1.70	# @FUNCTION: distutils_src_test
185			# @DESCRIPTION:
186			# The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set.
187			distutils_src_test() {
188			if [[ "${DISTUTILS_SRC_TEST}" == "setup.py" ]]; then
189			if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
190			distutils_testing() {
191			echo PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
192			PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") test "$@"
193	arfrever	1.61	}
194	arfrever	1.70	python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_testing "$@"
195			else
196			echo PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" \|\| die "Testing failed"
197			PYTHONPATH="$(_distutils_get_PYTHONPATH)" "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" test "$@" \|\| die "Testing failed"
198			fi
199			elif [[ "${DISTUTILS_SRC_TEST}" == "nosetests" ]]; then
200			python_execute_nosetests -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
201			elif [[ "${DISTUTILS_SRC_TEST}" == "py.test" ]]; then
202			python_execute_py.test -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- "$@"
203			# trial requires an argument, which is usually equal to "${PN}".
204			elif [[ "${DISTUTILS_SRC_TEST}" =~ ^trial(\ .*)?$ ]]; then
205			local trial_arguments
206			if [[ "${DISTUTILS_SRC_TEST}" == "trial "* ]]; then
207			trial_arguments="${DISTUTILS_SRC_TEST#trial }"
208	arfrever	1.61	else
209	arfrever	1.70	trial_arguments="${PN}"
210			fi
211	arfrever	1.67
212	arfrever	1.70	python_execute_trial -P '$(_distutils_get_PYTHONPATH)' ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} -- ${trial_arguments} "$@"
213	arfrever	1.56	else
214	arfrever	1.70	die "'DISTUTILS_SRC_TEST' variable has unsupported value '${DISTUTILS_SRC_TEST}'"
215	arfrever	1.56	fi
216	jnelson	1.1	}
217
218	dev-zero	1.46	# @FUNCTION: distutils_src_install
219			# @DESCRIPTION:
220	arfrever	1.70	# The distutils src_install function. This function is exported.
221			# In ebuilds of packages supporting installation for multiple versions of Python, this function
222			# calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined.
223			# It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS,
224			# KNOWN_BUGS, MAINTAINERS, MANIFEST, NEWS, PKG-INFO, README, TODO).
225	jnelson	1.1	distutils_src_install() {
226	arfrever	1.59	if [[ "${EBUILD_PHASE}" != "install" ]]; then
227			die "${FUNCNAME}() can be used only in src_install() phase"
228			fi
229
230	arfrever	1.70	if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
231			if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
232	arfrever	1.68	declare -A wrapper_scripts=()
233
234			rename_scripts_with_versioned_shebangs() {
235			if [[ -d "${D}usr/bin" ]]; then
236			cd "${D}usr/bin"
237
238			local file
239			for file in *; do
240			if [[ -f "${file}" && ! "${file}" =~ [[:digit:]]+\.[[:digit:]]+$ && "$(head -n1 "${file}")" =~ ^'#!'.*python[[:digit:]]+\.[[:digit:]]+ ]]; then
241			mv "${file}" "${file}-${PYTHON_ABI}" \|\| die "Renaming of '${file}' failed"
242			wrapper_scripts+=(["${D}usr/bin/${file}"]=)
243			fi
244			done
245			fi
246			}
247			fi
248
249	arfrever	1.70	distutils_installation() {
250			_distutils_hook pre
251	arfrever	1.61
252	arfrever	1.70	echo "$(PYTHON)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" $([[ -z "${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES}" ]] && echo build -b "$(_distutils_get_build_dir)") install --root="${D}" --no-compile "$@"
253			"$(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 "$?"
254	arfrever	1.67
255	arfrever	1.70	if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
256			rename_scripts_with_versioned_shebangs
257			fi
258	arfrever	1.61
259	arfrever	1.70	_distutils_hook post
260			}
261			python_execute_function ${DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES:+-s} distutils_installation "$@"
262	arfrever	1.67
263	arfrever	1.70	if [[ -z "${DISTUTILS_DISABLE_VERSIONING_OF_PYTHON_SCRIPTS}" && "${#wrapper_scripts[@]}" -ne 0 && "${BASH_VERSINFO[0]}" -ge 4 ]]; then
264	arfrever	1.68	python_generate_wrapper_scripts "${!wrapper_scripts[@]}"
265			fi
266			unset wrapper_scripts
267	liquidx	1.18	else
268	arfrever	1.69	# Mark the package to be rebuilt after a Python upgrade.
269			python_need_rebuild
270
271			echo "$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@"
272			"$(PYTHON -A)" setup.py "${DISTUTILS_GLOBAL_OPTIONS[@]}" install --root="${D}" --no-compile "$@" \|\| die "Installation failed"
273	swegener	1.28	fi
274	lanius	1.20
275	arfrever	1.64	if [[ -e "${D}usr/local" ]]; then
276			die "Illegal installation into /usr/local"
277			fi
278
279	arfrever	1.62	local default_docs
280			default_docs="AUTHORS Change* CHANGELOG CONTRIBUTORS KNOWN_BUGS MAINTAINERS MANIFEST* NEWS PKG-INFO README* TODO"
281	lanius	1.20
282	arfrever	1.56	local doc
283	arfrever	1.62	for doc in ${default_docs}; do
284			[[ -s "${doc}" ]] && dodoc "${doc}"
285	lanius	1.20	done
286
287	arfrever	1.62	if [[ -n "${DOCS}" ]]; then
288			dodoc ${DOCS} \|\| die "dodoc failed"
289			fi
290	jnelson	1.1	}
291	kutsuya	1.6
292	arfrever	1.63	# @FUNCTION: distutils_pkg_postinst
293	dev-zero	1.46	# @DESCRIPTION:
294	arfrever	1.70	# The distutils pkg_postinst function. This function is exported.
295			# When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules
296			# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose
297			# name is equal to name of current package, if this module exists.
298	arfrever	1.63	distutils_pkg_postinst() {
299			if [[ "${EBUILD_PHASE}" != "postinst" ]]; then
300			die "${FUNCNAME}() can be used only in pkg_postinst() phase"
301	arfrever	1.59	fi
302
303	arfrever	1.56	local pylibdir pymod
304	hawking	1.54	if [[ -z "${PYTHON_MODNAME}" ]]; then
305			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
306	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
307			PYTHON_MODNAME="${PN}"
308	hawking	1.54	fi
309			done
310	hawking	1.49	fi
311	liquidx	1.19
312	arfrever	1.63	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
313	arfrever	1.65	python_mod_optimize ${PYTHON_MODNAME}
314	arfrever	1.56	else
315	arfrever	1.63	for pymod in ${PYTHON_MODNAME}; do
316			python_mod_optimize "$(python_get_sitedir)/${pymod}"
317			done
318	swegener	1.28	fi
319	liquidx	1.19	}
320
321	arfrever	1.63	# @FUNCTION: distutils_pkg_postrm
322	dev-zero	1.46	# @DESCRIPTION:
323	arfrever	1.70	# The distutils pkg_postrm function. This function is exported.
324			# When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules
325			# specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose
326			# name is equal to name of current package, if this module exists.
327	arfrever	1.63	distutils_pkg_postrm() {
328			if [[ "${EBUILD_PHASE}" != "postrm" ]]; then
329			die "${FUNCNAME}() can be used only in pkg_postrm() phase"
330	arfrever	1.59	fi
331
332	hawking	1.54	local pylibdir pymod
333			if [[ -z "${PYTHON_MODNAME}" ]]; then
334			for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
335	arfrever	1.56	if [[ -d "${pylibdir}/site-packages/${PN}" ]]; then
336			PYTHON_MODNAME="${PN}"
337	hawking	1.54	fi
338			done
339	hawking	1.50	fi
340	swegener	1.28
341	arfrever	1.63	if [[ -n "${PYTHON_MODNAME}" ]]; then
342	arfrever	1.65	if ! has "${EAPI:-0}" 0 1 2 \|\| [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
343			python_mod_cleanup ${PYTHON_MODNAME}
344			else
345			for pymod in ${PYTHON_MODNAME}; do
346	arfrever	1.63	for pylibdir in "${ROOT}"/usr/$(get_libdir)/python*; do
347			if [[ -d "${pylibdir}/site-packages/${pymod}" ]]; then
348			python_mod_cleanup "${pylibdir#${ROOT}}/site-packages/${pymod}"
349			fi
350			done
351	arfrever	1.65	done
352			fi
353	arfrever	1.56	else
354	arfrever	1.63	python_mod_cleanup
355	swegener	1.28	fi
356	liquidx	1.19	}
357
358	dev-zero	1.46	# @FUNCTION: distutils_python_version
359			# @DESCRIPTION:
360	arfrever	1.70	# Deprecated wrapper function for deprecated python_version().
361	liquidx	1.13	distutils_python_version() {
362	arfrever	1.68	if ! has "${EAPI:-0}" 0 1 2; then
363	arfrever	1.70	eerror "Use PYTHON() and/or python_get_*() instead of ${FUNCNAME}()."
364	arfrever	1.68	die "${FUNCNAME}() cannot be used in this EAPI"
365			fi
366
367	liquidx	1.34	python_version
368	liquidx	1.12	}
369
370	dev-zero	1.46	# @FUNCTION: distutils_python_tkinter
371			# @DESCRIPTION:
372	arfrever	1.70	# Deprecated wrapper function for python_tkinter_exists().
373	liquidx	1.12	distutils_python_tkinter() {
374	arfrever	1.68	if ! has "${EAPI:-0}" 0 1 2; then
375	arfrever	1.70	eerror "Use python_tkinter_exists() instead of ${FUNCNAME}()."
376	arfrever	1.68	die "${FUNCNAME}() cannot be used in this EAPI"
377			fi
378
379	lucass	1.40	python_tkinter_exists
380	vapier	1.8	}