dev-cpp/pangomm: stable 2.42.1 for hppa, bug #717144
[gentoo.git] / eclass / python-single-r1.eclass
index f042bf4e11676b8cef62c16a44f7bee588479e4d..d516e3629696b502a1b42fddc44697697e55f107 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright 1999-2018 Gentoo Foundation
+# Copyright 1999-2020 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: python-single-r1.eclass
@@ -22,7 +22,7 @@
 # The eclass exports PYTHON_SINGLE_USEDEP that is suitable for depending
 # on other packages using the eclass.  Dependencies on packages using
 # python-r1 should be created via python_gen_cond_dep() function,
-# using PYTHON_MULTI_USEDEP placeholder.
+# using PYTHON_USEDEP placeholder.
 #
 # Please note that packages support multiple Python implementations
 # (using python-r1 eclass) can not depend on packages not supporting
@@ -33,8 +33,8 @@
 # in the packages using python-single-r1, and there is no need ever
 # to inherit both.
 #
-# For more information, please see the wiki:
-# https://wiki.gentoo.org/wiki/Project:Python/python-single-r1
+# For more information, please see the Python Guide:
+# https://dev.gentoo.org/~mgorny/python-guide/
 
 case "${EAPI:-0}" in
        0|1|2|3|4)
@@ -89,9 +89,9 @@ EXPORT_FUNCTIONS pkg_setup
 #
 # It should be noted that in order to preserve metadata immutability,
 # PYTHON_COMPAT_OVERRIDE does not affect IUSE nor dependencies.
-# The state of PYTHON_TARGETS and PYTHON_SINGLE_TARGET is ignored,
-# and the implementation in PYTHON_COMPAT_OVERRIDE is built instead.
-# Dependencies need to be satisfied manually.
+# The state of PYTHON_SINGLE_TARGET is ignored, and the implementation
+# in PYTHON_COMPAT_OVERRIDE is built instead.  Dependencies need to be
+# satisfied manually.
 #
 # Example:
 # @CODE
@@ -136,30 +136,7 @@ EXPORT_FUNCTIONS pkg_setup
 # @CODE
 # dev-lang/python-exec:=
 # python_single_target_python2_7? ( dev-lang/python:2.7[gdbm] )
-# python_single_target_pypy? ( virtual/pypy[gdbm] )
-# @CODE
-
-# @ECLASS-VARIABLE: PYTHON_USEDEP
-# @DESCRIPTION:
-# DEPRECATED.  Use PYTHON_SINGLE_USEDEP or python_gen_cond_dep with
-# PYTHON_MULTI_USEDEP placeholder instead.
-#
-# This is an eclass-generated USE-dependency string which can be used to
-# depend on another Python package being built for the same Python
-# implementations.
-#
-# The generate USE-flag list is compatible with packages using python-r1,
-# python-single-r1 and python-distutils-ng eclasses. It must not be used
-# on packages using python.eclass.
-#
-# Example use:
-# @CODE
-# RDEPEND="dev-python/foo[${PYTHON_USEDEP}]"
-# @CODE
-#
-# Example value:
-# @CODE
-# python_targets_python2_7(-)?,python_single_target_python3_4(+)?
+# python_single_target_pypy? ( dev-python/pypy[gdbm] )
 # @CODE
 
 # @ECLASS-VARIABLE: PYTHON_SINGLE_USEDEP
@@ -169,7 +146,7 @@ EXPORT_FUNCTIONS pkg_setup
 # Python implementations.
 #
 # If you need to depend on a multi-impl (python-r1) package, use
-# python_gen_cond_dep with PYTHON_MULTI_USEDEP placeholder instead.
+# python_gen_cond_dep with PYTHON_USEDEP placeholder instead.
 #
 # Example use:
 # @CODE
@@ -181,7 +158,7 @@ EXPORT_FUNCTIONS pkg_setup
 # python_single_target_python3_4(-)?
 # @CODE
 
-# @ECLASS-VARIABLE: PYTHON_MULTI_USEDEP
+# @ECLASS-VARIABLE: PYTHON_USEDEP
 # @DESCRIPTION:
 # This is a placeholder variable supported by python_gen_cond_dep,
 # in order to depend on python-r1 packages built for the same Python
@@ -190,7 +167,7 @@ EXPORT_FUNCTIONS pkg_setup
 # Example use:
 # @CODE
 # RDEPEND="$(python_gen_cond_dep '
-#     dev-python/foo[${PYTHON_MULTI_USEDEP}]
+#     dev-python/foo[${PYTHON_USEDEP}]
 #   ')"
 # @CODE
 #
@@ -199,12 +176,15 @@ EXPORT_FUNCTIONS pkg_setup
 # python_targets_python3_4(-)
 # @CODE
 
+# @ECLASS-VARIABLE: PYTHON_MULTI_USEDEP
+# @DESCRIPTION:
+# This is a backwards-compatibility placeholder.  Use PYTHON_USEDEP
+# instead.
+
 # @ECLASS-VARIABLE: PYTHON_REQUIRED_USE
 # @DESCRIPTION:
-# This is an eclass-generated required-use expression which ensures the following
-# when more than one python implementation is possible:
-# 1. Exactly one PYTHON_SINGLE_TARGET value has been enabled.
-# 2. The selected PYTHON_SINGLE_TARGET value is enabled in PYTHON_TARGETS.
+# This is an eclass-generated required-use expression which ensures
+# that exactly one PYTHON_SINGLE_TARGET value has been enabled.
 #
 # This expression should be utilized in an ebuild by including it in
 # REQUIRED_USE, optionally behind a use flag.
@@ -216,40 +196,29 @@ EXPORT_FUNCTIONS pkg_setup
 #
 # Example value:
 # @CODE
-# python_single_target_python2_7? ( python_targets_python2_7 )
-# python_single_target_python3_3? ( python_targets_python3_3 )
 # ^^ ( python_single_target_python2_7 python_single_target_python3_3 )
 # @CODE
 
 _python_single_set_globals() {
        _python_set_impls
 
-       local flags_mt=( "${_PYTHON_SUPPORTED_IMPLS[@]/#/python_targets_}" )
        local flags=( "${_PYTHON_SUPPORTED_IMPLS[@]/#/python_single_target_}" )
-       local unflags=( "${_PYTHON_UNSUPPORTED_IMPLS[@]/#/-python_single_target_}" )
 
        if [[ ${#_PYTHON_SUPPORTED_IMPLS[@]} -eq 1 ]]; then
                # if only one implementation is supported, use IUSE defaults
                # to avoid requesting the user to enable it
-               IUSE="+${flags_mt[0]} +${flags[0]}"
+               IUSE="+${flags[0]}"
        else
-               IUSE="${flags_mt[*]} ${flags[*]}"
+               IUSE="${flags[*]}"
        fi
 
        local requse="^^ ( ${flags[*]} )"
-       local optflags="${flags_mt[@]/%/(-)?},${unflags[@]/%/(-)},${flags[@]/%/(+)?}"
-       local usedep="${optflags// /,}"
        local single_flags="${flags[@]/%/(-)?}"
        local single_usedep=${single_flags// /,}
 
        local deps= i PYTHON_PKG_DEP
        for i in "${_PYTHON_SUPPORTED_IMPLS[@]}"; do
-               # The chosen targets need to be in PYTHON_TARGETS as well.
-               # This is in order to enforce correct dependencies on packages
-               # supporting multiple implementations.
-               requse+=" python_single_target_${i}? ( python_targets_${i} )"
-
-               python_export "${i}" PYTHON_PKG_DEP
+               _python_export "${i}" PYTHON_PKG_DEP
                # 1) well, python-exec would suffice as an RDEP
                # but no point in making this overcomplex, BDEP doesn't hurt anyone
                # 2) python-exec should be built with all targets forced anyway
@@ -276,13 +245,6 @@ _python_single_set_globals() {
                        die "PYTHON_REQUIRED_USE integrity check failed"
                fi
 
-               if [[ ${PYTHON_USEDEP} != "${usedep}" ]]; then
-                       eerror "PYTHON_USEDEP have changed between inherits!"
-                       eerror "Before: ${PYTHON_USEDEP}"
-                       eerror "Now   : ${usedep}"
-                       die "PYTHON_USEDEP integrity check failed"
-               fi
-
                if [[ ${PYTHON_SINGLE_USEDEP} != "${single_usedep}" ]]; then
                        eerror "PYTHON_SINGLE_USEDEP have changed between inherits!"
                        eerror "Before: ${PYTHON_SINGLE_USEDEP}"
@@ -292,10 +254,10 @@ _python_single_set_globals() {
        else
                PYTHON_DEPS=${deps}
                PYTHON_REQUIRED_USE=${requse}
-               PYTHON_USEDEP=${usedep}
+               PYTHON_USEDEP='%PYTHON_USEDEP-NEEDS-TO-BE-USED-IN-PYTHON_GEN_COND_DEP%'
                PYTHON_SINGLE_USEDEP=${single_usedep}
-               readonly PYTHON_DEPS PYTHON_REQUIRED_USE PYTHON_USEDEP \
-                       PYTHON_SINGLE_USEDEP
+               readonly PYTHON_DEPS PYTHON_REQUIRED_USE PYTHON_SINGLE_USEDEP \
+                       PYTHON_USEDEP
        fi
 }
 _python_single_set_globals
@@ -305,45 +267,29 @@ if [[ ! ${_PYTHON_SINGLE_R1} ]]; then
 
 # @FUNCTION: _python_gen_usedep
 # @INTERNAL
-# @USAGE: <-s|-u> [<pattern>...]
+# @USAGE: [<pattern>...]
 # @DESCRIPTION:
 # Output a USE dependency string for Python implementations which
 # are both in PYTHON_COMPAT and match any of the patterns passed
 # as parameters to the function.
 #
-# The first argument specifies USE-dependency type: '-s' for new-style
-# PYTHON_SINGLE_USEDEP, '-u' for backwards-compatible PYTHON_USEDEP.
-#
 # The patterns can be either fnmatch-style patterns (matched via bash
 # == operator against PYTHON_COMPAT values) or '-2' / '-3' to indicate
 # appropriately all enabled Python 2/3 implementations (alike
 # python_is_python3). Remember to escape or quote the fnmatch patterns
 # to prevent accidental shell filename expansion.
 #
-# This is an internal function used to implement python_gen_cond_dep
-# and deprecated python_gen_usedep.
+# This is an internal function used to implement python_gen_cond_dep.
 _python_gen_usedep() {
        debug-print-function ${FUNCNAME} "${@}"
 
-       local mode=${1}
-       shift
        local impl matches=()
 
        for impl in "${_PYTHON_SUPPORTED_IMPLS[@]}"; do
                if _python_impl_matches "${impl}" "${@}"; then
-                       case ${mode} in
-                               -s)
-                                       matches+=(
-                                               "python_single_target_${impl}(-)?"
-                                       )
-                                       ;;
-                               -u)
-                                       matches+=(
-                                               "python_targets_${impl}(-)?"
-                                               "python_single_target_${impl}(+)?"
-                                       )
-                               ;;
-                       esac
+                       matches+=(
+                               "python_single_target_${impl}(-)?"
+                       )
                fi
        done
 
@@ -353,46 +299,6 @@ _python_gen_usedep() {
        echo "${out// /,}"
 }
 
-# @FUNCTION: python_gen_usedep
-# @USAGE: <pattern> [...]
-# @DESCRIPTION:
-# DEPRECATED.  Please use python_gen_cond_dep instead.
-#
-# Output a USE dependency string for Python implementations which
-# are both in PYTHON_COMPAT and match any of the patterns passed
-# as parameters to the function.
-#
-# The patterns can be either fnmatch-style patterns (matched via bash
-# == operator against PYTHON_COMPAT values) or '-2' / '-3' to indicate
-# appropriately all enabled Python 2/3 implementations (alike
-# python_is_python3). Remember to escape or quote the fnmatch patterns
-# to prevent accidental shell filename expansion.
-#
-# When all implementations are requested, please use ${PYTHON_USEDEP}
-# instead. Please also remember to set an appropriate REQUIRED_USE
-# to avoid ineffective USE flags.
-#
-# Example:
-# @CODE
-# PYTHON_COMPAT=( python{2_7,3_4} )
-# DEPEND="doc? ( dev-python/epydoc[$(python_gen_usedep 'python2*')] )"
-# @CODE
-#
-# It will cause the dependency to look like:
-# @CODE
-# DEPEND="doc? ( dev-python/epydoc[python_targets_python2_7(-)?,...] )"
-# @CODE
-python_gen_usedep() {
-       debug-print-function ${FUNCNAME} "${@}"
-
-       # output only once, during some reasonable phase
-       # (avoid spamming cache regen runs)
-       if [[ ${EBUILD_PHASE} == setup ]]; then
-               eqawarn "python_gen_usedep() is deprecated. Please use python_gen_cond_dep instead."
-       fi
-       _python_gen_usedep -u "${@}"
-}
-
 # @FUNCTION: python_gen_useflags
 # @USAGE: [<pattern>...]
 # @DESCRIPTION:
@@ -444,16 +350,15 @@ python_gen_useflags() {
 # to prevent accidental shell filename expansion.
 #
 # In order to enforce USE constraints on the packages, verbatim
-# '${PYTHON_USEDEP}', '${PYTHON_SINGLE_USEDEP}'
-# and '${PYTHON_MULTI_USEDEP}' (quoted!) may be placed in the dependency
-# specification. It will get expanded within the function into a proper
-# USE dependency string.
+# '${PYTHON_SINGLE_USEDEP}' and '${PYTHON_USEDEP}' (quoted!) may
+# be placed in the dependency specification. It will get expanded within
+# the function into a proper USE dependency string.
 #
 # Example:
 # @CODE
 # PYTHON_COMPAT=( python{2_7,3_{3,4}} pypy )
 # RDEPEND="$(python_gen_cond_dep \
-#   'dev-python/unittest2[${PYTHON_MULTI_USEDEP}]' python2_7 pypy )"
+#   'dev-python/unittest2[${PYTHON_USEDEP}]' python2_7 pypy )"
 # @CODE
 #
 # It will cause the variable to look like:
@@ -473,21 +378,18 @@ python_gen_cond_dep() {
 
        for impl in "${_PYTHON_SUPPORTED_IMPLS[@]}"; do
                if _python_impl_matches "${impl}" "${@}"; then
-                       # substitute ${PYTHON_USEDEP} if used
-                       # (since python_gen_usedep() will not return ${PYTHON_USEDEP}
-                       #  the code is run at most once)
-                       if [[ ${dep} == *'${PYTHON_USEDEP}'* ]]; then
-                               local usedep=$(_python_gen_usedep -u "${@}")
-                               dep=${dep//\$\{PYTHON_USEDEP\}/${usedep}}
-                       fi
+                       # substitute ${PYTHON_SINGLE_USEDEP} if used
+                       # (since python_gen_usedep() will not return
+                       #  ${PYTHON_SINGLE_USEDEP}, the code is run at most once)
                        if [[ ${dep} == *'${PYTHON_SINGLE_USEDEP}'* ]]; then
-                               local usedep=$(_python_gen_usedep -s "${@}")
+                               local usedep=$(_python_gen_usedep "${@}")
                                dep=${dep//\$\{PYTHON_SINGLE_USEDEP\}/${usedep}}
                        fi
                        local multi_usedep="python_targets_${impl}(-)"
 
+                       local subdep=${dep//\$\{PYTHON_MULTI_USEDEP\}/${multi_usedep}}
                        matches+=( "python_single_target_${impl}? (
-                               ${dep//\$\{PYTHON_MULTI_USEDEP\}/${multi_usedep}} )" )
+                               ${subdep//\$\{PYTHON_USEDEP\}/${multi_usedep}} )" )
                fi
        done
 
@@ -540,7 +442,7 @@ python_gen_impl_dep() {
        for impl in "${_PYTHON_SUPPORTED_IMPLS[@]}"; do
                if _python_impl_matches "${impl}" "${@}"; then
                        local PYTHON_PKG_DEP
-                       python_export "${impl}" PYTHON_PKG_DEP
+                       _python_export "${impl}" PYTHON_PKG_DEP
                        matches+=( "python_single_target_${impl}? ( ${PYTHON_PKG_DEP} )" )
                fi
        done
@@ -569,8 +471,9 @@ python_setup() {
                ewarn
                ewarn "Dependencies won't be satisfied, and PYTHON_SINGLE_TARGET flags will be ignored."
 
-               python_export "${impls[0]}" EPYTHON PYTHON
-               python_wrapper_setup
+               _python_export "${impls[0]}" EPYTHON PYTHON
+               _python_wrapper_setup
+               einfo "Using ${EPYTHON} to build"
                return
        fi
 
@@ -586,17 +489,9 @@ python_setup() {
                                die "More than one implementation in PYTHON_SINGLE_TARGET."
                        fi
 
-                       if ! use "python_targets_${impl}"; then
-                               eerror "The implementation chosen as PYTHON_SINGLE_TARGET must be added"
-                               eerror "to PYTHON_TARGETS as well. This is in order to ensure that"
-                               eerror "dependencies are satisfied correctly. We're sorry"
-                               eerror "for the inconvenience."
-                               echo
-                               die "Build target (${impl}) not in PYTHON_TARGETS."
-                       fi
-
-                       python_export "${impl}" EPYTHON PYTHON
-                       python_wrapper_setup
+                       _python_export "${impl}" EPYTHON PYTHON
+                       _python_wrapper_setup
+                       einfo "Using ${EPYTHON} to build"
                fi
        done
 
@@ -607,7 +502,7 @@ python_setup() {
                eerror
                eerror "${_PYTHON_SUPPORTED_IMPLS[@]}"
                echo
-               die "No supported Python implementation in PYTHON_SINGLE_TARGET/PYTHON_TARGETS."
+               die "No supported Python implementation in PYTHON_SINGLE_TARGET."
        fi
 }