/[gentoo-x86]/eclass/python.eclass
Gentoo

Diff of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.84 Revision 1.105
1# Copyright 1999-2010 Gentoo Foundation 1# Copyright 1999-2010 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.84 2010/01/11 16:07:23 arfrever Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.105 2010/10/29 19:09:08 arfrever Exp $
4 4
5# @ECLASS: python.eclass 5# @ECLASS: python.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# python@gentoo.org 7# Gentoo Python Project <python@gentoo.org>
8# @BLURB: A utility eclass that should be inherited by anything that deals with Python or Python modules. 8# @BLURB: Eclass for Python packages
9# @DESCRIPTION: 9# @DESCRIPTION:
10# Some useful functions for dealing with Python. 10# The python eclass contains miscellaneous, useful functions for Python packages.
11 11
12inherit multilib 12inherit multilib
13 13
14if ! has "${EAPI:-0}" 0 1 2; then 14if ! has "${EAPI:-0}" 0 1 2 3; then
15 die "API of python.eclass in EAPI=\"${EAPI}\" not established" 15 die "API of python.eclass in EAPI=\"${EAPI}\" not established"
16fi 16fi
17 17
18_CPYTHON2_SUPPORTED_ABIS=(2.4 2.5 2.6 2.7)
19_CPYTHON3_SUPPORTED_ABIS=(3.0 3.1 3.2)
20_JYTHON_SUPPORTED_ABIS=(2.5-jython)
21_PYTHON_SUPPORTED_ABIS=(${_CPYTHON2_SUPPORTED_ABIS[@]} ${_CPYTHON3_SUPPORTED_ABIS[@]} ${_JYTHON_SUPPORTED_ABIS[@]})
22
23# ================================================================================================
24# ===================================== HANDLING OF METADATA =====================================
25# ================================================================================================
26
27# @ECLASS-VARIABLE: PYTHON_DEPEND
28# @DESCRIPTION:
29# Specification of dependency on dev-lang/python.
30# Syntax:
31# PYTHON_DEPEND: [[!]USE_flag? ]<version_components_group>[ version_components_group]
32# version_components_group: <major_version[:[minimal_version][:maximal_version]]>
33# major_version: <2|3|*>
34# minimal_version: <minimal_major_version.minimal_minor_version>
35# maximal_version: <maximal_major_version.maximal_minor_version>
36
37_python_parse_PYTHON_DEPEND() {
38 local major_version maximal_version minimal_version python_all="0" python_maximal_version python_minimal_version python_versions=() python2="0" python2_maximal_version python2_minimal_version python3="0" python3_maximal_version python3_minimal_version USE_flag= version_components_group version_components_group_regex version_components_groups
39
40 version_components_group_regex="(2|3|\*)(:([[:digit:]]+\.[[:digit:]]+)?(:([[:digit:]]+\.[[:digit:]]+)?)?)?"
41 version_components_groups="${PYTHON_DEPEND}"
42
43 if [[ "${version_components_groups}" =~ ^((\!)?[[:alnum:]_-]+\?\ )?${version_components_group_regex}(\ ${version_components_group_regex})?$ ]]; then
44 if [[ "${version_components_groups}" =~ ^(\!)?[[:alnum:]_-]+\? ]]; then
45 USE_flag="${version_components_groups%\? *}"
46 version_components_groups="${version_components_groups#* }"
47 fi
48 if [[ "${version_components_groups}" =~ ("*".*" "|" *"|^2.*\ (2|\*)|^3.*\ (3|\*)) ]]; then
49 die "Invalid syntax of PYTHON_DEPEND: Incorrectly specified groups of versions"
50 fi
51
52 version_components_groups="${version_components_groups// /$'\n'}"
53 while read version_components_group; do
54 major_version="${version_components_group:0:1}"
55 minimal_version="${version_components_group:2}"
56 minimal_version="${minimal_version%:*}"
57 maximal_version="${version_components_group:$((3 + ${#minimal_version}))}"
58
59 if [[ "${major_version}" =~ ^(2|3)$ ]]; then
60 if [[ -n "${minimal_version}" && "${major_version}" != "${minimal_version:0:1}" ]]; then
61 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' not in specified group of versions"
62 fi
63 if [[ -n "${maximal_version}" && "${major_version}" != "${maximal_version:0:1}" ]]; then
64 die "Invalid syntax of PYTHON_DEPEND: Maximal version '${maximal_version}' not in specified group of versions"
65 fi
66 fi
67
68 if [[ "${major_version}" == "2" ]]; then
69 python2="1"
70 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}")
71 python2_minimal_version="${minimal_version}"
72 python2_maximal_version="${maximal_version}"
73 elif [[ "${major_version}" == "3" ]]; then
74 python3="1"
75 python_versions=("${_CPYTHON3_SUPPORTED_ABIS[@]}")
76 python3_minimal_version="${minimal_version}"
77 python3_maximal_version="${maximal_version}"
78 else
79 python_all="1"
80 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}")
81 python_minimal_version="${minimal_version}"
82 python_maximal_version="${maximal_version}"
83 fi
84
85 if [[ -n "${minimal_version}" ]] && ! has "${minimal_version}" "${python_versions[@]}"; then
86 die "Invalid syntax of PYTHON_DEPEND: Unrecognized minimal version '${minimal_version}'"
87 fi
88 if [[ -n "${maximal_version}" ]] && ! has "${maximal_version}" "${python_versions[@]}"; then
89 die "Invalid syntax of PYTHON_DEPEND: Unrecognized maximal version '${maximal_version}'"
90 fi
91
92 if [[ -n "${minimal_version}" && -n "${maximal_version}" && "${minimal_version}" > "${maximal_version}" ]]; then
93 die "Invalid syntax of PYTHON_DEPEND: Minimal version '${minimal_version}' greater than maximal version '${maximal_version}'"
94 fi
95 done <<< "${version_components_groups}"
96
97 _PYTHON_ATOMS=()
98
99 _append_accepted_versions_range() {
100 local accepted_version="0" i
101 for ((i = "${#python_versions[@]}"; i >= 0; i--)); do
102 if [[ "${python_versions[${i}]}" == "${python_maximal_version}" ]]; then
103 accepted_version="1"
104 fi
105 if [[ "${accepted_version}" == "1" ]]; then
106 _PYTHON_ATOMS+=("=dev-lang/python-${python_versions[${i}]}*")
107 fi
108 if [[ "${python_versions[${i}]}" == "${python_minimal_version}" ]]; then
109 accepted_version="0"
110 fi
111 done
112 }
113
114 if [[ "${python_all}" == "1" ]]; then
115 if [[ -z "${python_minimal_version}" && -z "${python_maximal_version}" ]]; then
116 _PYTHON_ATOMS+=("dev-lang/python")
117 else
118 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}")
119 python_minimal_version="${python_minimal_version:-${python_versions[0]}}"
120 python_maximal_version="${python_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
121 _append_accepted_versions_range
122 fi
123 else
124 if [[ "${python3}" == "1" ]]; then
125 if [[ -z "${python3_minimal_version}" && -z "${python3_maximal_version}" ]]; then
126 _PYTHON_ATOMS+=("=dev-lang/python-3*")
127 else
128 python_versions=("${_CPYTHON3_SUPPORTED_ABIS[@]}")
129 python_minimal_version="${python3_minimal_version:-${python_versions[0]}}"
130 python_maximal_version="${python3_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
131 _append_accepted_versions_range
132 fi
133 fi
134 if [[ "${python2}" == "1" ]]; then
135 if [[ -z "${python2_minimal_version}" && -z "${python2_maximal_version}" ]]; then
136 _PYTHON_ATOMS+=("=dev-lang/python-2*")
137 else
138 python_versions=("${_CPYTHON2_SUPPORTED_ABIS[@]}")
139 python_minimal_version="${python2_minimal_version:-${python_versions[0]}}"
140 python_maximal_version="${python2_maximal_version:-${python_versions[${#python_versions[@]}-1]}}"
141 _append_accepted_versions_range
142 fi
143 fi
144 fi
145
146 unset -f _append_accepted_versions_range
147
148 if [[ "${#_PYTHON_ATOMS[@]}" -gt 1 ]]; then
149 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
150 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }|| ( ${_PYTHON_ATOMS[@]} )${USE_flag:+ )}"
151 else
152 DEPEND+="${DEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
153 RDEPEND+="${RDEPEND:+ }${USE_flag}${USE_flag:+? ( }${_PYTHON_ATOMS[@]}${USE_flag:+ )}"
154 fi
155 else
156 die "Invalid syntax of PYTHON_DEPEND"
157 fi
158}
159
160DEPEND=">=app-admin/eselect-python-20091230"
161RDEPEND="${DEPEND}"
162
163if [[ -n "${PYTHON_DEPEND}" ]]; then
164 _python_parse_PYTHON_DEPEND
165else
166 _PYTHON_ATOMS=("dev-lang/python")
167fi
168unset -f _python_parse_PYTHON_DEPEND
169
18if [[ -n "${NEED_PYTHON}" ]]; then 170if [[ -n "${NEED_PYTHON}" ]]; then
19 PYTHON_ATOM=">=dev-lang/python-${NEED_PYTHON}" 171 eerror "Use PYTHON_DEPEND variable instead of NEED_PYTHON variable."
20 DEPEND="${PYTHON_ATOM}" 172 die "NEED_PYTHON variable is banned"
21 RDEPEND="${DEPEND}"
22else
23 PYTHON_ATOM="dev-lang/python"
24fi 173fi
25 174
26DEPEND+=" >=app-admin/eselect-python-20090804" 175# @ECLASS-VARIABLE: PYTHON_USE_WITH
27
28__python_eclass_test() {
29 __python_version_extract 2.3
30 echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
31 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
32 __python_version_extract 2.3.4
33 echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
34 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
35 __python_version_extract 2.3.5
36 echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
37 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
38 __python_version_extract 2.4
39 echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
40 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
41 __python_version_extract 2.5b3
42 echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
43 echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
44}
45
46# @FUNCTION: python_version
47# @DESCRIPTION: 176# @DESCRIPTION:
48# Run without arguments and it will export the version of python 177# Set this to a space separated list of USE flags the Python slot in use must be built with.
49# currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
50__python_version_extract() {
51 local verstr=$1
52 export PYVER_MAJOR=${verstr:0:1}
53 export PYVER_MINOR=${verstr:2:1}
54 if [[ ${verstr:3:1} == . ]]; then
55 export PYVER_MICRO=${verstr:4}
56 fi
57 export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
58}
59 178
60python_version() { 179# @ECLASS-VARIABLE: PYTHON_USE_WITH_OR
61 [[ -n "${PYVER}" ]] && return 0
62 local tmpstr
63 python=${python:-/usr/bin/python}
64 tmpstr="$(EPYTHON= ${python} -V 2>&1 )"
65 export PYVER_ALL="${tmpstr#Python }"
66 __python_version_extract $PYVER_ALL
67}
68
69# @FUNCTION: PYTHON
70# @USAGE: [-2] [-3] [--ABI] [-A|--active] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}">
71# @DESCRIPTION: 180# @DESCRIPTION:
72# Get Python interpreter filename for specified Python ABI. If Python_ABI argument 181# Set this to a space separated list of USE flags of which one must be turned on for the slot in use.
73# is ommitted, then PYTHON_ABI environment variable must be set and is used.
74# If -2 option is specified, then active version of Python 2 is used.
75# If -3 option is specified, then active version of Python 3 is used.
76# If --active option is specified, then active version of Python is used.
77# Active version of Python can be set by python_set_active_version().
78# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
79# -2, -3, --active and --final-ABI options and Python_ABI argument cannot be specified simultaneously.
80# If --ABI option is specified, then only specified Python ABI is printed instead of
81# Python interpreter filename.
82# --ABI and --absolute-path options cannot be specified simultaneously.
83PYTHON() {
84 local ABI_output="0" absolute_path_output="0" active="0" final_ABI="0" python2="0" python3="0" slot=
85 182
86 while (($#)); do 183# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT
87 case "$1" in 184# @DESCRIPTION:
88 -2) 185# Set this to a name of a USE flag if you need to make either PYTHON_USE_WITH or
89 python2="1" 186# PYTHON_USE_WITH_OR atoms conditional under a USE flag.
90 ;; 187
91 -3) 188if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
92 python3="1" 189 _PYTHON_USE_WITH_ATOMS_ARRAY=()
93 ;; 190 if [[ -n "${PYTHON_USE_WITH}" ]]; then
94 --ABI) 191 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
95 ABI_output="1" 192 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${PYTHON_USE_WITH// /,}]")
96 ;;
97 -A|--active)
98 active="1"
99 ;;
100 -a|--absolute-path)
101 absolute_path_output="1"
102 ;;
103 -f|--final-ABI)
104 final_ABI="1"
105 ;;
106 --)
107 break
108 ;;
109 -*)
110 die "${FUNCNAME}(): Unrecognized option '$1'"
111 ;;
112 *)
113 break
114 ;;
115 esac
116 shift
117 done 193 done
118
119 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then
120 die "${FUNCNAME}(): '--ABI and '--absolute-path' options cannot be specified simultaneously"
121 fi
122
123 if [[ "$((${python2} + ${python3} + ${active} + ${final_ABI}))" -gt 1 ]]; then
124 die "${FUNCNAME}(): '-2', '-3', '--active' or '--final-ABI' options cannot be specified simultaneously"
125 fi
126
127 if [[ "$#" -eq 0 ]]; then
128 if [[ "${active}" == "1" ]]; then
129 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
130 die "${FUNCNAME}(): '--active' option cannot be used in ebuilds of packages supporting installation for multiple versions of Python"
131 fi
132 slot="$(/usr/bin/python -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')"
133 elif [[ "${final_ABI}" == "1" ]]; then
134 validate_PYTHON_ABIS
135 slot="${PYTHON_ABIS##* }"
136 elif [[ "${python2}" == "1" ]]; then
137 slot="$(eselect python show --python2)"
138 if [[ -z "${slot}" ]]; then
139 die "${FUNCNAME}(): Active Python 2 interpreter not set"
140 elif [[ "${slot}" != "python2."* ]]; then
141 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`"
142 fi
143 slot="${slot#python}"
144 elif [[ "${python3}" == "1" ]]; then
145 slot="$(eselect python show --python3)"
146 if [[ -z "${slot}" ]]; then
147 die "${FUNCNAME}(): Active Python 3 interpreter not set"
148 elif [[ "${slot}" != "python3."* ]]; then
149 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`"
150 fi
151 slot="${slot#python}"
152 elif [[ -n "${PYTHON_ABI}" ]]; then 194 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then
153 slot="${PYTHON_ABI}" 195 for _USE_flag in ${PYTHON_USE_WITH_OR}; do
196 for _PYTHON_ATOM in "${_PYTHON_ATOMS[@]}"; do
197 _PYTHON_USE_WITH_ATOMS_ARRAY+=("${_PYTHON_ATOM}[${_USE_flag}]")
198 done
199 done
200 unset _USE_flag
201 fi
202 if [[ "${#_PYTHON_USE_WITH_ATOMS_ARRAY[@]}" -gt 1 ]]; then
203 _PYTHON_USE_WITH_ATOMS="|| ( ${_PYTHON_USE_WITH_ATOMS_ARRAY[@]} )"
154 else 204 else
155 die "${FUNCNAME}(): Invalid usage" 205 _PYTHON_USE_WITH_ATOMS="${_PYTHON_USE_WITH_ATOMS_ARRAY[@]}"
156 fi 206 fi
157 elif [[ "$#" -eq 1 ]]; then 207 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then
158 if [[ "${active}" == "1" ]]; then 208 _PYTHON_USE_WITH_ATOMS="${PYTHON_USE_WITH_OPT}? ( ${_PYTHON_USE_WITH_ATOMS} )"
159 die "${FUNCNAME}(): '--active' option and Python ABI cannot be specified simultaneously"
160 fi 209 fi
161 if [[ "${final_ABI}" == "1" ]]; then 210 DEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
162 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously" 211 RDEPEND+=" ${_PYTHON_USE_WITH_ATOMS}"
163 fi 212 unset _PYTHON_ATOM _PYTHON_USE_WITH_ATOMS _PYTHON_USE_WITH_ATOMS_ARRAY
164 if [[ "${python2}" == "1" ]]; then
165 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously"
166 fi
167 if [[ "${python3}" == "1" ]]; then
168 die "${FUNCNAME}(): '-3' option and Python ABI cannot be specified simultaneously"
169 fi
170 slot="$1"
171 else
172 die "${FUNCNAME}(): Invalid usage"
173 fi 213fi
174 214
175 if [[ "${ABI_output}" == "1" ]]; then 215unset _PYTHON_ATOMS
176 echo -n "${slot}"
177 return
178 elif [[ "${absolute_path_output}" == "1" ]]; then
179 echo -n "/usr/bin/python${slot}"
180 else
181 echo -n "python${slot}"
182 fi
183 216
184 if [[ -n "${ABI}" && "${ABI}" != "${DEFAULT_ABI}" && "${DEFAULT_ABI}" != "default" ]]; then 217# ================================================================================================
185 echo -n "-${ABI}" 218# =================================== MISCELLANEOUS FUNCTIONS ====================================
186 fi 219# ================================================================================================
187}
188 220
189_python_implementation() { 221_python_implementation() {
190 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then 222 if [[ "${CATEGORY}/${PN}" == "dev-lang/python" ]]; then
191 return 0 223 return 0
224 elif [[ "${CATEGORY}/${PN}" == "dev-java/jython" ]]; then
225 return 0
192 else 226 else
193 return 1 227 return 1
194 fi 228 fi
195} 229}
196 230
197# @FUNCTION: python_set_active_version 231_python_package_supporting_installation_for_multiple_python_abis() {
198# @USAGE: <Python_ABI|2|3> 232 if [[ "${EBUILD_PHASE}" == "depend" ]]; then
199# @DESCRIPTION: 233 die "${FUNCNAME}() cannot be used in global scope"
200# Set active version of Python.
201python_set_active_version() {
202 if [[ "$#" -ne "1" ]]; then
203 die "${FUNCNAME}() requires 1 argument"
204 fi
205
206 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
207 if ! _python_implementation && ! has_version "dev-lang/python:$1"; then
208 die "${FUNCNAME}(): 'dev-lang/python:$1' is not installed"
209 fi 234 fi
210 export EPYTHON="$(PYTHON "$1")" 235
211 elif [[ "$1" == "2" ]]; then 236 if has "${EAPI:-0}" 0 1 2 3 4; then
212 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then 237 if [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
213 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed" 238 return 0
214 fi
215 export EPYTHON="$(PYTHON -2)"
216 elif [[ "$1" == "3" ]]; then
217 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then
218 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed"
219 fi
220 export EPYTHON="$(PYTHON -3)"
221 else 239 else
222 die "${FUNCNAME}(): Unrecognized argument '$1'" 240 return 1
223 fi 241 fi
224 242 else
225 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses, 243 die "${FUNCNAME}(): Support for EAPI=\"${EAPI}\" not implemented"
226 # so it does not need to be exported to subprocesses. 244 fi
227 PYTHON_ABI="${EPYTHON#python}"
228 PYTHON_ABI="${PYTHON_ABI%%-*}"
229} 245}
230 246
231unset PYTHON_ABIS 247_python_abi-specific_local_scope() {
232unset PYTHON_ABIS_SANITY_CHECKS 248 [[ " ${FUNCNAME[@]:2} " =~ " "(_python_final_sanity_checks|python_execute_function|python_mod_optimize|python_mod_cleanup)" " ]]
249}
233 250
234# @FUNCTION: validate_PYTHON_ABIS 251_python_initialize_prefix_variables() {
235# @DESCRIPTION: 252 if has "${EAPI:-0}" 0 1 2; then
236# Ensure that PYTHON_ABIS variable has valid value. 253 if [[ -n "${ROOT}" && -z "${EROOT}" ]]; then
237validate_PYTHON_ABIS() { 254 EROOT="${ROOT%/}${EPREFIX}/"
238 # Ensure that some functions cannot be accidentally successfully used in EAPI <= 2 without setting SUPPORT_PYTHON_ABIS variable.
239 if has "${EAPI:-0}" 0 1 2 && [[ -z "${SUPPORT_PYTHON_ABIS}" ]]; then
240 die "${FUNCNAME}() cannot be used in this EAPI without setting SUPPORT_PYTHON_ABIS variable"
241 fi 255 fi
256 if [[ -n "${D}" && -z "${ED}" ]]; then
257 ED="${D%/}${EPREFIX}/"
258 fi
259 fi
260}
242 261
262unset PYTHON_SANITY_CHECKS_EXECUTED PYTHON_SKIP_SANITY_CHECKS
263
264_python_initial_sanity_checks() {
265 if [[ "$(declare -p PYTHON_SANITY_CHECKS_EXECUTED 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS_EXECUTED="* || " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " && -z "${PYTHON_SKIP_SANITY_CHECKS}" ]]; then
243 # Ensure that /usr/bin/python and /usr/bin/python-config are valid. 266 # Ensure that /usr/bin/python and /usr/bin/python-config are valid.
244 if [[ "$(readlink /usr/bin/python)" != "python-wrapper" ]]; then 267 if [[ "$(readlink "${EPREFIX}/usr/bin/python")" != "python-wrapper" ]]; then
245 eerror "'/usr/bin/python' is not valid symlink." 268 eerror "'${EPREFIX}/usr/bin/python' is not valid symlink."
246 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem." 269 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
247 die "'/usr/bin/python' is not valid symlink" 270 die "'${EPREFIX}/usr/bin/python' is not valid symlink"
248 fi 271 fi
249 if [[ "$(</usr/bin/python-config)" != *"Gentoo python-config wrapper script"* ]]; then 272 if [[ "$(<"${EPREFIX}/usr/bin/python-config")" != *"Gentoo python-config wrapper script"* ]]; then
250 eerror "'/usr/bin/python-config' is not valid script" 273 eerror "'${EPREFIX}/usr/bin/python-config' is not valid script"
251 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem." 274 eerror "Use \`eselect python set \${python_interpreter}\` to fix this problem."
252 die "'/usr/bin/python-config' is not valid script" 275 die "'${EPREFIX}/usr/bin/python-config' is not valid script"
253 fi 276 fi
277 fi
278}
254 279
255 # USE_${ABI_TYPE^^} and RESTRICT_${ABI_TYPE^^}_ABIS variables hopefully will be included in EAPI >= 5. 280_python_final_sanity_checks() {
281 if ! _python_implementation && [[ "$(declare -p PYTHON_SANITY_CHECKS_EXECUTED 2> /dev/null)" != "declare -- PYTHON_SANITY_CHECKS_EXECUTED="* || " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " && -z "${PYTHON_SKIP_SANITY_CHECKS}" ]]; then
282 local PYTHON_ABI="${PYTHON_ABI}"
283 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI}}; do
284 # Ensure that appropriate version of Python is installed.
285 if ! has_version "$(python_get_implementational_package)"; then
286 die "$(python_get_implementational_package) is not installed"
287 fi
288
289 # Ensure that EPYTHON variable is respected.
290 if [[ "$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")" != "${PYTHON_ABI}" ]]; then
291 eerror "Path to 'python': '$(type -p python)'"
292 eerror "ABI: '${ABI}'"
293 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
294 eerror "EPYTHON: '$(PYTHON)'"
295 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
296 eerror "Locally active version of Python: '$(EPYTHON="$(PYTHON)" python -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")'"
297 die "'python' does not respect EPYTHON variable"
298 fi
299 done
300 fi
301 PYTHON_SANITY_CHECKS_EXECUTED="1"
302}
303
304# @ECLASS-VARIABLE: PYTHON_COLORS
305# @DESCRIPTION:
306# User-configurable colored output.
307PYTHON_COLORS="${PYTHON_COLORS:-0}"
308
309_python_set_color_variables() {
310 if [[ "${PYTHON_COLORS}" != "0" && "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
311 _BOLD=$'\e[1m'
312 _RED=$'\e[1;31m'
313 _GREEN=$'\e[1;32m'
314 _BLUE=$'\e[1;34m'
315 _CYAN=$'\e[1;36m'
316 _NORMAL=$'\e[0m'
317 else
318 _BOLD=
319 _RED=
320 _GREEN=
321 _BLUE=
322 _CYAN=
323 _NORMAL=
324 fi
325}
326
327unset PYTHON_PKG_SETUP_EXECUTED
328
329_python_check_python_pkg_setup_execution() {
330 [[ " ${FUNCNAME[@]:1} " =~ " "(python_set_active_version|python_pkg_setup)" " ]] && return
331
332 if ! has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_PKG_SETUP_EXECUTED}" ]]; then
333 die "python_pkg_setup() not called"
334 fi
335}
336
337# @FUNCTION: python_pkg_setup
338# @DESCRIPTION:
339# Perform sanity checks and initialize environment.
340#
341# This function is exported in EAPI 2 and 3 when PYTHON_USE_WITH or PYTHON_USE_WITH_OR variable
342# is set and always in EAPI >=4. Calling of this function is mandatory in EAPI >=4.
343#
344# This function can be used only in pkg_setup() phase.
345python_pkg_setup() {
346 # Check if phase is pkg_setup().
347 [[ "${EBUILD_PHASE}" != "setup" ]] && die "${FUNCNAME}() can be used only in pkg_setup() phase"
348
349 if [[ "$#" -ne 0 ]]; then
350 die "${FUNCNAME}() does not accept arguments"
351 fi
352
353 if _python_package_supporting_installation_for_multiple_python_abis; then
354 _python_calculate_PYTHON_ABIS
355 export EPYTHON="$(PYTHON -f)"
356 else
357 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
358 fi
359
360 if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; then
361 if [[ "${PYTHON_USE_WITH_OPT}" ]]; then
362 if [[ "${PYTHON_USE_WITH_OPT}" == !* ]]; then
363 use ${PYTHON_USE_WITH_OPT#!} && return
364 else
365 use !${PYTHON_USE_WITH_OPT} && return
366 fi
367 fi
368
369 python_pkg_setup_check_USE_flags() {
370 local python_atom USE_flag
371 python_atom="$(python_get_implementational_package)"
372
373 for USE_flag in ${PYTHON_USE_WITH}; do
374 if ! has_version "${python_atom}[${USE_flag}]"; then
375 eerror "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
376 die "Please rebuild ${python_atom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
377 fi
378 done
379
380 for USE_flag in ${PYTHON_USE_WITH_OR}; do
381 if has_version "${python_atom}[${USE_flag}]"; then
382 return
383 fi
384 done
385
386 if [[ ${PYTHON_USE_WITH_OR} ]]; then
387 eerror "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
388 die "Please rebuild ${python_atom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}"
389 fi
390 }
391
392 if _python_package_supporting_installation_for_multiple_python_abis; then
393 PYTHON_SKIP_SANITY_CHECKS="1" python_execute_function -q python_pkg_setup_check_USE_flags
394 else
395 python_pkg_setup_check_USE_flags
396 fi
397
398 unset -f python_pkg_setup_check_USE_flags
399 fi
400
401 PYTHON_PKG_SETUP_EXECUTED="1"
402}
403
404if ! has "${EAPI:-0}" 0 1 2 3 || { has "${EAPI:-0}" 2 3 && [[ -n "${PYTHON_USE_WITH}" || -n "${PYTHON_USE_WITH_OR}" ]]; }; then
405 EXPORT_FUNCTIONS pkg_setup
406fi
407
408# @FUNCTION: python_convert_shebangs
409# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_version> <file|directory> [files|directories]
410# @DESCRIPTION:
411# Convert shebangs in specified files. Directories can be specified only with --recursive option.
412python_convert_shebangs() {
413 _python_check_python_pkg_setup_execution
414
415 local argument file files=() only_executables="0" python_version quiet="0" recursive="0"
416
417 while (($#)); do
418 case "$1" in
419 -r|--recursive)
420 recursive="1"
421 ;;
422 -q|--quiet)
423 quiet="1"
424 ;;
425 -x|--only-executables)
426 only_executables="1"
427 ;;
428 --)
429 shift
430 break
431 ;;
432 -*)
433 die "${FUNCNAME}(): Unrecognized option '$1'"
434 ;;
435 *)
436 break
437 ;;
438 esac
439 shift
440 done
441
442 if [[ "$#" -eq 0 ]]; then
443 die "${FUNCNAME}(): Missing Python version and files or directories"
444 elif [[ "$#" -eq 1 ]]; then
445 die "${FUNCNAME}(): Missing files or directories"
446 fi
447
448 python_version="$1"
449 shift
450
451 for argument in "$@"; do
452 if [[ ! -e "${argument}" ]]; then
453 die "${FUNCNAME}(): '${argument}' does not exist"
454 elif [[ -f "${argument}" ]]; then
455 files+=("${argument}")
456 elif [[ -d "${argument}" ]]; then
457 if [[ "${recursive}" == "1" ]]; then
458 while read -d $'\0' -r file; do
459 files+=("${file}")
460 done < <(find "${argument}" $([[ "${only_executables}" == "1" ]] && echo -perm /111) -type f -print0)
461 else
462 die "${FUNCNAME}(): '${argument}' is not a regular file"
463 fi
464 else
465 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory"
466 fi
467 done
468
469 for file in "${files[@]}"; do
470 file="${file#./}"
471 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
472
473 if [[ "$(head -n1 "${file}")" =~ ^'#!'.*python ]]; then
474 [[ "$(sed -ne "2p" "${file}")" =~ ^"# Gentoo '".*"' wrapper script generated by python_generate_wrapper_scripts()"$ ]] && continue
475
476 if [[ "${quiet}" == "0" ]]; then
477 einfo "Converting shebang in '${file}'"
478 fi
479
480 sed -e "1s/python\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?/python${python_version}/" -i "${file}" || die "Conversion of shebang in '${file}' failed"
481
482 # Delete potential whitespace after "#!".
483 sed -e '1s/\(^#!\)[[:space:]]*/\1/' -i "${file}" || die "sed '${file}' failed"
484 fi
485 done
486}
487
488# @FUNCTION: python_clean_installation_image
489# @USAGE: [-q|--quiet]
490# @DESCRIPTION:
491# Delete needless files in installation image.
492python_clean_installation_image() {
493 _python_check_python_pkg_setup_execution
494 _python_initialize_prefix_variables
495
496 local file files=() quiet="0"
497
498 # Check if phase is src_install().
499 [[ "${EBUILD_PHASE}" != "install" ]] && die "${FUNCNAME}() can be used only in src_install() phase"
500
501 while (($#)); do
502 case "$1" in
503 -q|--quiet)
504 quiet="1"
505 ;;
506 -*)
507 die "${FUNCNAME}(): Unrecognized option '$1'"
508 ;;
509 *)
510 die "${FUNCNAME}(): Invalid usage"
511 ;;
512 esac
513 shift
514 done
515
516 while read -d $'\0' -r file; do
517 files+=("${file}")
518 done < <(find "${ED}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -type f -print0)
519
520 if [[ "${#files[@]}" -gt 0 ]]; then
521 if [[ "${quiet}" == "0" ]]; then
522 ewarn "Deleting byte-compiled Python modules needlessly generated by build system:"
523 fi
524 for file in "${files[@]}"; do
525 if [[ "${quiet}" == "0" ]]; then
526 ewarn " ${file}"
527 fi
528 rm -f "${file}"
529
530 # Delete empty __pycache__ directories.
531 if [[ "${file%/*}" == *"/__pycache__" ]]; then
532 rmdir "${file%/*}" 2> /dev/null
533 fi
534 done
535 fi
536
537 python_clean_sitedirs() {
538 if [[ -d "${ED}$(python_get_sitedir)" ]]; then
539 find "${ED}$(python_get_sitedir)" "(" -name "*.c" -o -name "*.h" -o -name "*.la" ")" -type f -print0 | xargs -0 rm -f
540 fi
541 }
542 if _python_package_supporting_installation_for_multiple_python_abis; then
543 python_execute_function -q python_clean_sitedirs
544 else
545 python_clean_sitedirs
546 fi
547
548 unset -f python_clean_sitedirs
549}
550
551# ================================================================================================
552# =========== FUNCTIONS FOR PACKAGES SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ============
553# ================================================================================================
554
555# @ECLASS-VARIABLE: SUPPORT_PYTHON_ABIS
556# @DESCRIPTION:
557# Set this in EAPI <= 4 to indicate that current package supports installation for
558# multiple Python ABIs.
559
560# @ECLASS-VARIABLE: PYTHON_EXPORT_PHASE_FUNCTIONS
561# @DESCRIPTION:
562# Set this to export phase functions for the following ebuild phases:
563# src_prepare, src_configure, src_compile, src_test, src_install.
564if ! has "${EAPI:-0}" 0 1; then
565 python_src_prepare() {
566 _python_check_python_pkg_setup_execution
567
568 if ! _python_package_supporting_installation_for_multiple_python_abis; then
569 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
570 fi
571
572 if [[ "$#" -ne 0 ]]; then
573 die "${FUNCNAME}() does not accept arguments"
574 fi
575
576 python_copy_sources
577 }
578
579 for python_default_function in src_configure src_compile src_test src_install; do
580 eval "python_${python_default_function}() {
581 _python_check_python_pkg_setup_execution
582
583 if ! _python_package_supporting_installation_for_multiple_python_abis; then
584 die \"\${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs\"
585 fi
586
587 python_execute_function -d -s -- \"\$@\"
588 }"
589 done
590 unset python_default_function
591
592 if [[ -n "${PYTHON_EXPORT_PHASE_FUNCTIONS}" ]]; then
593 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install
594 fi
595fi
596
597if has "${EAPI:-0}" 0 1 2 3; then
598 unset PYTHON_ABIS
599fi
600
601_python_calculate_PYTHON_ABIS() {
602 if ! _python_package_supporting_installation_for_multiple_python_abis; then
603 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
604 fi
605
606 _python_initial_sanity_checks
607
256 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3 4; then 608 if [[ "$(declare -p PYTHON_ABIS 2> /dev/null)" != "declare -x PYTHON_ABIS="* ]] && has "${EAPI:-0}" 0 1 2 3; then
257 local PYTHON_ABI python2_supported_versions python3_supported_versions restricted_ABI support_ABI supported_PYTHON_ABIS= 609 local PYTHON_ABI restricted_ABI restricted_ABIs support_ABI supported_PYTHON_ABIS
258 PYTHON_ABI_SUPPORTED_VALUES="2.4 2.5 2.6 2.7 3.0 3.1 3.2" 610
259 python2_supported_versions="2.4 2.5 2.6 2.7" 611 restricted_ABIs="${RESTRICT_PYTHON_ABIS// /$'\n'}"
260 python3_supported_versions="3.0 3.1 3.2"
261 612
262 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then 613 if [[ "$(declare -p USE_PYTHON 2> /dev/null)" == "declare -x USE_PYTHON="* ]]; then
263 local python2_enabled="0" python3_enabled="0" 614 local cpython_enabled="0"
264 615
265 if [[ -z "${USE_PYTHON}" ]]; then 616 if [[ -z "${USE_PYTHON}" ]]; then
266 die "USE_PYTHON variable is empty" 617 die "USE_PYTHON variable is empty"
267 fi 618 fi
268 619
269 for PYTHON_ABI in ${USE_PYTHON}; do 620 for PYTHON_ABI in ${USE_PYTHON}; do
270 if ! has "${PYTHON_ABI}" ${PYTHON_ABI_SUPPORTED_VALUES}; then 621 if ! has "${PYTHON_ABI}" ${_PYTHON_SUPPORTED_ABIS[@]}; then
271 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'" 622 die "USE_PYTHON variable contains invalid value '${PYTHON_ABI}'"
272 fi 623 fi
273 624
274 if has "${PYTHON_ABI}" ${python2_supported_versions}; then 625 if has "${PYTHON_ABI}" "${_CPYTHON2_SUPPORTED_ABIS[@]}" "${_CPYTHON3_SUPPORTED_ABIS[@]}"; then
275 python2_enabled="1" 626 cpython_enabled="1"
276 fi
277 if has "${PYTHON_ABI}" ${python3_supported_versions}; then
278 python3_enabled="1"
279 fi 627 fi
280 628
281 support_ABI="1" 629 support_ABI="1"
282 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 630 while read restricted_ABI; do
283 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then 631 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
284 support_ABI="0" 632 support_ABI="0"
285 break 633 break
286 fi 634 fi
287 done 635 done <<< "${restricted_ABIs}"
288 [[ "${support_ABI}" == "1" ]] && export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}" 636 [[ "${support_ABI}" == "1" ]] && export PYTHON_ABIS+="${PYTHON_ABIS:+ }${PYTHON_ABI}"
289 done 637 done
290 638
291 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then 639 if [[ -z "${PYTHON_ABIS//[${IFS}]/}" ]]; then
292 die "USE_PYTHON variable does not enable any version of Python supported by ${CATEGORY}/${PF}" 640 die "USE_PYTHON variable does not enable any Python ABI supported by ${CATEGORY}/${PF}"
293 fi 641 fi
294 642
295 if [[ "${python2_enabled}" == "0" ]]; then 643 if [[ "${cpython_enabled}" == "0" ]]; then
296 ewarn "USE_PYTHON variable does not enable any version of Python 2. This configuration is unsupported." 644 die "USE_PYTHON variable does not enable any CPython ABI"
297 fi
298 if [[ "${python3_enabled}" == "0" ]]; then
299 ewarn "USE_PYTHON variable does not enable any version of Python 3. This configuration is unsupported."
300 fi 645 fi
301 else 646 else
302 local python_version python2_version= python3_version= support_python_major_version 647 local python_version python2_version= python3_version= support_python_major_version
303 648
649 if ! has_version "dev-lang/python"; then
650 die "${FUNCNAME}(): 'dev-lang/python' is not installed"
651 fi
652
304 python_version="$(/usr/bin/python -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')" 653 python_version="$("${EPREFIX}/usr/bin/python" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
305 654
306 if has_version "=dev-lang/python-2*"; then 655 if has_version "=dev-lang/python-2*"; then
307 if [[ "$(readlink /usr/bin/python2)" != "python2."* ]]; then 656 if [[ "$(readlink "${EPREFIX}/usr/bin/python2")" != "python2."* ]]; then
308 die "'/usr/bin/python2' is not valid symlink" 657 die "'${EPREFIX}/usr/bin/python2' is not valid symlink"
309 fi 658 fi
310 659
311 python2_version="$(/usr/bin/python2 -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')" 660 python2_version="$("${EPREFIX}/usr/bin/python2" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
312 661
313 for PYTHON_ABI in ${python2_supported_versions}; do 662 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do
314 support_python_major_version="1" 663 support_python_major_version="1"
315 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 664 while read restricted_ABI; do
316 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then 665 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
317 support_python_major_version="0" 666 support_python_major_version="0"
318 fi 667 fi
319 done 668 done <<< "${restricted_ABIs}"
320 [[ "${support_python_major_version}" == "1" ]] && break 669 [[ "${support_python_major_version}" == "1" ]] && break
321 done 670 done
322 if [[ "${support_python_major_version}" == "1" ]]; then 671 if [[ "${support_python_major_version}" == "1" ]]; then
323 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 672 while read restricted_ABI; do
324 if [[ "${python2_version}" == ${restricted_ABI} ]]; then 673 if [[ "${python2_version}" == ${restricted_ABI} ]]; then
325 die "Active version of Python 2 is not supported by ${CATEGORY}/${PF}" 674 die "Active version of Python 2 is not supported by ${CATEGORY}/${PF}"
326 fi 675 fi
327 done 676 done <<< "${restricted_ABIs}"
328 else 677 else
329 python2_version="" 678 python2_version=""
330 fi 679 fi
331 fi 680 fi
332 681
333 if has_version "=dev-lang/python-3*"; then 682 if has_version "=dev-lang/python-3*"; then
334 if [[ "$(readlink /usr/bin/python3)" != "python3."* ]]; then 683 if [[ "$(readlink "${EPREFIX}/usr/bin/python3")" != "python3."* ]]; then
335 die "'/usr/bin/python3' is not valid symlink" 684 die "'${EPREFIX}/usr/bin/python3' is not valid symlink"
336 fi 685 fi
337 686
338 python3_version="$(/usr/bin/python3 -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')" 687 python3_version="$("${EPREFIX}/usr/bin/python3" -c 'from sys import version_info; print(".".join(str(x) for x in version_info[:2]))')"
339 688
340 for PYTHON_ABI in ${python3_supported_versions}; do 689 for PYTHON_ABI in "${_CPYTHON3_SUPPORTED_ABIS[@]}"; do
341 support_python_major_version="1" 690 support_python_major_version="1"
342 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 691 while read restricted_ABI; do
343 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then 692 if [[ "${PYTHON_ABI}" == ${restricted_ABI} ]]; then
344 support_python_major_version="0" 693 support_python_major_version="0"
345 fi 694 fi
346 done 695 done <<< "${restricted_ABIs}"
347 [[ "${support_python_major_version}" == "1" ]] && break 696 [[ "${support_python_major_version}" == "1" ]] && break
348 done 697 done
349 if [[ "${support_python_major_version}" == "1" ]]; then 698 if [[ "${support_python_major_version}" == "1" ]]; then
350 for restricted_ABI in ${RESTRICT_PYTHON_ABIS}; do 699 while read restricted_ABI; do
351 if [[ "${python3_version}" == ${restricted_ABI} ]]; then 700 if [[ "${python3_version}" == ${restricted_ABI} ]]; then
352 die "Active version of Python 3 is not supported by ${CATEGORY}/${PF}" 701 die "Active version of Python 3 is not supported by ${CATEGORY}/${PF}"
353 fi 702 fi
354 done 703 done <<< "${restricted_ABIs}"
355 else 704 else
356 python3_version="" 705 python3_version=""
357 fi 706 fi
358 fi 707 fi
359 708
360 if [[ -n "${python2_version}" && "${python_version}" == "2."* && "${python_version}" != "${python2_version}" ]]; then 709 if [[ -n "${python2_version}" && "${python_version}" == "2."* && "${python_version}" != "${python2_version}" ]]; then
361 eerror "Python wrapper is configured incorrectly or /usr/bin/python2 symlink" 710 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python2' symlink"
362 eerror "is set incorrectly. Use \`eselect python\` to fix configuration." 711 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
363 die "Incorrect configuration of Python" 712 die "Incorrect configuration of Python"
364 fi 713 fi
365 if [[ -n "${python3_version}" && "${python_version}" == "3."* && "${python_version}" != "${python3_version}" ]]; then 714 if [[ -n "${python3_version}" && "${python_version}" == "3."* && "${python_version}" != "${python3_version}" ]]; then
366 eerror "Python wrapper is configured incorrectly or /usr/bin/python3 symlink" 715 eerror "Python wrapper is configured incorrectly or '${EPREFIX}/usr/bin/python3' symlink"
367 eerror "is set incorrectly. Use \`eselect python\` to fix configuration." 716 eerror "is set incorrectly. Use \`eselect python\` to fix configuration."
368 die "Incorrect configuration of Python" 717 die "Incorrect configuration of Python"
369 fi 718 fi
370 719
371 PYTHON_ABIS="${python2_version} ${python3_version}" 720 PYTHON_ABIS="${python2_version} ${python3_version}"
372 PYTHON_ABIS="${PYTHON_ABIS# }" 721 PYTHON_ABIS="${PYTHON_ABIS# }"
373 export PYTHON_ABIS="${PYTHON_ABIS% }" 722 export PYTHON_ABIS="${PYTHON_ABIS% }"
374 fi 723 fi
375 fi 724 fi
376 725
377 if ! _python_implementation && [[ "$(declare -p PYTHON_ABIS_SANITY_CHECKS 2> /dev/null)" != "declare -- PYTHON_ABIS_SANITY_CHECKS="* ]]; then 726 _python_final_sanity_checks
378 local PYTHON_ABI 727}
379 for PYTHON_ABI in ${PYTHON_ABIS}; do 728
380 # Ensure that appropriate version of Python is installed. 729_python_prepare_flags() {
381 if ! has_version "dev-lang/python:${PYTHON_ABI}"; then 730 local array=() deleted_flag element flags new_value old_flag old_value operator pattern prefix variable
382 die "dev-lang/python:${PYTHON_ABI} is not installed" 731
732 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
733 eval "_PYTHON_SAVED_${variable}=\"\${!variable}\""
734 for prefix in PYTHON_USER_ PYTHON_; do
735 if [[ "$(declare -p ${prefix}${variable} 2> /dev/null)" == "declare -a ${prefix}${variable}="* ]]; then
736 eval "array=(\"\${${prefix}${variable}[@]}\")"
737 for element in "${array[@]}"; do
738 if [[ "${element}" =~ ^([[:alnum:]]|\.|-|\*|\[|\])+\ (\+|-)\ .+ ]]; then
739 pattern="${element%% *}"
740 element="${element#* }"
741 operator="${element%% *}"
742 flags="${element#* }"
743 if [[ "${PYTHON_ABI}" == ${pattern} ]]; then
744 if [[ "${operator}" == "+" ]]; then
745 eval "export ${variable}+=\"\${variable:+ }${flags}\""
746 elif [[ "${operator}" == "-" ]]; then
747 flags="${flags// /$'\n'}"
748 old_value="${!variable// /$'\n'}"
749 new_value=""
750 while read old_flag; do
751 while read deleted_flag; do
752 if [[ "${old_flag}" == ${deleted_flag} ]]; then
753 continue 2
754 fi
755 done <<< "${flags}"
756 new_value+="${new_value:+ }${old_flag}"
757 done <<< "${old_value}"
758 eval "export ${variable}=\"\${new_value}\""
759 fi
760 fi
761 else
762 die "Element '${element}' of ${prefix}${variable} array has invalid syntax"
383 fi 763 fi
384 764 done
385 # Ensure that EPYTHON variable is respected. 765 elif [[ -n "$(declare -p ${prefix}${variable} 2> /dev/null)" ]]; then
386 if [[ "$(EPYTHON="$(PYTHON)" python -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')" != "${PYTHON_ABI}" ]]; then 766 die "${prefix}${variable} should be indexed array"
387 eerror "python: '$(type -p python)'"
388 eerror "ABI: '${ABI}'"
389 eerror "DEFAULT_ABI: '${DEFAULT_ABI}'"
390 eerror "EPYTHON: '$(PYTHON)'"
391 eerror "PYTHON_ABI: '${PYTHON_ABI}'"
392 eerror "Version of enabled Python: '$(EPYTHON="$(PYTHON)" python -c 'from sys import version_info; print(".".join([str(x) for x in version_info[:2]]))')'"
393 die "'python' does not respect EPYTHON variable"
394 fi 767 fi
395 done 768 done
396 PYTHON_ABIS_SANITY_CHECKS="1"
397 fi
398}
399
400# @FUNCTION: python_copy_sources
401# @USAGE: [--no-link] [--] [directory]
402# @DESCRIPTION:
403# Copy unpacked sources of given package for each Python ABI.
404python_copy_sources() {
405 local dir dirs=() no_link="0" PYTHON_ABI
406
407 while (($#)); do
408 case "$1" in
409 --no-link)
410 no_link="1"
411 ;;
412 --)
413 break
414 ;;
415 -*)
416 die "${FUNCNAME}(): Unrecognized option '$1'"
417 ;;
418 *)
419 break
420 ;;
421 esac
422 shift
423 done
424
425 if [[ "$#" -eq 0 ]]; then
426 if [[ "${WORKDIR}" == "${S}" ]]; then
427 die "${FUNCNAME}() cannot be used"
428 fi
429 dirs="${S}"
430 else
431 dirs="$@"
432 fi
433
434 validate_PYTHON_ABIS
435 for PYTHON_ABI in ${PYTHON_ABIS}; do
436 for dir in "${dirs[@]}"; do
437 if [[ "${no_link}" == "1" ]]; then
438 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
439 else
440 cp -lpr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
441 fi
442 done 769 done
443 done
444} 770}
445 771
446# @FUNCTION: python_set_build_dir_symlink 772_python_restore_flags() {
447# @USAGE: [directory="build"] 773 local variable
448# @DESCRIPTION:
449# Create build directory symlink.
450python_set_build_dir_symlink() {
451 local dir="$1"
452 774
453 [[ -z "${PYTHON_ABI}" ]] && die "PYTHON_ABI variable not set" 775 for variable in CPPFLAGS CFLAGS CXXFLAGS LDFLAGS; do
454 [[ -z "${dir}" ]] && dir="build" 776 eval "${variable}=\"\${_PYTHON_SAVED_${variable}}\""
455 777 unset _PYTHON_SAVED_${variable}
456 # Do not delete preexistent directories. 778 done
457 rm -f "${dir}" || die "Deletion of '${dir}' failed"
458 ln -s "${dir}-${PYTHON_ABI}" "${dir}" || die "Creation of '${dir}' directory symlink failed"
459} 779}
460 780
461# @FUNCTION: python_execute_function 781# @FUNCTION: python_execute_function
462# @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--source-dir source_directory] [--] <function> [arguments] 782# @USAGE: [--action-message message] [-d|--default-function] [--failure-message message] [-f|--final-ABI] [--nonfatal] [-q|--quiet] [-s|--separate-build-dirs] [--source-dir source_directory] [--] <function> [arguments]
463# @DESCRIPTION: 783# @DESCRIPTION:
464# Execute specified function for each value of PYTHON_ABIS, optionally passing additional 784# Execute specified function for each value of PYTHON_ABIS, optionally passing additional
465# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables. 785# arguments. The specified function can use PYTHON_ABI and BUILDDIR variables.
466python_execute_function() { 786python_execute_function() {
467 local action action_message action_message_template= default_function="0" failure_message failure_message_template= function nonfatal="0" previous_directory previous_directory_stack previous_directory_stack_length PYTHON_ABI quiet="0" separate_build_dirs="0" source_dir= 787 _python_check_python_pkg_setup_execution
788
789 if ! _python_package_supporting_installation_for_multiple_python_abis; then
790 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
791 fi
792
793 _python_set_color_variables
794
795 local action action_message action_message_template= default_function="0" failure_message failure_message_template= final_ABI="0" function iterated_PYTHON_ABIS nonfatal="0" previous_directory previous_directory_stack previous_directory_stack_length PYTHON_ABI quiet="0" return_code separate_build_dirs="0" source_dir=
468 796
469 while (($#)); do 797 while (($#)); do
470 case "$1" in 798 case "$1" in
471 --action-message) 799 --action-message)
472 action_message_template="$2" 800 action_message_template="$2"
477 ;; 805 ;;
478 --failure-message) 806 --failure-message)
479 failure_message_template="$2" 807 failure_message_template="$2"
480 shift 808 shift
481 ;; 809 ;;
810 -f|--final-ABI)
811 final_ABI="1"
812 ;;
482 --nonfatal) 813 --nonfatal)
483 nonfatal="1" 814 nonfatal="1"
484 ;; 815 ;;
485 -q|--quiet) 816 -q|--quiet)
486 quiet="1" 817 quiet="1"
491 --source-dir) 822 --source-dir)
492 source_dir="$2" 823 source_dir="$2"
493 shift 824 shift
494 ;; 825 ;;
495 --) 826 --)
827 shift
496 break 828 break
497 ;; 829 ;;
498 -*) 830 -*)
499 die "${FUNCNAME}(): Unrecognized option '$1'" 831 die "${FUNCNAME}(): Unrecognized option '$1'"
500 ;; 832 ;;
518 850
519 if [[ -z "$(type -t "${function}")" ]]; then 851 if [[ -z "$(type -t "${function}")" ]]; then
520 die "${FUNCNAME}(): '${function}' function is not defined" 852 die "${FUNCNAME}(): '${function}' function is not defined"
521 fi 853 fi
522 else 854 else
523 if [[ "$#" -ne "0" ]]; then
524 die "${FUNCNAME}(): '--default-function' option and function name cannot be specified simultaneously"
525 fi
526 if has "${EAPI:-0}" 0 1; then 855 if has "${EAPI:-0}" 0 1; then
527 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI" 856 die "${FUNCNAME}(): '--default-function' option cannot be used in this EAPI"
528 fi 857 fi
529 858
530 if [[ "${EBUILD_PHASE}" == "configure" ]]; then 859 if [[ "${EBUILD_PHASE}" == "configure" ]]; then
531 if has "${EAPI}" 2 3; then 860 if has "${EAPI}" 2 3; then
532 python_default_function() { 861 python_default_function() {
533 econf 862 econf "$@"
534 } 863 }
535 else 864 else
536 python_default_function() { 865 python_default_function() {
537 nonfatal econf 866 nonfatal econf "$@"
538 } 867 }
539 fi 868 fi
540 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then 869 elif [[ "${EBUILD_PHASE}" == "compile" ]]; then
541 python_default_function() { 870 python_default_function() {
542 emake 871 emake "$@"
543 } 872 }
544 elif [[ "${EBUILD_PHASE}" == "test" ]]; then 873 elif [[ "${EBUILD_PHASE}" == "test" ]]; then
545 python_default_function() { 874 python_default_function() {
546 if emake -j1 -n check &> /dev/null; then 875 if emake -j1 -n check &> /dev/null; then
547 emake -j1 check 876 emake -j1 check "$@"
548 elif emake -j1 -n test &> /dev/null; then 877 elif emake -j1 -n test &> /dev/null; then
549 emake -j1 test 878 emake -j1 test "$@"
550 fi 879 fi
551 } 880 }
552 elif [[ "${EBUILD_PHASE}" == "install" ]]; then 881 elif [[ "${EBUILD_PHASE}" == "install" ]]; then
553 python_default_function() { 882 python_default_function() {
554 emake DESTDIR="${D}" install 883 emake DESTDIR="${D}" install "$@"
555 } 884 }
556 else 885 else
557 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase" 886 die "${FUNCNAME}(): '--default-function' option cannot be used in this ebuild phase"
558 fi 887 fi
559 function="python_default_function" 888 function="python_default_function"
889 fi
890
891 # Ensure that python_execute_function() cannot be directly or indirectly called by python_execute_function().
892 if _python_abi-specific_local_scope; then
893 die "${FUNCNAME}(): Invalid call stack"
560 fi 894 fi
561 895
562 if [[ "${quiet}" == "0" ]]; then 896 if [[ "${quiet}" == "0" ]]; then
563 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up" 897 [[ "${EBUILD_PHASE}" == "setup" ]] && action="Setting up"
564 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking" 898 [[ "${EBUILD_PHASE}" == "unpack" ]] && action="Unpacking"
571 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation" 905 [[ "${EBUILD_PHASE}" == "postinst" ]] && action="Postinstallation"
572 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation" 906 [[ "${EBUILD_PHASE}" == "prerm" ]] && action="Preuninstallation"
573 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation" 907 [[ "${EBUILD_PHASE}" == "postrm" ]] && action="Postuninstallation"
574 fi 908 fi
575 909
576 local RED GREEN BLUE NORMAL 910 _python_calculate_PYTHON_ABIS
577 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then 911 if [[ "${final_ABI}" == "1" ]]; then
578 RED=$'\e[1;31m' 912 iterated_PYTHON_ABIS="$(PYTHON -f --ABI)"
579 GREEN=$'\e[1;32m'
580 BLUE=$'\e[1;34m'
581 NORMAL=$'\e[0m'
582 else 913 else
583 RED= 914 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
584 GREEN=
585 BLUE=
586 NORMAL=
587 fi 915 fi
588
589 validate_PYTHON_ABIS
590 for PYTHON_ABI in ${PYTHON_ABIS}; do 916 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
917 _python_prepare_flags
918
591 if [[ "${quiet}" == "0" ]]; then 919 if [[ "${quiet}" == "0" ]]; then
592 if [[ -n "${action_message_template}" ]]; then 920 if [[ -n "${action_message_template}" ]]; then
593 action_message="$(eval echo -n "${action_message_template}")" 921 eval "action_message=\"${action_message_template}\""
594 else 922 else
595 action_message="${action} of ${CATEGORY}/${PF} with Python ${PYTHON_ABI}..." 923 action_message="${action} of ${CATEGORY}/${PF} with $(python_get_implementation) $(python_get_version)..."
596 fi 924 fi
597 echo " ${GREEN}*${NORMAL} ${BLUE}${action_message}${NORMAL}" 925 echo " ${_GREEN}*${_NORMAL} ${_BLUE}${action_message}${_NORMAL}"
598 fi 926 fi
599 927
600 if [[ "${separate_build_dirs}" == "1" ]]; then 928 if [[ "${separate_build_dirs}" == "1" ]]; then
601 if [[ -n "${source_dir}" ]]; then 929 if [[ -n "${source_dir}" ]]; then
602 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}" 930 export BUILDDIR="${S}/${source_dir}-${PYTHON_ABI}"
616 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@" 944 EPYTHON="$(PYTHON)" nonfatal "${function}" "$@"
617 else 945 else
618 EPYTHON="$(PYTHON)" "${function}" "$@" 946 EPYTHON="$(PYTHON)" "${function}" "$@"
619 fi 947 fi
620 948
621 if [[ "$?" != "0" ]]; then 949 return_code="$?"
950
951 _python_restore_flags
952
953 if [[ "${return_code}" -ne 0 ]]; then
622 if [[ -n "${failure_message_template}" ]]; then 954 if [[ -n "${failure_message_template}" ]]; then
623 failure_message="$(eval echo -n "${failure_message_template}")" 955 eval "failure_message=\"${failure_message_template}\""
624 else 956 else
625 failure_message="${action} failed with Python ${PYTHON_ABI} in ${function}() function" 957 failure_message="${action} failed with $(python_get_implementation) $(python_get_version) in ${function}() function"
626 fi 958 fi
627 959
628 if [[ "${nonfatal}" == "1" ]]; then 960 if [[ "${nonfatal}" == "1" ]]; then
629 if [[ "${quiet}" == "0" ]]; then 961 if [[ "${quiet}" == "0" ]]; then
630 ewarn "${RED}${failure_message}${NORMAL}" 962 ewarn "${failure_message}"
631 fi 963 fi
632 elif has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then 964 elif [[ "${final_ABI}" == "0" ]] && has "${PYTHON_ABI}" ${FAILURE_TOLERANT_PYTHON_ABIS}; then
633 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then 965 if [[ "${EBUILD_PHASE}" != "test" ]] || ! has test-fail-continue ${FEATURES}; then
634 local enabled_PYTHON_ABIS= other_PYTHON_ABI 966 local enabled_PYTHON_ABIS= other_PYTHON_ABI
635 for other_PYTHON_ABI in ${PYTHON_ABIS}; do 967 for other_PYTHON_ABI in ${PYTHON_ABIS}; do
636 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}" 968 [[ "${other_PYTHON_ABI}" != "${PYTHON_ABI}" ]] && enabled_PYTHON_ABIS+="${enabled_PYTHON_ABIS:+ }${other_PYTHON_ABI}"
637 done 969 done
638 export PYTHON_ABIS="${enabled_PYTHON_ABIS}" 970 export PYTHON_ABIS="${enabled_PYTHON_ABIS}"
639 fi 971 fi
640 if [[ "${quiet}" == "0" ]]; then 972 if [[ "${quiet}" == "0" ]]; then
641 ewarn "${RED}${failure_message}${NORMAL}" 973 ewarn "${failure_message}"
642 fi 974 fi
643 if [[ -z "${PYTHON_ABIS}" ]]; then 975 if [[ -z "${PYTHON_ABIS}" ]]; then
644 die "${function}() function failed with all enabled versions of Python" 976 die "${function}() function failed with all enabled Python ABIs"
645 fi 977 fi
646 else 978 else
647 die "${failure_message}" 979 die "${failure_message}"
648 fi 980 fi
649 fi 981 fi
678 if [[ "${default_function}" == "1" ]]; then 1010 if [[ "${default_function}" == "1" ]]; then
679 unset -f python_default_function 1011 unset -f python_default_function
680 fi 1012 fi
681} 1013}
682 1014
683# @FUNCTION: python_convert_shebangs 1015# @FUNCTION: python_copy_sources
684# @USAGE: [-q|--quiet] [-r|--recursive] [-x|--only-executables] [--] <Python_version> <file|directory> [files|directories] 1016# @USAGE: <directory="${S}"> [directory]
685# @DESCRIPTION: 1017# @DESCRIPTION:
686# Convert shebangs in specified files. Directories can be specified only with --recursive option. 1018# Copy unpacked sources of current package to separate build directory for each Python ABI.
687python_convert_shebangs() { 1019python_copy_sources() {
688 local argument file files=() only_executables="0" python_version quiet="0" recursive="0" 1020 _python_check_python_pkg_setup_execution
689 1021
690 while (($#)); do 1022 if ! _python_package_supporting_installation_for_multiple_python_abis; then
691 case "$1" in 1023 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
692 -r|--recursive) 1024 fi
693 recursive="1" 1025
694 ;; 1026 local dir dirs=() PYTHON_ABI
695 -q|--quiet)
696 quiet="1"
697 ;;
698 -x|--only-executables)
699 only_executables="1"
700 ;;
701 --)
702 break
703 ;;
704 -*)
705 die "${FUNCNAME}(): Unrecognized option '$1'"
706 ;;
707 *)
708 break
709 ;;
710 esac
711 shift
712 done
713 1027
714 if [[ "$#" -eq 0 ]]; then 1028 if [[ "$#" -eq 0 ]]; then
715 die "${FUNCNAME}(): Missing Python version and files or directories" 1029 if [[ "${WORKDIR}" == "${S}" ]]; then
716 elif [[ "$#" -eq 1 ]]; then 1030 die "${FUNCNAME}() cannot be used with current value of S variable"
717 die "${FUNCNAME}(): Missing files or directories"
718 fi
719
720 python_version="$1"
721 shift
722
723 for argument in "$@"; do
724 if [[ ! -e "${argument}" ]]; then
725 die "${FUNCNAME}(): '${argument}' does not exist"
726 elif [[ -f "${argument}" ]]; then
727 files+=("${argument}")
728 elif [[ -d "${argument}" ]]; then
729 if [[ "${recursive}" == "1" ]]; then
730 if [[ "${only_executables}" == "1" ]]; then
731 files+=($(find "${argument}" -perm /111 -type f))
732 else
733 files+=($(find "${argument}" -type f))
734 fi
735 else
736 die "${FUNCNAME}(): '${argument}' is not a regular file"
737 fi 1031 fi
1032 dirs=("${S%/}")
738 else 1033 else
739 die "${FUNCNAME}(): '${argument}' is not a regular file or a directory" 1034 dirs=("$@")
740 fi 1035 fi
1036
1037 _python_calculate_PYTHON_ABIS
1038 for PYTHON_ABI in ${PYTHON_ABIS}; do
1039 for dir in "${dirs[@]}"; do
1040 cp -pr "${dir}" "${dir}-${PYTHON_ABI}" > /dev/null || die "Copying of sources failed"
741 done 1041 done
742
743 for file in "${files[@]}"; do
744 file="${file#./}"
745 [[ "${only_executables}" == "1" && ! -x "${file}" ]] && continue
746
747 if [[ "$(head -n1 "${file}")" =~ ^'#!'.*python ]]; then
748 if [[ "${quiet}" == "0" ]]; then
749 einfo "Converting shebang in '${file}'"
750 fi
751 sed -e "1s/python\([[:digit:]]\+\(\.[[:digit:]]\+\)\?\)\?/python${python_version}/" -i "${file}" || die "Conversion of shebang in '${file}' failed"
752
753 # Delete potential whitespace after "#!".
754 sed -e '1s/\(^#!\)[[:space:]]*/\1/' -i "${file}" || die "sed '${file}' failed"
755 fi
756 done 1042 done
757} 1043}
758 1044
759# @FUNCTION: python_generate_wrapper_scripts 1045# @FUNCTION: python_generate_wrapper_scripts
760# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files] 1046# @USAGE: [-E|--respect-EPYTHON] [-f|--force] [-q|--quiet] [--] <file> [files]
761# @DESCRIPTION: 1047# @DESCRIPTION:
762# Generate wrapper scripts. Existing files are overwritten only with --force option. 1048# Generate wrapper scripts. Existing files are overwritten only with --force option.
763# If --respect-EPYTHON option is specified, then generated wrapper scripts will 1049# If --respect-EPYTHON option is specified, then generated wrapper scripts will
764# respect EPYTHON variable at run time. 1050# respect EPYTHON variable at run time.
765python_generate_wrapper_scripts() { 1051python_generate_wrapper_scripts() {
1052 _python_check_python_pkg_setup_execution
1053
1054 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1055 die "${FUNCNAME}() cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1056 fi
1057
1058 _python_initialize_prefix_variables
1059
766 local eselect_python_option file force="0" quiet="0" PYTHON_ABI python2_enabled="0" python2_supported_versions python3_enabled="0" python3_supported_versions respect_EPYTHON="0" 1060 local eselect_python_option file force="0" quiet="0" PYTHON_ABI python2_enabled="0" python3_enabled="0" respect_EPYTHON="0"
767 python2_supported_versions="2.4 2.5 2.6 2.7"
768 python3_supported_versions="3.0 3.1 3.2"
769 1061
770 while (($#)); do 1062 while (($#)); do
771 case "$1" in 1063 case "$1" in
772 -E|--respect-EPYTHON) 1064 -E|--respect-EPYTHON)
773 respect_EPYTHON="1" 1065 respect_EPYTHON="1"
777 ;; 1069 ;;
778 -q|--quiet) 1070 -q|--quiet)
779 quiet="1" 1071 quiet="1"
780 ;; 1072 ;;
781 --) 1073 --)
1074 shift
782 break 1075 break
783 ;; 1076 ;;
784 -*) 1077 -*)
785 die "${FUNCNAME}(): Unrecognized option '$1'" 1078 die "${FUNCNAME}(): Unrecognized option '$1'"
786 ;; 1079 ;;
793 1086
794 if [[ "$#" -eq 0 ]]; then 1087 if [[ "$#" -eq 0 ]]; then
795 die "${FUNCNAME}(): Missing arguments" 1088 die "${FUNCNAME}(): Missing arguments"
796 fi 1089 fi
797 1090
798 validate_PYTHON_ABIS 1091 _python_calculate_PYTHON_ABIS
799 for PYTHON_ABI in ${python2_supported_versions}; do 1092 for PYTHON_ABI in "${_CPYTHON2_SUPPORTED_ABIS[@]}"; do
800 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then 1093 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
801 python2_enabled="1" 1094 python2_enabled="1"
802 fi 1095 fi
803 done 1096 done
804 for PYTHON_ABI in ${python3_supported_versions}; do 1097 for PYTHON_ABI in "${_CPYTHON3_SUPPORTED_ABIS[@]}"; do
805 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then 1098 if has "${PYTHON_ABI}" ${PYTHON_ABIS}; then
806 python3_enabled="1" 1099 python3_enabled="1"
807 fi 1100 fi
808 done 1101 done
809 1102
821 if [[ -f "${file}" && "${force}" == "0" ]]; then 1114 if [[ -f "${file}" && "${force}" == "0" ]]; then
822 die "${FUNCNAME}(): '$1' already exists" 1115 die "${FUNCNAME}(): '$1' already exists"
823 fi 1116 fi
824 1117
825 if [[ "${quiet}" == "0" ]]; then 1118 if [[ "${quiet}" == "0" ]]; then
826 einfo "Generating '${file#${D%/}}' wrapper script" 1119 einfo "Generating '${file#${ED%/}}' wrapper script"
827 fi 1120 fi
828 1121
829 cat << EOF > "${file}" 1122 cat << EOF > "${file}"
830#!/usr/bin/env python 1123#!/usr/bin/env python
831# Gentoo '${file##*/}' wrapper script 1124# Gentoo '${file##*/}' wrapper script generated by python_generate_wrapper_scripts()
832 1125
833import os 1126import os
834import re 1127import re
835import subprocess 1128import subprocess
836import sys 1129import sys
837 1130
838EPYTHON_re = re.compile(r"^python(\d+\.\d+)$") 1131EPYTHON_re = re.compile(r"^python(\d+\.\d+)$")
1132python_shebang_re = re.compile(r"^#! *(${EPREFIX}/usr/bin/python|(${EPREFIX})?/usr/bin/env +(${EPREFIX}/usr/bin/)?python)")
1133python_verification_output_re = re.compile("^GENTOO_PYTHON_TARGET_SCRIPT_PATH supported\n$")
839 1134
840EOF 1135EOF
841 if [[ "$?" != "0" ]]; then 1136 if [[ "$?" != "0" ]]; then
842 die "${FUNCNAME}(): Generation of '$1' failed" 1137 die "${FUNCNAME}(): Generation of '$1' failed"
843 fi 1138 fi
851 else: 1146 else:
852 sys.stderr.write("EPYTHON variable has unrecognized value '%s'\n" % EPYTHON) 1147 sys.stderr.write("EPYTHON variable has unrecognized value '%s'\n" % EPYTHON)
853 sys.exit(1) 1148 sys.exit(1)
854else: 1149else:
855 try: 1150 try:
856 eselect_process = subprocess.Popen(["/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE) 1151 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE)
857 if eselect_process.wait() != 0: 1152 if eselect_process.wait() != 0:
858 raise ValueError 1153 raise ValueError
859 except (OSError, ValueError): 1154 except (OSError, ValueError):
860 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n") 1155 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
861 sys.exit(1) 1156 sys.exit(1)
862 1157
863 eselect_output = eselect_process.stdout.read() 1158 EPYTHON = eselect_process.stdout.read()
864 if not isinstance(eselect_output, str): 1159 if not isinstance(EPYTHON, str):
865 # Python 3 1160 # Python 3
866 eselect_output = eselect_output.decode() 1161 EPYTHON = EPYTHON.decode()
1162 EPYTHON = EPYTHON.rstrip("\n")
867 1163
868 EPYTHON_matched = EPYTHON_re.match(eselect_output) 1164 EPYTHON_matched = EPYTHON_re.match(EPYTHON)
869 if EPYTHON_matched: 1165 if EPYTHON_matched:
870 PYTHON_ABI = EPYTHON_matched.group(1) 1166 PYTHON_ABI = EPYTHON_matched.group(1)
871 else: 1167 else:
872 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s" % eselect_output) 1168 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
873 sys.exit(1) 1169 sys.exit(1)
874EOF 1170EOF
875 if [[ "$?" != "0" ]]; then 1171 if [[ "$?" != "0" ]]; then
876 die "${FUNCNAME}(): Generation of '$1' failed" 1172 die "${FUNCNAME}(): Generation of '$1' failed"
877 fi 1173 fi
878 else 1174 else
879 cat << EOF >> "${file}" 1175 cat << EOF >> "${file}"
880try: 1176try:
881 eselect_process = subprocess.Popen(["/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE) 1177 eselect_process = subprocess.Popen(["${EPREFIX}/usr/bin/eselect", "python", "show"${eselect_python_option:+, $(echo "\"")}${eselect_python_option}${eselect_python_option:+$(echo "\"")}], stdout=subprocess.PIPE)
882 if eselect_process.wait() != 0: 1178 if eselect_process.wait() != 0:
883 raise ValueError 1179 raise ValueError
884except (OSError, ValueError): 1180except (OSError, ValueError):
885 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n") 1181 sys.stderr.write("Execution of 'eselect python show${eselect_python_option:+ }${eselect_python_option}' failed\n")
886 sys.exit(1) 1182 sys.exit(1)
887 1183
888eselect_output = eselect_process.stdout.read() 1184EPYTHON = eselect_process.stdout.read()
889if not isinstance(eselect_output, str): 1185if not isinstance(EPYTHON, str):
890 # Python 3 1186 # Python 3
891 eselect_output = eselect_output.decode() 1187 EPYTHON = EPYTHON.decode()
1188EPYTHON = EPYTHON.rstrip("\n")
892 1189
893EPYTHON_matched = EPYTHON_re.match(eselect_output) 1190EPYTHON_matched = EPYTHON_re.match(EPYTHON)
894if EPYTHON_matched: 1191if EPYTHON_matched:
895 PYTHON_ABI = EPYTHON_matched.group(1) 1192 PYTHON_ABI = EPYTHON_matched.group(1)
896else: 1193else:
897 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s" % eselect_output) 1194 sys.stderr.write("'eselect python show${eselect_python_option:+ }${eselect_python_option}' printed unrecognized value '%s'\n" % EPYTHON)
898 sys.exit(1) 1195 sys.exit(1)
899EOF 1196EOF
900 if [[ "$?" != "0" ]]; then 1197 if [[ "$?" != "0" ]]; then
901 die "${FUNCNAME}(): Generation of '$1' failed" 1198 die "${FUNCNAME}(): Generation of '$1' failed"
902 fi 1199 fi
903 fi 1200 fi
904 cat << EOF >> "${file}" 1201 cat << EOF >> "${file}"
905 1202
1203wrapper_script_path = os.path.realpath(sys.argv[0])
1204target_executable_path = "%s-%s" % (wrapper_script_path, PYTHON_ABI)
906os.environ["PYTHON_PROCESS_NAME"] = sys.argv[0] 1205os.environ["GENTOO_PYTHON_PROCESS_NAME"] = os.path.basename(sys.argv[0])
907target_executable = "%s-%s" % (os.path.realpath(sys.argv[0]), PYTHON_ABI) 1206os.environ["GENTOO_PYTHON_WRAPPER_SCRIPT_PATH"] = sys.argv[0]
1207os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH"] = target_executable_path
908if not os.path.exists(target_executable): 1208if not os.path.exists(target_executable_path):
909 sys.stderr.write("'%s' does not exist\n" % target_executable) 1209 sys.stderr.write("'%s' does not exist\n" % target_executable_path)
910 sys.exit(1) 1210 sys.exit(1)
911 1211
1212target_executable = open(target_executable_path, "rb")
1213target_executable_first_line = target_executable.readline()
1214if not isinstance(target_executable_first_line, str):
1215 # Python 3
1216 target_executable_first_line = target_executable_first_line.decode("utf_8", "replace")
1217
1218python_shebang_matched = python_shebang_re.match(target_executable_first_line)
1219target_executable.close()
1220
1221if python_shebang_matched:
1222 try:
1223 python_interpreter_path = "${EPREFIX}/usr/bin/%s" % EPYTHON
1224 os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"] = "1"
1225 python_verification_process = subprocess.Popen([python_interpreter_path, "-c", "pass"], stdout=subprocess.PIPE)
1226 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
1227 if python_verification_process.wait() != 0:
1228 raise ValueError
1229
1230 python_verification_output = python_verification_process.stdout.read()
1231 if not isinstance(python_verification_output, str):
1232 # Python 3
1233 python_verification_output = python_verification_output.decode()
1234
1235 if not python_verification_output_re.match(python_verification_output):
1236 raise ValueError
1237
1238 os.execv(python_interpreter_path, [python_interpreter_path] + sys.argv)
1239 except:
1240 pass
1241 if "GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION" in os.environ:
1242 del os.environ["GENTOO_PYTHON_TARGET_SCRIPT_PATH_VERIFICATION"]
1243
912os.execv(target_executable, sys.argv) 1244os.execv(target_executable_path, sys.argv)
913EOF 1245EOF
914 if [[ "$?" != "0" ]]; then 1246 if [[ "$?" != "0" ]]; then
915 die "${FUNCNAME}(): Generation of '$1' failed" 1247 die "${FUNCNAME}(): Generation of '$1' failed"
916 fi 1248 fi
917 fperms +x "${file#${D%/}}" || die "fperms '${file}' failed" 1249 fperms +x "${file#${ED%/}}" || die "fperms '${file}' failed"
918 done 1250 done
919} 1251}
920 1252
921# @ECLASS-VARIABLE: PYTHON_USE_WITH 1253# ================================================================================================
922# @DESCRIPTION: 1254# ========= FUNCTIONS FOR PACKAGES NOT SUPPORTING INSTALLATION FOR MULTIPLE PYTHON ABIS ==========
923# Set this to a space separated list of use flags 1255# ================================================================================================
924# the python slot in use must be built with.
925 1256
926# @ECLASS-VARIABLE: PYTHON_USE_WITH_OR 1257unset EPYTHON PYTHON_ABI
927# @DESCRIPTION:
928# Set this to a space separated list of use flags
929# of which one must be turned on for the slot of
930# in use.
931 1258
932# @ECLASS-VARIABLE: PYTHON_USE_WITH_OPT 1259# @FUNCTION: python_set_active_version
1260# @USAGE: <CPython_ABI|2|3>
933# @DESCRIPTION: 1261# @DESCRIPTION:
934# Set this if you need to make either PYTHON_USE_WITH or 1262# Set specified version of CPython as active version of Python.
935# PYTHON_USE_WITH_OR atoms conditional under a use flag. 1263#
1264# This function can be used only in pkg_setup() phase.
1265python_set_active_version() {
1266 # Check if phase is pkg_setup().
1267 [[ "${EBUILD_PHASE}" != "setup" ]] && die "${FUNCNAME}() can be used only in pkg_setup() phase"
936 1268
937# @FUNCTION: python_pkg_setup 1269 if _python_package_supporting_installation_for_multiple_python_abis; then
938# @DESCRIPTION: 1270 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
939# Makes sure PYTHON_USE_WITH or PYTHON_USE_WITH_OR listed use flags 1271 fi
940# are respected. Only exported if one of those variables is set.
941if ! has "${EAPI:-0}" 0 1 && [[ -n ${PYTHON_USE_WITH} || -n ${PYTHON_USE_WITH_OR} ]]; then
942 python_pkg_setup() {
943 python_pkg_setup_fail() {
944 eerror "${1}"
945 die "${1}"
946 }
947 1272
948 [[ ${PYTHON_USE_WITH_OPT} ]] && use !${PYTHON_USE_WITH_OPT} && return 1273 if [[ "$#" -ne 1 ]]; then
1274 die "${FUNCNAME}() requires 1 argument"
1275 fi
949 1276
950 python_pkg_setup_check_USE_flags() { 1277 _python_initial_sanity_checks
951 local pyatom use 1278
952 if [[ -n "${PYTHON_ABI}" ]]; then 1279 if [[ -z "${PYTHON_ABI}" ]]; then
953 pyatom="dev-lang/python:${PYTHON_ABI}" 1280 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
954 else 1281 if ! _python_implementation && ! has_version "dev-lang/python:$1"; then
955 pyatom="dev-lang/python:$(PYTHON -A --ABI)" 1282 die "${FUNCNAME}(): 'dev-lang/python:$1' is not installed"
956 fi
957
958 for use in ${PYTHON_USE_WITH}; do
959 if ! has_version "${pyatom}[${use}]"; then
960 python_pkg_setup_fail "Please rebuild ${pyatom} with the following USE flags enabled: ${PYTHON_USE_WITH}"
961 fi 1283 fi
962 done 1284 export EPYTHON="$(PYTHON "$1")"
963 1285 elif [[ "$1" == "2" ]]; then
964 for use in ${PYTHON_USE_WITH_OR}; do 1286 if ! _python_implementation && ! has_version "=dev-lang/python-2*"; then
965 if has_version "${pyatom}[${use}]"; then 1287 die "${FUNCNAME}(): '=dev-lang/python-2*' is not installed"
966 return
967 fi 1288 fi
968 done 1289 export EPYTHON="$(PYTHON -2)"
969 1290 elif [[ "$1" == "3" ]]; then
970 if [[ ${PYTHON_USE_WITH_OR} ]]; then 1291 if ! _python_implementation && ! has_version "=dev-lang/python-3*"; then
971 python_pkg_setup_fail "Please rebuild ${pyatom} with at least one of the following USE flags enabled: ${PYTHON_USE_WITH_OR}" 1292 die "${FUNCNAME}(): '=dev-lang/python-3*' is not installed"
972 fi 1293 fi
973 } 1294 export EPYTHON="$(PYTHON -3)"
974
975 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
976 python_execute_function -q python_pkg_setup_check_USE_flags
977 else 1295 else
978 python_pkg_setup_check_USE_flags 1296 die "${FUNCNAME}(): Unrecognized argument '$1'"
1297 fi
1298
1299 # PYTHON_ABI variable is intended to be used only in ebuilds/eclasses,
1300 # so it does not need to be exported to subprocesses.
1301 PYTHON_ABI="${EPYTHON#python}"
1302 PYTHON_ABI="${PYTHON_ABI%%-*}"
1303 fi
1304
1305 _python_final_sanity_checks
1306
1307 # python-updater checks PYTHON_REQUESTED_ACTIVE_VERSION variable.
1308 PYTHON_REQUESTED_ACTIVE_VERSION="$1"
1309}
1310
1311# @FUNCTION: python_need_rebuild
1312# @DESCRIPTION: Mark current package for rebuilding by python-updater after
1313# switching of active version of Python.
1314python_need_rebuild() {
1315 _python_check_python_pkg_setup_execution
1316
1317 if _python_package_supporting_installation_for_multiple_python_abis; then
1318 die "${FUNCNAME}() cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
1319 fi
1320
1321 if [[ "$#" -ne 0 ]]; then
1322 die "${FUNCNAME}() does not accept arguments"
1323 fi
1324
1325 export PYTHON_NEED_REBUILD="$(PYTHON --ABI)"
1326}
1327
1328# ================================================================================================
1329# ======================================= GETTER FUNCTIONS =======================================
1330# ================================================================================================
1331
1332_PYTHON_ABI_EXTRACTION_COMMAND='import platform
1333import sys
1334sys.stdout.write(".".join(str(x) for x in sys.version_info[:2]))
1335if platform.system()[:4] == "Java":
1336 sys.stdout.write("-jython")'
1337
1338_python_get_implementation() {
1339 if [[ "$#" -ne 1 ]]; then
1340 die "${FUNCNAME}() requires 1 argument"
1341 fi
1342
1343 if [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+$ ]]; then
1344 echo "CPython"
1345 elif [[ "$1" =~ ^[[:digit:]]+\.[[:digit:]]+-jython$ ]]; then
1346 echo "Jython"
1347 else
1348 die "${FUNCNAME}(): Unrecognized Python ABI '$1'"
1349 fi
1350}
1351
1352# @FUNCTION: PYTHON
1353# @USAGE: [-2] [-3] [--ABI] [-a|--absolute-path] [-f|--final-ABI] [--] <Python_ABI="${PYTHON_ABI}">
1354# @DESCRIPTION:
1355# Print filename of Python interpreter for specified Python ABI. If Python_ABI argument
1356# is ommitted, then PYTHON_ABI environment variable must be set and is used.
1357# If -2 option is specified, then active version of Python 2 is used.
1358# If -3 option is specified, then active version of Python 3 is used.
1359# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1360# -2, -3 and --final-ABI options and Python_ABI argument cannot be specified simultaneously.
1361# If --ABI option is specified, then only specified Python ABI is printed instead of
1362# filename of Python interpreter.
1363# If --absolute-path option is specified, then absolute path to Python interpreter is printed.
1364# --ABI and --absolute-path options cannot be specified simultaneously.
1365PYTHON() {
1366 _python_check_python_pkg_setup_execution
1367
1368 local ABI_output="0" absolute_path_output="0" final_ABI="0" PYTHON_ABI="${PYTHON_ABI}" python_interpreter python2="0" python3="0"
1369
1370 while (($#)); do
1371 case "$1" in
1372 -2)
1373 python2="1"
1374 ;;
1375 -3)
1376 python3="1"
1377 ;;
1378 --ABI)
1379 ABI_output="1"
1380 ;;
1381 -a|--absolute-path)
1382 absolute_path_output="1"
1383 ;;
1384 -f|--final-ABI)
1385 final_ABI="1"
1386 ;;
1387 --)
1388 shift
1389 break
1390 ;;
1391 -*)
1392 die "${FUNCNAME}(): Unrecognized option '$1'"
1393 ;;
1394 *)
1395 break
1396 ;;
1397 esac
1398 shift
1399 done
1400
1401 if [[ "${ABI_output}" == "1" && "${absolute_path_output}" == "1" ]]; then
1402 die "${FUNCNAME}(): '--ABI' and '--absolute-path' options cannot be specified simultaneously"
1403 fi
1404
1405 if [[ "$((${python2} + ${python3} + ${final_ABI}))" -gt 1 ]]; then
1406 die "${FUNCNAME}(): '-2', '-3' or '--final-ABI' options cannot be specified simultaneously"
1407 fi
1408
1409 if [[ "$#" -eq 0 ]]; then
1410 if [[ "${final_ABI}" == "1" ]]; then
1411 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1412 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
979 fi 1413 fi
1414 _python_calculate_PYTHON_ABIS
1415 PYTHON_ABI="${PYTHON_ABIS##* }"
1416 elif [[ "${python2}" == "1" ]]; then
1417 PYTHON_ABI="$(eselect python show --python2 --ABI)"
1418 if [[ -z "${PYTHON_ABI}" ]]; then
1419 die "${FUNCNAME}(): Active version of Python 2 not set"
1420 elif [[ "${PYTHON_ABI}" != "2."* ]]; then
1421 die "${FUNCNAME}(): Internal error in \`eselect python show --python2\`"
1422 fi
1423 elif [[ "${python3}" == "1" ]]; then
1424 PYTHON_ABI="$(eselect python show --python3 --ABI)"
1425 if [[ -z "${PYTHON_ABI}" ]]; then
1426 die "${FUNCNAME}(): Active version of Python 3 not set"
1427 elif [[ "${PYTHON_ABI}" != "3."* ]]; then
1428 die "${FUNCNAME}(): Internal error in \`eselect python show --python3\`"
1429 fi
1430 elif _python_package_supporting_installation_for_multiple_python_abis; then
1431 if ! _python_abi-specific_local_scope; then
1432 die "${FUNCNAME}() should be used in ABI-specific local scope"
1433 fi
1434 else
1435 PYTHON_ABI="$("${EPREFIX}/usr/bin/python" -c "${_PYTHON_ABI_EXTRACTION_COMMAND}")"
1436 if [[ -z "${PYTHON_ABI}" ]]; then
1437 die "${FUNCNAME}(): Failure of extraction of locally active version of Python"
1438 fi
1439 fi
1440 elif [[ "$#" -eq 1 ]]; then
1441 if [[ "${final_ABI}" == "1" ]]; then
1442 die "${FUNCNAME}(): '--final-ABI' option and Python ABI cannot be specified simultaneously"
1443 fi
1444 if [[ "${python2}" == "1" ]]; then
1445 die "${FUNCNAME}(): '-2' option and Python ABI cannot be specified simultaneously"
1446 fi
1447 if [[ "${python3}" == "1" ]]; then
1448 die "${FUNCNAME}(): '-3' option and Python ABI cannot be specified simultaneously"
1449 fi
1450 PYTHON_ABI="$1"
1451 else
1452 die "${FUNCNAME}(): Invalid usage"
1453 fi
1454
1455 if [[ "${ABI_output}" == "1" ]]; then
1456 echo -n "${PYTHON_ABI}"
1457 return
1458 else
1459 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1460 python_interpreter="python${PYTHON_ABI}"
1461 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1462 python_interpreter="jython-${PYTHON_ABI%-jython}"
1463 fi
1464
1465 if [[ "${absolute_path_output}" == "1" ]]; then
1466 echo -n "${EPREFIX}/usr/bin/${python_interpreter}"
1467 else
1468 echo -n "${python_interpreter}"
1469 fi
1470 fi
1471
1472 if [[ -n "${ABI}" && "${ABI}" != "${DEFAULT_ABI}" && "${DEFAULT_ABI}" != "default" ]]; then
1473 echo -n "-${ABI}"
1474 fi
1475}
1476
1477# @FUNCTION: python_get_implementation
1478# @USAGE: [-f|--final-ABI]
1479# @DESCRIPTION:
1480# Print name of Python implementation.
1481# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1482python_get_implementation() {
1483 _python_check_python_pkg_setup_execution
1484
1485 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1486
1487 while (($#)); do
1488 case "$1" in
1489 -f|--final-ABI)
1490 final_ABI="1"
1491 ;;
1492 -*)
1493 die "${FUNCNAME}(): Unrecognized option '$1'"
1494 ;;
1495 *)
1496 die "${FUNCNAME}(): Invalid usage"
1497 ;;
1498 esac
1499 shift
1500 done
1501
1502 if [[ "${final_ABI}" == "1" ]]; then
1503 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1504 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1505 fi
1506 PYTHON_ABI="$(PYTHON -f --ABI)"
1507 else
1508 if _python_package_supporting_installation_for_multiple_python_abis; then
1509 if ! _python_abi-specific_local_scope; then
1510 die "${FUNCNAME}() should be used in ABI-specific local scope"
1511 fi
1512 else
1513 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1514 fi
1515 fi
1516
1517 echo "$(_python_get_implementation "${PYTHON_ABI}")"
1518}
1519
1520# @FUNCTION: python_get_implementational_package
1521# @USAGE: [-f|--final-ABI]
1522# @DESCRIPTION:
1523# Print category, name and slot of package providing Python implementation.
1524# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1525python_get_implementational_package() {
1526 _python_check_python_pkg_setup_execution
1527
1528 local final_ABI="0" PYTHON_ABI="${PYTHON_ABI}"
1529
1530 while (($#)); do
1531 case "$1" in
1532 -f|--final-ABI)
1533 final_ABI="1"
1534 ;;
1535 -*)
1536 die "${FUNCNAME}(): Unrecognized option '$1'"
1537 ;;
1538 *)
1539 die "${FUNCNAME}(): Invalid usage"
1540 ;;
1541 esac
1542 shift
1543 done
1544
1545 if [[ "${final_ABI}" == "1" ]]; then
1546 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1547 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1548 fi
1549 PYTHON_ABI="$(PYTHON -f --ABI)"
1550 else
1551 if _python_package_supporting_installation_for_multiple_python_abis; then
1552 if ! _python_abi-specific_local_scope; then
1553 die "${FUNCNAME}() should be used in ABI-specific local scope"
1554 fi
1555 else
1556 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1557 fi
1558 fi
1559
1560 if [[ "${EAPI:-0}" == "0" ]]; then
1561 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1562 echo "=dev-lang/python-${PYTHON_ABI}*"
1563 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1564 echo "=dev-java/jython-${PYTHON_ABI%-jython}*"
1565 fi
1566 else
1567 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1568 echo "dev-lang/python:${PYTHON_ABI}"
1569 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1570 echo "dev-java/jython:${PYTHON_ABI%-jython}"
1571 fi
1572 fi
1573}
1574
1575# @FUNCTION: python_get_includedir
1576# @USAGE: [-b|--base-path] [-f|--final-ABI]
1577# @DESCRIPTION:
1578# Print path to Python include directory.
1579# If --base-path option is specified, then path not prefixed with "/" is printed.
1580# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1581python_get_includedir() {
1582 _python_check_python_pkg_setup_execution
1583
1584 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1585
1586 while (($#)); do
1587 case "$1" in
1588 -b|--base-path)
1589 base_path="1"
1590 ;;
1591 -f|--final-ABI)
1592 final_ABI="1"
1593 ;;
1594 -*)
1595 die "${FUNCNAME}(): Unrecognized option '$1'"
1596 ;;
1597 *)
1598 die "${FUNCNAME}(): Invalid usage"
1599 ;;
1600 esac
1601 shift
1602 done
1603
1604 if [[ "${base_path}" == "0" ]]; then
1605 prefix="/"
1606 fi
1607
1608 if [[ "${final_ABI}" == "1" ]]; then
1609 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1610 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1611 fi
1612 PYTHON_ABI="$(PYTHON -f --ABI)"
1613 else
1614 if _python_package_supporting_installation_for_multiple_python_abis; then
1615 if ! _python_abi-specific_local_scope; then
1616 die "${FUNCNAME}() should be used in ABI-specific local scope"
1617 fi
1618 else
1619 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1620 fi
1621 fi
1622
1623 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1624 echo "${prefix}usr/include/python${PYTHON_ABI}"
1625 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1626 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Include"
1627 fi
1628}
1629
1630# @FUNCTION: python_get_libdir
1631# @USAGE: [-b|--base-path] [-f|--final-ABI]
1632# @DESCRIPTION:
1633# Print path to Python library directory.
1634# If --base-path option is specified, then path not prefixed with "/" is printed.
1635# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1636python_get_libdir() {
1637 _python_check_python_pkg_setup_execution
1638
1639 local base_path="0" final_ABI="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1640
1641 while (($#)); do
1642 case "$1" in
1643 -b|--base-path)
1644 base_path="1"
1645 ;;
1646 -f|--final-ABI)
1647 final_ABI="1"
1648 ;;
1649 -*)
1650 die "${FUNCNAME}(): Unrecognized option '$1'"
1651 ;;
1652 *)
1653 die "${FUNCNAME}(): Invalid usage"
1654 ;;
1655 esac
1656 shift
1657 done
1658
1659 if [[ "${base_path}" == "0" ]]; then
1660 prefix="/"
1661 fi
1662
1663 if [[ "${final_ABI}" == "1" ]]; then
1664 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1665 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1666 fi
1667 PYTHON_ABI="$(PYTHON -f --ABI)"
1668 else
1669 if _python_package_supporting_installation_for_multiple_python_abis; then
1670 if ! _python_abi-specific_local_scope; then
1671 die "${FUNCNAME}() should be used in ABI-specific local scope"
1672 fi
1673 else
1674 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1675 fi
1676 fi
1677
1678 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1679 echo "${prefix}usr/$(get_libdir)/python${PYTHON_ABI}"
1680 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1681 echo "${prefix}usr/share/jython-${PYTHON_ABI%-jython}/Lib"
1682 fi
1683}
1684
1685# @FUNCTION: python_get_sitedir
1686# @USAGE: [-b|--base-path] [-f|--final-ABI]
1687# @DESCRIPTION:
1688# Print path to Python site-packages directory.
1689# If --base-path option is specified, then path not prefixed with "/" is printed.
1690# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1691python_get_sitedir() {
1692 _python_check_python_pkg_setup_execution
1693
1694 local final_ABI="0" options=()
1695
1696 while (($#)); do
1697 case "$1" in
1698 -b|--base-path)
1699 options+=("$1")
1700 ;;
1701 -f|--final-ABI)
1702 final_ABI="1"
1703 options+=("$1")
1704 ;;
1705 -*)
1706 die "${FUNCNAME}(): Unrecognized option '$1'"
1707 ;;
1708 *)
1709 die "${FUNCNAME}(): Invalid usage"
1710 ;;
1711 esac
1712 shift
1713 done
1714
1715 if [[ "${final_ABI}" == "1" ]]; then
1716 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1717 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1718 fi
1719 else
1720 if _python_package_supporting_installation_for_multiple_python_abis && ! _python_abi-specific_local_scope; then
1721 die "${FUNCNAME}() should be used in ABI-specific local scope"
1722 fi
1723 fi
1724
1725 echo "$(python_get_libdir "${options[@]}")/site-packages"
1726}
1727
1728# @FUNCTION: python_get_library
1729# @USAGE: [-b|--base-path] [-f|--final-ABI] [-l|--linker-option]
1730# @DESCRIPTION:
1731# Print path to Python library.
1732# If --base-path option is specified, then path not prefixed with "/" is printed.
1733# If --linker-option is specified, then "-l${library}" linker option is printed.
1734# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1735python_get_library() {
1736 _python_check_python_pkg_setup_execution
1737
1738 local base_path="0" final_ABI="0" linker_option="0" prefix PYTHON_ABI="${PYTHON_ABI}"
1739
1740 while (($#)); do
1741 case "$1" in
1742 -b|--base-path)
1743 base_path="1"
1744 ;;
1745 -f|--final-ABI)
1746 final_ABI="1"
1747 ;;
1748 -l|--linker-option)
1749 linker_option="1"
1750 ;;
1751 -*)
1752 die "${FUNCNAME}(): Unrecognized option '$1'"
1753 ;;
1754 *)
1755 die "${FUNCNAME}(): Invalid usage"
1756 ;;
1757 esac
1758 shift
1759 done
1760
1761 if [[ "${base_path}" == "0" ]]; then
1762 prefix="/"
1763 fi
1764
1765 if [[ "${base_path}" == "1" && "${linker_option}" == "1" ]]; then
1766 die "${FUNCNAME}(): '--base-path' and '--linker-option' options cannot be specified simultaneously"
1767 fi
1768
1769 if [[ "${final_ABI}" == "1" ]]; then
1770 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1771 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1772 fi
1773 PYTHON_ABI="$(PYTHON -f --ABI)"
1774 else
1775 if _python_package_supporting_installation_for_multiple_python_abis; then
1776 if ! _python_abi-specific_local_scope; then
1777 die "${FUNCNAME}() should be used in ABI-specific local scope"
1778 fi
1779 else
1780 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
1781 fi
1782 fi
1783
1784 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1785 if [[ "${linker_option}" == "1" ]]; then
1786 echo "-lpython${PYTHON_ABI}"
1787 else
1788 echo "${prefix}usr/$(get_libdir)/libpython${PYTHON_ABI}$(get_libname)"
1789 fi
1790 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1791 die "${FUNCNAME}(): Jython does not have shared library"
1792 fi
1793}
1794
1795# @FUNCTION: python_get_version
1796# @USAGE: [-f|--final-ABI] [--full] [--major] [--minor] [--micro]
1797# @DESCRIPTION:
1798# Print Python version.
1799# --full, --major, --minor and --micro options cannot be specified simultaneously.
1800# If --full, --major, --minor and --micro options are not specified, then "${major_version}.${minor_version}" is printed.
1801# If --final-ABI option is specified, then final ABI from the list of enabled ABIs is used.
1802python_get_version() {
1803 _python_check_python_pkg_setup_execution
1804
1805 local final_ABI="0" full="0" major="0" minor="0" micro="0" python_command
1806
1807 while (($#)); do
1808 case "$1" in
1809 -f|--final-ABI)
1810 final_ABI="1"
1811 ;;
1812 --full)
1813 full="1"
1814 ;;
1815 --major)
1816 major="1"
1817 ;;
1818 --minor)
1819 minor="1"
1820 ;;
1821 --micro)
1822 micro="1"
1823 ;;
1824 -*)
1825 die "${FUNCNAME}(): Unrecognized option '$1'"
1826 ;;
1827 *)
1828 die "${FUNCNAME}(): Invalid usage"
1829 ;;
1830 esac
1831 shift
1832 done
1833
1834 if [[ "$((${full} + ${major} + ${minor} + ${micro}))" -gt 1 ]]; then
1835 die "${FUNCNAME}(): '--full', '--major', '--minor' or '--micro' options cannot be specified simultaneously"
1836 fi
1837
1838 if [[ "${full}" == "1" ]]; then
1839 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:3]))"
1840 elif [[ "${major}" == "1" ]]; then
1841 python_command="from sys import version_info; print(version_info[0])"
1842 elif [[ "${minor}" == "1" ]]; then
1843 python_command="from sys import version_info; print(version_info[1])"
1844 elif [[ "${micro}" == "1" ]]; then
1845 python_command="from sys import version_info; print(version_info[2])"
1846 else
1847 if [[ -n "${PYTHON_ABI}" && "${final_ABI}" == "0" ]]; then
1848 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "CPython" ]]; then
1849 echo "${PYTHON_ABI}"
1850 elif [[ "$(_python_get_implementation "${PYTHON_ABI}")" == "Jython" ]]; then
1851 echo "${PYTHON_ABI%-jython}"
1852 fi
1853 return
1854 fi
1855 python_command="from sys import version_info; print('.'.join(str(x) for x in version_info[:2]))"
1856 fi
1857
1858 if [[ "${final_ABI}" == "1" ]]; then
1859 if ! _python_package_supporting_installation_for_multiple_python_abis; then
1860 die "${FUNCNAME}(): '--final-ABI' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
1861 fi
1862 "$(PYTHON -f)" -c "${python_command}"
1863 else
1864 if _python_package_supporting_installation_for_multiple_python_abis && ! _python_abi-specific_local_scope; then
1865 die "${FUNCNAME}() should be used in ABI-specific local scope"
1866 fi
1867 "$(PYTHON ${PYTHON_ABI})" -c "${python_command}"
1868 fi
1869}
1870
1871# ================================================================================================
1872# ================================ FUNCTIONS FOR RUNNING OF TESTS ================================
1873# ================================================================================================
1874
1875# @ECLASS-VARIABLE: PYTHON_TEST_VERBOSITY
1876# @DESCRIPTION:
1877# User-configurable verbosity of tests of Python modules.
1878# Supported values: 0, 1, 2, 3, 4.
1879PYTHON_TEST_VERBOSITY="${PYTHON_TEST_VERBOSITY:-1}"
1880
1881_python_test_hook() {
1882 if [[ "$#" -ne 1 ]]; then
1883 die "${FUNCNAME}() requires 1 argument"
1884 fi
1885
1886 if _python_package_supporting_installation_for_multiple_python_abis && [[ "$(type -t "${FUNCNAME[3]}_$1_hook")" == "function" ]]; then
1887 "${FUNCNAME[3]}_$1_hook"
1888 fi
1889}
1890
1891# @FUNCTION: python_execute_nosetests
1892# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
1893# @DESCRIPTION:
1894# Execute nosetests for all enabled Python ABIs.
1895# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
1896# python_execute_nosetests_pre_hook() and python_execute_nosetests_post_hook(), if they are defined.
1897python_execute_nosetests() {
1898 _python_check_python_pkg_setup_execution
1899 _python_set_color_variables
1900
1901 local PYTHONPATH_template= separate_build_dirs=
1902
1903 while (($#)); do
1904 case "$1" in
1905 -P|--PYTHONPATH)
1906 PYTHONPATH_template="$2"
1907 shift
1908 ;;
1909 -s|--separate-build-dirs)
1910 separate_build_dirs="1"
1911 ;;
1912 --)
1913 shift
1914 break
1915 ;;
1916 -*)
1917 die "${FUNCNAME}(): Unrecognized option '$1'"
1918 ;;
1919 *)
1920 break
1921 ;;
1922 esac
1923 shift
1924 done
1925
1926 python_test_function() {
1927 local evaluated_PYTHONPATH
1928
1929 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
1930
1931 _python_test_hook pre
1932
1933 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1934 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1935 PYTHONPATH="${evaluated_PYTHONPATH}" nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1936 else
1937 echo ${_BOLD}nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@"${_NORMAL}
1938 nosetests --verbosity="${PYTHON_TEST_VERBOSITY}" "$@" || return "$?"
1939 fi
1940
1941 _python_test_hook post
980 } 1942 }
1943 if _python_package_supporting_installation_for_multiple_python_abis; then
1944 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
1945 else
1946 if [[ -n "${separate_build_dirs}" ]]; then
1947 die "${FUNCNAME}(): Invalid usage"
1948 fi
1949 python_test_function "$@" || die "Testing failed"
1950 fi
981 1951
982 EXPORT_FUNCTIONS pkg_setup 1952 unset -f python_test_function
1953}
983 1954
984 if [[ -n "${PYTHON_USE_WITH}" ]]; then 1955# @FUNCTION: python_execute_py.test
985 PYTHON_USE_WITH_ATOM="${PYTHON_ATOM}[${PYTHON_USE_WITH/ /,}]" 1956# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
986 elif [[ -n "${PYTHON_USE_WITH_OR}" ]]; then 1957# @DESCRIPTION:
987 PYTHON_USE_WITH_ATOM="|| ( " 1958# Execute py.test for all enabled Python ABIs.
988 for use in ${PYTHON_USE_WITH_OR}; do 1959# In ebuilds of packages supporting installation for multiple Python ABIs, this function calls
989 PYTHON_USE_WITH_ATOM+=" ${PYTHON_ATOM}[${use}]" 1960# python_execute_py.test_pre_hook() and python_execute_py.test_post_hook(), if they are defined.
1961python_execute_py.test() {
1962 _python_check_python_pkg_setup_execution
1963 _python_set_color_variables
1964
1965 local PYTHONPATH_template= separate_build_dirs=
1966
1967 while (($#)); do
1968 case "$1" in
1969 -P|--PYTHONPATH)
1970 PYTHONPATH_template="$2"
1971 shift
1972 ;;
1973 -s|--separate-build-dirs)
1974 separate_build_dirs="1"
1975 ;;
1976 --)
1977 shift
1978 break
1979 ;;
1980 -*)
1981 die "${FUNCNAME}(): Unrecognized option '$1'"
1982 ;;
1983 *)
1984 break
1985 ;;
1986 esac
1987 shift
990 done 1988 done
991 unset use 1989
992 PYTHON_USE_WITH_ATOM+=" )" 1990 python_test_function() {
1991 local evaluated_PYTHONPATH
1992
1993 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
1994
1995 _python_test_hook pre
1996
1997 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
1998 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@"${_NORMAL}
1999 PYTHONPATH="${evaluated_PYTHONPATH}" py.test $([[ "${PYTHON_TEST_VERBOSITY}" -ge 2 ]] && echo -v) "$@" || return "$?"
2000 else
2001 echo ${_BOLD}py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@"${_NORMAL}
2002 py.test $([[ "${PYTHON_TEST_VERBOSITY}" -gt 1 ]] && echo -v) "$@" || return "$?"
993 fi 2003 fi
994 if [[ -n "${PYTHON_USE_WITH_OPT}" ]]; then
995 PYTHON_USE_WITH_ATOM="${PYTHON_USE_WITH_OPT}? ( ${PYTHON_USE_WITH_ATOM} )"
996 fi
997 DEPEND+=" ${PYTHON_USE_WITH_ATOM}"
998 RDEPEND+=" ${PYTHON_USE_WITH_ATOM}"
999fi
1000 2004
1001# @ECLASS-VARIABLE: PYTHON_DEFINE_DEFAULT_FUNCTIONS 2005 _python_test_hook post
1002# @DESCRIPTION:
1003# Set this to define default functions for the following ebuild phases:
1004# src_prepare, src_configure, src_compile, src_test, src_install.
1005if ! has "${EAPI:-0}" 0 1 && [[ -n "${PYTHON_DEFINE_DEFAULT_FUNCTIONS}" ]]; then
1006 python_src_prepare() {
1007 python_copy_sources
1008 } 2006 }
2007 if _python_package_supporting_installation_for_multiple_python_abis; then
2008 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
2009 else
2010 if [[ -n "${separate_build_dirs}" ]]; then
2011 die "${FUNCNAME}(): Invalid usage"
2012 fi
2013 python_test_function "$@" || die "Testing failed"
2014 fi
1009 2015
1010 for python_default_function in src_configure src_compile src_test src_install; do
1011 eval "python_${python_default_function}() { python_execute_function -d -s; }"
1012 done
1013 unset python_default_function 2016 unset -f python_test_function
2017}
1014 2018
1015 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install 2019# @FUNCTION: python_execute_trial
2020# @USAGE: [-P|--PYTHONPATH PYTHONPATH] [-s|--separate-build-dirs] [--] [arguments]
2021# @DESCRIPTION:
2022# Execute trial for all enabled Python ABIs.
2023# In ebuilds of packages supporting installation for multiple Python ABIs, this function
2024# calls python_execute_trial_pre_hook() and python_execute_trial_post_hook(), if they are defined.
2025python_execute_trial() {
2026 _python_check_python_pkg_setup_execution
2027 _python_set_color_variables
2028
2029 local PYTHONPATH_template= separate_build_dirs=
2030
2031 while (($#)); do
2032 case "$1" in
2033 -P|--PYTHONPATH)
2034 PYTHONPATH_template="$2"
2035 shift
2036 ;;
2037 -s|--separate-build-dirs)
2038 separate_build_dirs="1"
2039 ;;
2040 --)
2041 shift
2042 break
2043 ;;
2044 -*)
2045 die "${FUNCNAME}(): Unrecognized option '$1'"
2046 ;;
2047 *)
2048 break
2049 ;;
2050 esac
2051 shift
2052 done
2053
2054 python_test_function() {
2055 local evaluated_PYTHONPATH
2056
2057 eval "evaluated_PYTHONPATH=\"${PYTHONPATH_template}\""
2058
2059 _python_test_hook pre
2060
2061 if [[ -n "${evaluated_PYTHONPATH}" ]]; then
2062 echo ${_BOLD}PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
2063 PYTHONPATH="${evaluated_PYTHONPATH}" trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
2064 else
2065 echo ${_BOLD}trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@"${_NORMAL}
2066 trial $([[ "${PYTHON_TEST_VERBOSITY}" -ge 4 ]] && echo --spew) "$@" || return "$?"
2067 fi
2068
2069 _python_test_hook post
2070 }
2071 if _python_package_supporting_installation_for_multiple_python_abis; then
2072 python_execute_function ${separate_build_dirs:+-s} python_test_function "$@"
2073 else
2074 if [[ -n "${separate_build_dirs}" ]]; then
2075 die "${FUNCNAME}(): Invalid usage"
2076 fi
2077 python_test_function "$@" || die "Testing failed"
1016fi 2078 fi
2079
2080 unset -f python_test_function
2081}
2082
2083# ================================================================================================
2084# ======================= FUNCTIONS FOR HANDLING OF BYTE-COMPILED MODULES ========================
2085# ================================================================================================
2086
2087# @FUNCTION: python_enable_pyc
2088# @DESCRIPTION:
2089# Tell Python to automatically recompile modules to .pyc/.pyo if the
2090# timestamps/version stamps have changed.
2091python_enable_pyc() {
2092 _python_check_python_pkg_setup_execution
2093
2094 if [[ "$#" -ne 0 ]]; then
2095 die "${FUNCNAME}() does not accept arguments"
2096 fi
2097
2098 unset PYTHONDONTWRITEBYTECODE
2099}
1017 2100
1018# @FUNCTION: python_disable_pyc 2101# @FUNCTION: python_disable_pyc
1019# @DESCRIPTION: 2102# @DESCRIPTION:
1020# Tell Python not to automatically recompile modules to .pyc/.pyo 2103# Tell Python not to automatically recompile modules to .pyc/.pyo
1021# even if the timestamps/version stamps do not match. This is done 2104# even if the timestamps/version stamps do not match. This is done
1022# to protect sandbox. 2105# to protect sandbox.
1023python_disable_pyc() { 2106python_disable_pyc() {
2107 _python_check_python_pkg_setup_execution
2108
2109 if [[ "$#" -ne 0 ]]; then
2110 die "${FUNCNAME}() does not accept arguments"
2111 fi
2112
1024 export PYTHONDONTWRITEBYTECODE="1" 2113 export PYTHONDONTWRITEBYTECODE="1"
1025} 2114}
1026 2115
1027# @FUNCTION: python_enable_pyc 2116_python_clean_compiled_modules() {
1028# @DESCRIPTION: 2117 _python_initialize_prefix_variables
1029# Tell Python to automatically recompile modules to .pyc/.pyo if the 2118 _python_set_color_variables
1030# timestamps/version stamps have changed.
1031python_enable_pyc() {
1032 unset PYTHONDONTWRITEBYTECODE
1033}
1034 2119
1035# @FUNCTION: python_need_rebuild 2120 [[ "${FUNCNAME[1]}" =~ ^(python_mod_optimize|python_mod_cleanup)$ ]] || die "${FUNCNAME}(): Invalid usage"
1036# @DESCRIPTION: Run without arguments, specifies that the package should be
1037# rebuilt after a python upgrade.
1038# Do not use this function in ebuilds of packages supporting installation
1039# for multiple versions of Python.
1040python_need_rebuild() {
1041 export PYTHON_NEED_REBUILD="$(PYTHON -A --ABI)"
1042}
1043 2121
1044# @FUNCTION: python_get_includedir 2122 local base_module_name compiled_file compiled_files=() dir path py_file root
1045# @DESCRIPTION: 2123
1046# Run without arguments, returns the Python include directory. 2124 # Strip trailing slash from EROOT.
1047python_get_includedir() { 2125 root="${EROOT%/}"
1048 if [[ -n "${PYTHON_ABI}" ]]; then 2126
1049 echo "/usr/include/python${PYTHON_ABI}" 2127 for path in "$@"; do
1050 else 2128 compiled_files=()
1051 echo "/usr/include/python$(PYTHON -A --ABI)" 2129 if [[ -d "${path}" ]]; then
2130 while read -d $'\0' -r compiled_file; do
2131 compiled_files+=("${compiled_file}")
2132 done < <(find "${path}" "(" -name "*.py[co]" -o -name "*\$py.class" ")" -print0)
2133
2134 if [[ "${EBUILD_PHASE}" == "postrm" ]]; then
2135 # Delete empty child directories.
2136 find "${path}" -type d | sort -r | while read -r dir; do
2137 if rmdir "${dir}" 2> /dev/null; then
2138 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2139 fi
2140 done
2141 fi
2142 elif [[ "${path}" == *.py ]]; then
2143 base_module_name="${path##*/}"
2144 base_module_name="${base_module_name%.py}"
2145 if [[ -d "${path%/*}/__pycache__" ]]; then
2146 while read -d $'\0' -r compiled_file; do
2147 compiled_files+=("${compiled_file}")
2148 done < <(find "${path%/*}/__pycache__" "(" -name "${base_module_name}.*.py[co]" -o -name "${base_module_name}\$py.class" ")" -print0)
2149 fi
2150 compiled_files+=("${path}c" "${path}o" "${path%.py}\$py.class")
1052 fi 2151 fi
1053}
1054 2152
1055# @FUNCTION: python_get_libdir 2153 for compiled_file in "${compiled_files[@]}"; do
1056# @DESCRIPTION: 2154 [[ ! -f "${compiled_file}" ]] && continue
1057# Run without arguments, returns the Python library directory. 2155 dir="${compiled_file%/*}"
1058python_get_libdir() { 2156 dir="${dir##*/}"
1059 if [[ -n "${PYTHON_ABI}" ]]; then 2157 if [[ "${compiled_file}" == *.py[co] ]]; then
1060 echo "/usr/$(get_libdir)/python${PYTHON_ABI}" 2158 if [[ "${dir}" == "__pycache__" ]]; then
2159 base_module_name="${compiled_file##*/}"
2160 base_module_name="${base_module_name%.*py[co]}"
2161 base_module_name="${base_module_name%.*}"
2162 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2163 else
2164 py_file="${compiled_file%[co]}"
2165 fi
2166 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2167 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2168 else
2169 [[ -f "${py_file}" ]] && continue
2170 fi
2171 echo "${_BLUE}<<< ${compiled_file%[co]}[co]${_NORMAL}"
2172 rm -f "${compiled_file%[co]}"[co]
2173 elif [[ "${compiled_file}" == *\$py.class ]]; then
2174 if [[ "${dir}" == "__pycache__" ]]; then
2175 base_module_name="${compiled_file##*/}"
2176 base_module_name="${base_module_name%\$py.class}"
2177 py_file="${compiled_file%__pycache__/*}${base_module_name}.py"
2178 else
2179 py_file="${compiled_file%\$py.class}"
2180 fi
2181 if [[ "${EBUILD_PHASE}" == "postinst" ]]; then
2182 [[ -f "${py_file}" && "${compiled_file}" -nt "${py_file}" ]] && continue
2183 else
2184 [[ -f "${py_file}" ]] && continue
2185 fi
2186 echo "${_BLUE}<<< ${compiled_file}${_NORMAL}"
2187 rm -f "${compiled_file}"
1061 else 2188 else
1062 echo "/usr/$(get_libdir)/python$(PYTHON -A --ABI)" 2189 die "${FUNCNAME}(): Unrecognized file type: '${compiled_file}'"
1063 fi 2190 fi
1064}
1065 2191
1066# @FUNCTION: python_get_sitedir 2192 # Delete empty parent directories.
1067# @DESCRIPTION: 2193 dir="${compiled_file%/*}"
1068# Run without arguments, returns the Python site-packages directory. 2194 while [[ "${dir}" != "${root}" ]]; do
1069python_get_sitedir() { 2195 if rmdir "${dir}" 2> /dev/null; then
1070 echo "$(python_get_libdir)/site-packages" 2196 echo "${_CYAN}<<< ${dir}${_NORMAL}"
2197 else
2198 break
2199 fi
2200 dir="${dir%/*}"
2201 done
2202 done
2203 done
1071} 2204}
1072 2205
1073# @FUNCTION: python_tkinter_exists
1074# @DESCRIPTION:
1075# Run without arguments, checks if python was compiled with Tkinter
1076# support. If not, prints an error message and dies.
1077python_tkinter_exists() {
1078 if ! python -c "import Tkinter" >/dev/null 2>&1; then
1079 eerror "You need to recompile python with Tkinter support."
1080 eerror "Try adding: 'dev-lang/python tk'"
1081 eerror "in to /etc/portage/package.use"
1082 echo
1083 die "missing tkinter support with installed python"
1084 fi
1085}
1086
1087# @FUNCTION: python_mod_exists 2206# @FUNCTION: python_mod_optimize
1088# @USAGE: <module> 2207# @USAGE: [--allow-evaluated-non-sitedir-paths] [-d directory] [-f] [-l] [-q] [-x regular_expression] [--] <file|directory> [files|directories]
1089# @DESCRIPTION: 2208# @DESCRIPTION:
1090# Run with the module name as an argument. it will check if a 2209# Byte-compile specified Python modules.
1091# python module is installed and loadable. it will return 2210# -d, -f, -l, -q and -x options passed to this function are passed to compileall.py.
1092# TRUE(0) if the module exists, and FALSE(1) if the module does
1093# not exist.
1094# 2211#
1095# Example:
1096# if python_mod_exists gtk; then
1097# echo "gtk support enabled"
1098# fi
1099python_mod_exists() {
1100 [[ "$1" ]] || die "${FUNCNAME} requires an argument!"
1101 python -c "import $1" &>/dev/null
1102}
1103
1104# @FUNCTION: python_mod_compile
1105# @USAGE: <file> [more files ...]
1106# @DESCRIPTION:
1107# Given filenames, it will pre-compile the module's .pyc and .pyo.
1108# This function should only be run in pkg_postinst()
1109#
1110# Example:
1111# python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
1112#
1113python_mod_compile() {
1114 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then
1115 die "${FUNCNAME}() cannot be used in this EAPI"
1116 fi
1117
1118 local f myroot myfiles=()
1119
1120 # Check if phase is pkg_postinst()
1121 [[ ${EBUILD_PHASE} != postinst ]] &&\
1122 die "${FUNCNAME} should only be run in pkg_postinst()"
1123
1124 # strip trailing slash
1125 myroot="${ROOT%/}"
1126
1127 # respect ROOT
1128 for f in "$@"; do
1129 [[ -f "${myroot}/${f}" ]] && myfiles+=("${myroot}/${f}")
1130 done
1131
1132 if ((${#myfiles[@]})); then
1133 "$(PYTHON -A)" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}"
1134 "$(PYTHON -A)" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null
1135 else
1136 ewarn "No files to compile!"
1137 fi
1138}
1139
1140# @FUNCTION: python_mod_optimize
1141# @USAGE: [options] [directory|file]
1142# @DESCRIPTION:
1143# If no arguments supplied, it will recompile not recursively all modules
1144# under sys.path (eg. /usr/lib/python2.6, /usr/lib/python2.6/site-packages).
1145#
1146# If supplied with arguments, it will recompile all modules recursively
1147# in the supplied directory.
1148# This function should only be run in pkg_postinst(). 2212# This function can be used only in pkg_postinst() phase.
1149#
1150# Options passed to this function are passed to compileall.py.
1151#
1152# Example:
1153# python_mod_optimize ctypesgencore
1154python_mod_optimize() { 2213python_mod_optimize() {
2214 _python_check_python_pkg_setup_execution
2215 _python_initialize_prefix_variables
2216
1155 # Check if phase is pkg_postinst(). 2217 # Check if phase is pkg_postinst().
1156 [[ ${EBUILD_PHASE} != "postinst" ]] && die "${FUNCNAME} should only be run in pkg_postinst()" 2218 [[ "${EBUILD_PHASE}" != "postinst" ]] && die "${FUNCNAME}() can be used only in pkg_postinst() phase"
1157 2219
2220 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis || _python_implementation || [[ "${CATEGORY}/${PN}" == "sys-apps/portage" ]]; then
2221 # PYTHON_ABI variable cannot be local in packages not supporting installation for multiple Python ABIs.
2222 local allow_evaluated_non_sitedir_paths="0" dir dirs=() evaluated_dirs=() evaluated_files=() file files=() iterated_PYTHON_ABIS options=() other_dirs=() other_files=() previous_PYTHON_ABI="${PYTHON_ABI}" return_code root site_packages_dirs=() site_packages_files=()
2223
2224 if _python_package_supporting_installation_for_multiple_python_abis; then
1158 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2225 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
1159 local dir file options=() other_dirs=() other_files=() PYTHON_ABI return_code root site_packages_absolute_dirs=() site_packages_dirs=() site_packages_absolute_files=() site_packages_files=() 2226 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
2227 fi
2228 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
2229 else
2230 if has "${EAPI:-0}" 0 1 2 3; then
2231 iterated_PYTHON_ABIS="${PYTHON_ABI:=$(PYTHON --ABI)}"
2232 else
2233 iterated_PYTHON_ABIS="${PYTHON_ABI}"
2234 fi
2235 fi
1160 2236
1161 # Strip trailing slash from ROOT. 2237 # Strip trailing slash from EROOT.
1162 root="${ROOT%/}" 2238 root="${EROOT%/}"
1163 2239
1164 # Respect ROOT and options passed to compileall.py.
1165 while (($#)); do 2240 while (($#)); do
1166 case "$1" in 2241 case "$1" in
2242 --allow-evaluated-non-sitedir-paths)
2243 allow_evaluated_non_sitedir_paths="1"
2244 ;;
1167 -l|-f|-q) 2245 -l|-f|-q)
1168 options+=("$1") 2246 options+=("$1")
1169 ;; 2247 ;;
1170 -d|-x) 2248 -d|-x)
1171 options+=("$1" "$2") 2249 options+=("$1" "$2")
1172 shift 2250 shift
1173 ;; 2251 ;;
2252 --)
2253 shift
2254 break
2255 ;;
1174 -*) 2256 -*)
1175 ewarn "${FUNCNAME}: Ignoring compile option $1" 2257 die "${FUNCNAME}(): Unrecognized option '$1'"
1176 ;; 2258 ;;
1177 *) 2259 *)
1178 if ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
1179 die "${FUNCNAME} does not support absolute paths of directories/files in site-packages directories"
1180 elif [[ "$1" =~ ^/ ]]; then
1181 if [[ -d "${root}/$1" ]]; then
1182 other_dirs+=("${root}/$1")
1183 elif [[ -f "${root}/$1" ]]; then
1184 other_files+=("${root}/$1")
1185 elif [[ -e "${root}/$1" ]]; then
1186 ewarn "'${root}/$1' is not a file or a directory!"
1187 else
1188 ewarn "'${root}/$1' does not exist!"
1189 fi
1190 else
1191 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do
1192 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
1193 site_packages_dirs+=("$1")
1194 break 2260 break
1195 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
1196 site_packages_files+=("$1")
1197 break
1198 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
1199 ewarn "'$1' is not a file or a directory!"
1200 else
1201 ewarn "'$1' does not exist!"
1202 fi
1203 done
1204 fi
1205 ;; 2261 ;;
1206 esac 2262 esac
1207 shift 2263 shift
1208 done 2264 done
1209 2265
2266 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
2267 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2268 fi
2269
2270 if [[ "$#" -eq 0 ]]; then
2271 die "${FUNCNAME}(): Missing files or directories"
2272 fi
2273
2274 while (($#)); do
2275 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2276 die "${FUNCNAME}(): Invalid argument '$1'"
2277 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
2278 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
2279 elif [[ "$1" =~ ^/ ]]; then
2280 if _python_package_supporting_installation_for_multiple_python_abis; then
2281 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
2282 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
2283 fi
2284 if [[ "$1" != *\$* ]]; then
2285 die "${FUNCNAME}(): '$1' has invalid syntax"
2286 fi
2287 if [[ "$1" == *.py ]]; then
2288 evaluated_files+=("$1")
2289 else
2290 evaluated_dirs+=("$1")
2291 fi
2292 else
2293 if [[ -d "${root}$1" ]]; then
2294 other_dirs+=("${root}$1")
2295 elif [[ -f "${root}$1" ]]; then
2296 other_files+=("${root}$1")
2297 elif [[ -e "${root}$1" ]]; then
2298 eerror "${FUNCNAME}(): '${root}$1' is not a regular file or a directory"
2299 else
2300 eerror "${FUNCNAME}(): '${root}$1' does not exist"
2301 fi
2302 fi
2303 else
2304 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2305 if [[ -d "${root}$(python_get_sitedir)/$1" ]]; then
2306 site_packages_dirs+=("$1")
2307 break
2308 elif [[ -f "${root}$(python_get_sitedir)/$1" ]]; then
2309 site_packages_files+=("$1")
2310 break
2311 elif [[ -e "${root}$(python_get_sitedir)/$1" ]]; then
2312 eerror "${FUNCNAME}(): '$1' is not a regular file or a directory"
2313 else
2314 eerror "${FUNCNAME}(): '$1' does not exist"
2315 fi
2316 done
2317 fi
2318 shift
2319 done
2320
1210 # Set additional options. 2321 # Set additional options.
1211 options+=("-q") 2322 options+=("-q")
1212 2323
1213 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do 2324 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
1214 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})); then 2325 if ((${#site_packages_dirs[@]})) || ((${#site_packages_files[@]})) || ((${#evaluated_dirs[@]})) || ((${#evaluated_files[@]})); then
1215 return_code="0" 2326 return_code="0"
1216 ebegin "Compilation and optimization of Python modules for Python ${PYTHON_ABI}" 2327 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1217 if ((${#site_packages_dirs[@]})); then 2328 if ((${#site_packages_dirs[@]})) || ((${#evaluated_dirs[@]})); then
1218 for dir in "${site_packages_dirs[@]}"; do 2329 for dir in "${site_packages_dirs[@]}"; do
1219 site_packages_absolute_dirs+=("${root}$(python_get_sitedir)/${dir}") 2330 dirs+=("${root}$(python_get_sitedir)/${dir}")
1220 done 2331 done
2332 for dir in "${evaluated_dirs[@]}"; do
2333 eval "dirs+=(\"\${root}${dir}\")"
2334 done
1221 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" || return_code="1" 2335 "$(PYTHON)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${dirs[@]}" || return_code="1"
2336 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1222 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${site_packages_absolute_dirs[@]}" &> /dev/null || return_code="1" 2337 "$(PYTHON)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${dirs[@]}" &> /dev/null || return_code="1"
1223 fi 2338 fi
1224 if ((${#site_packages_files[@]})); then 2339 _python_clean_compiled_modules "${dirs[@]}"
2340 fi
2341 if ((${#site_packages_files[@]})) || ((${#evaluated_files[@]})); then
1225 for file in "${site_packages_files[@]}"; do 2342 for file in "${site_packages_files[@]}"; do
1226 site_packages_absolute_files+=("${root}$(python_get_sitedir)/${file}") 2343 files+=("${root}$(python_get_sitedir)/${file}")
1227 done 2344 done
2345 for file in "${evaluated_files[@]}"; do
2346 eval "files+=(\"\${root}${file}\")"
2347 done
1228 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" || return_code="1" 2348 "$(PYTHON)" "${root}$(python_get_libdir)/py_compile.py" "${files[@]}" || return_code="1"
2349 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1229 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${site_packages_absolute_files[@]}" &> /dev/null || return_code="1" 2350 "$(PYTHON)" -O "${root}$(python_get_libdir)/py_compile.py" "${files[@]}" &> /dev/null || return_code="1"
2351 fi
2352 _python_clean_compiled_modules "${files[@]}"
1230 fi 2353 fi
1231 eend "${return_code}" 2354 eend "${return_code}"
1232 fi 2355 fi
1233 unset site_packages_absolute_dirs site_packages_absolute_files 2356 unset dirs files
1234 done 2357 done
1235 2358
1236 # Do not use PYTHON_ABI in next calls to python_get_libdir(). 2359 if _python_package_supporting_installation_for_multiple_python_abis; then
2360 # Restore previous value of PYTHON_ABI.
2361 if [[ -n "${previous_PYTHON_ABI}" ]]; then
2362 PYTHON_ABI="${previous_PYTHON_ABI}"
2363 else
1237 unset PYTHON_ABI 2364 unset PYTHON_ABI
2365 fi
2366 fi
1238 2367
1239 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then 2368 if ((${#other_dirs[@]})) || ((${#other_files[@]})); then
1240 return_code="0" 2369 return_code="0"
1241 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for Python $(PYTHON -A --ABI)" 2370 ebegin "Compilation and optimization of Python modules placed outside of site-packages directories for $(python_get_implementation) $(python_get_version)"
1242 if ((${#other_dirs[@]})); then 2371 if ((${#other_dirs[@]})); then
1243 "$(PYTHON -A)" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1" 2372 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" || return_code="1"
2373 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1244 "$(PYTHON -A)" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1" 2374 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/compileall.py" "${options[@]}" "${other_dirs[@]}" &> /dev/null || return_code="1"
2375 fi
2376 _python_clean_compiled_modules "${other_dirs[@]}"
1245 fi 2377 fi
1246 if ((${#other_files[@]})); then 2378 if ((${#other_files[@]})); then
1247 "$(PYTHON -A)" "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1" 2379 "$(PYTHON ${PYTHON_ABI})" "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" || return_code="1"
2380 if [[ "$(_python_get_implementation "${PYTHON_ABI}")" != "Jython" ]]; then
1248 "$(PYTHON -A)" -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1" 2381 "$(PYTHON ${PYTHON_ABI})" -O "${root}$(python_get_libdir)/py_compile.py" "${other_files[@]}" &> /dev/null || return_code="1"
2382 fi
2383 _python_clean_compiled_modules "${other_files[@]}"
1249 fi 2384 fi
1250 eend "${return_code}" 2385 eend "${return_code}"
1251 fi 2386 fi
1252 else 2387 else
2388 # Deprecated part of python_mod_optimize()
2389 # ewarn
2390 # ewarn "Deprecation Warning: Usage of ${FUNCNAME}() in packages not supporting installation"
2391 # ewarn "for multiple Python ABIs in EAPI <=2 is deprecated and will be disallowed on 2011-06-01."
2392 # ewarn "Use EAPI >=3 and call ${FUNCNAME}() with paths having appropriate syntax."
2393 # ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2394 # ewarn
2395
1253 local myroot mydirs=() myfiles=() myopts=() return_code="0" 2396 local myroot mydirs=() myfiles=() myopts=() return_code="0"
1254 2397
1255 # strip trailing slash 2398 # strip trailing slash
1256 myroot="${ROOT%/}" 2399 myroot="${EROOT%/}"
1257 2400
1258 # respect ROOT and options passed to compileall.py 2401 # respect EROOT and options passed to compileall.py
1259 while (($#)); do 2402 while (($#)); do
1260 case "$1" in 2403 case "$1" in
1261 -l|-f|-q) 2404 -l|-f|-q)
1262 myopts+=("$1") 2405 myopts+=("$1")
1263 ;; 2406 ;;
1264 -d|-x) 2407 -d|-x)
1265 myopts+=("$1" "$2") 2408 myopts+=("$1" "$2")
1266 shift 2409 shift
1267 ;; 2410 ;;
2411 --)
2412 shift
2413 break
2414 ;;
1268 -*) 2415 -*)
1269 ewarn "${FUNCNAME}: Ignoring compile option $1" 2416 die "${FUNCNAME}(): Unrecognized option '$1'"
1270 ;; 2417 ;;
1271 *) 2418 *)
1272 if [[ -d "${myroot}"/$1 ]]; then 2419 break
1273 mydirs+=("${myroot}/$1")
1274 elif [[ -f "${myroot}"/$1 ]]; then
1275 # Files are passed to python_mod_compile which is ROOT-aware
1276 myfiles+=("$1")
1277 elif [[ -e "${myroot}/$1" ]]; then
1278 ewarn "${myroot}/$1 is not a file or directory!"
1279 else
1280 ewarn "${myroot}/$1 does not exist!"
1281 fi
1282 ;; 2420 ;;
1283 esac 2421 esac
1284 shift 2422 shift
1285 done 2423 done
1286 2424
2425 if [[ "$#" -eq 0 ]]; then
2426 die "${FUNCNAME}(): Missing files or directories"
2427 fi
2428
2429 while (($#)); do
2430 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2431 die "${FUNCNAME}(): Invalid argument '$1'"
2432 elif [[ -d "${myroot}/${1#/}" ]]; then
2433 mydirs+=("${myroot}/${1#/}")
2434 elif [[ -f "${myroot}/${1#/}" ]]; then
2435 myfiles+=("${myroot}/${1#/}")
2436 elif [[ -e "${myroot}/${1#/}" ]]; then
2437 eerror "${FUNCNAME}(): ${myroot}/${1#/} is not a regular file or directory"
2438 else
2439 eerror "${FUNCNAME}(): ${myroot}/${1#/} does not exist"
2440 fi
2441 shift
2442 done
2443
1287 # set additional opts 2444 # set additional opts
1288 myopts+=(-q) 2445 myopts+=(-q)
1289 2446
1290 ebegin "Compilation and optimization of Python modules for Python $(PYTHON -A --ABI)" 2447 PYTHON_ABI="${PYTHON_ABI:-$(PYTHON --ABI)}"
2448
2449 ebegin "Compilation and optimization of Python modules for $(python_get_implementation) $(python_get_version)"
1291 if ((${#mydirs[@]})); then 2450 if ((${#mydirs[@]})); then
1292 "$(PYTHON -A)" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1" 2451 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" || return_code="1"
1293 "$(PYTHON -A)" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1" 2452 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/compileall.py" "${myopts[@]}" "${mydirs[@]}" &> /dev/null || return_code="1"
2453 _python_clean_compiled_modules "${mydirs[@]}"
1294 fi 2454 fi
1295 2455
1296 if ((${#myfiles[@]})); then 2456 if ((${#myfiles[@]})); then
2457 "$(PYTHON ${PYTHON_ABI})" "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" || return_code="1"
2458 "$(PYTHON ${PYTHON_ABI})" -O "${myroot}$(python_get_libdir)/py_compile.py" "${myfiles[@]}" &> /dev/null || return_code="1"
1297 python_mod_compile "${myfiles[@]}" 2459 _python_clean_compiled_modules "${myfiles[@]}"
1298 fi 2460 fi
1299 2461
1300 eend "${return_code}" 2462 eend "${return_code}"
1301 fi 2463 fi
1302} 2464}
1303 2465
1304# @FUNCTION: python_mod_cleanup 2466# @FUNCTION: python_mod_cleanup
1305# @USAGE: [directory|file] 2467# @USAGE: [--allow-evaluated-non-sitedir-paths] [--] <file|directory> [files|directories]
1306# @DESCRIPTION: 2468# @DESCRIPTION:
1307# Run with optional arguments, where arguments are Python modules. If none given, 2469# Delete orphaned byte-compiled Python modules corresponding to specified Python modules.
1308# it will look in /usr/lib/python[0-9].[0-9].
1309# 2470#
1310# It will recursively scan all compiled Python modules in the directories and
1311# determine if they are orphaned (i.e. their corresponding .py files are missing.)
1312# If they are, then it will remove their corresponding .pyc and .pyo files.
1313#
1314# This function should only be run in pkg_postrm(). 2471# This function can be used only in pkg_postrm() phase.
1315python_mod_cleanup() { 2472python_mod_cleanup() {
1316 local path py_file PYTHON_ABI SEARCH_PATH=() root 2473 _python_check_python_pkg_setup_execution
2474 _python_initialize_prefix_variables
2475
2476 local allow_evaluated_non_sitedir_paths="0" dir iterated_PYTHON_ABIS PYTHON_ABI="${PYTHON_ABI}" root search_paths=() sitedir
1317 2477
1318 # Check if phase is pkg_postrm(). 2478 # Check if phase is pkg_postrm().
1319 [[ ${EBUILD_PHASE} != "postrm" ]] && die "${FUNCNAME} should only be run in pkg_postrm()" 2479 [[ "${EBUILD_PHASE}" != "postrm" ]] && die "${FUNCNAME}() can be used only in pkg_postrm() phase"
1320 2480
2481 if _python_package_supporting_installation_for_multiple_python_abis; then
2482 if has "${EAPI:-0}" 0 1 2 3 && [[ -z "${PYTHON_ABIS}" ]]; then
2483 die "${FUNCNAME}(): python_pkg_setup() or python_execute_function() not called"
2484 fi
2485 iterated_PYTHON_ABIS="${PYTHON_ABIS}"
2486 else
2487 if has "${EAPI:-0}" 0 1 2 3; then
2488 iterated_PYTHON_ABIS="${PYTHON_ABI:-$(PYTHON --ABI)}"
2489 else
2490 iterated_PYTHON_ABIS="${PYTHON_ABI}"
2491 fi
2492 fi
2493
1321 # Strip trailing slash from ROOT. 2494 # Strip trailing slash from EROOT.
1322 root="${ROOT%/}" 2495 root="${EROOT%/}"
1323 2496
1324 if (($#)); then 2497 while (($#)); do
1325 if ! has "${EAPI:-0}" 0 1 2 || [[ -n "${SUPPORT_PYTHON_ABIS}" ]]; then 2498 case "$1" in
2499 --allow-evaluated-non-sitedir-paths)
2500 allow_evaluated_non_sitedir_paths="1"
2501 ;;
2502 --)
2503 shift
2504 break
2505 ;;
2506 -*)
2507 die "${FUNCNAME}(): Unrecognized option '$1'"
2508 ;;
2509 *)
2510 break
2511 ;;
2512 esac
2513 shift
2514 done
2515
2516 if [[ "${allow_evaluated_non_sitedir_paths}" == "1" ]] && ! _python_package_supporting_installation_for_multiple_python_abis; then
2517 die "${FUNCNAME}(): '--allow-evaluated-non-sitedir-paths' option cannot be used in ebuilds of packages not supporting installation for multiple Python ABIs"
2518 fi
2519
2520 if [[ "$#" -eq 0 ]]; then
2521 die "${FUNCNAME}(): Missing files or directories"
2522 fi
2523
2524 if ! has "${EAPI:-0}" 0 1 2 || _python_package_supporting_installation_for_multiple_python_abis || _python_implementation || [[ "${CATEGORY}/${PN}" == "sys-apps/portage" ]]; then
1326 while (($#)); do 2525 while (($#)); do
2526 if [[ "$1" =~ ^($|(\.|\.\.|/)($|/)) ]]; then
2527 die "${FUNCNAME}(): Invalid argument '$1'"
1327 if ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then 2528 elif ! _python_implementation && [[ "$1" =~ ^/usr/lib(32|64)?/python[[:digit:]]+\.[[:digit:]]+ ]]; then
1328 die "${FUNCNAME} does not support absolute paths of directories/files in site-packages directories" 2529 die "${FUNCNAME}(): Paths of directories / files in site-packages directories must be relative to site-packages directories"
1329 elif [[ "$1" =~ ^/ ]]; then 2530 elif [[ "$1" =~ ^/ ]]; then
1330 SEARCH_PATH+=("${root}/${1#/}") 2531 if _python_package_supporting_installation_for_multiple_python_abis; then
2532 if [[ "${allow_evaluated_non_sitedir_paths}" != "1" ]]; then
2533 die "${FUNCNAME}(): Absolute paths cannot be used in ebuilds of packages supporting installation for multiple Python ABIs"
2534 fi
2535 if [[ "$1" != *\$* ]]; then
2536 die "${FUNCNAME}(): '$1' has invalid syntax"
2537 fi
2538 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2539 eval "search_paths+=(\"\${root}$1\")"
2540 done
1331 else 2541 else
1332 for PYTHON_ABI in ${PYTHON_ABIS-${PYTHON_ABI-$(PYTHON -A --ABI)}}; do 2542 search_paths+=("${root}$1")
1333 SEARCH_PATH+=("${root}$(python_get_sitedir)/$1")
1334 done
1335 fi
1336 shift
1337 done
1338 else
1339 SEARCH_PATH=("${@#/}")
1340 SEARCH_PATH=("${SEARCH_PATH[@]/#/${root}/}")
1341 fi
1342 else
1343 local dir sitedir
1344 for dir in "${root}"/usr/lib*; do
1345 if [[ -d "${dir}" && ! -L "${dir}" ]]; then
1346 for sitedir in "${dir}"/python*/site-packages; do
1347 if [[ -d "${sitedir}" ]]; then
1348 SEARCH_PATH+=("${sitedir}")
1349 fi 2543 fi
2544 else
2545 for PYTHON_ABI in ${iterated_PYTHON_ABIS}; do
2546 search_paths+=("${root}$(python_get_sitedir)/$1")
1350 done 2547 done
1351 fi 2548 fi
2549 shift
1352 done 2550 done
1353 fi
1354
1355 local BLUE CYAN NORMAL
1356 if [[ "${NOCOLOR:-false}" =~ ^(false|no)$ ]]; then
1357 BLUE=$'\e[1;34m'
1358 CYAN=$'\e[1;36m'
1359 NORMAL=$'\e[0m'
1360 else 2551 else
1361 BLUE= 2552 # Deprecated part of python_mod_cleanup()
1362 CYAN= 2553 # ewarn
1363 NORMAL= 2554 # ewarn "Deprecation Warning: Usage of ${FUNCNAME}() in packages not supporting installation"
1364 fi 2555 # ewarn "for multiple Python ABIs in EAPI <=2 is deprecated and will be disallowed on 2011-06-01."
2556 # ewarn "Use EAPI >=3 and call ${FUNCNAME}() with paths having appropriate syntax."
2557 # ewarn "The ebuild needs to be fixed. Please report a bug, if it has not been already reported."
2558 # ewarn
1365 2559
1366 for path in "${SEARCH_PATH[@]}"; do 2560 search_paths=("${@#/}")
1367 if [[ -d "${path}" ]]; then 2561 search_paths=("${search_paths[@]/#/${root}/}")
1368 find "${path}" -name '*.py[co]' -print0 | while read -rd ''; do
1369 py_file="${REPLY%[co]}"
1370 [[ -f "${py_file}" || (! -f "${py_file}c" && ! -f "${py_file}o") ]] && continue
1371 einfo "${BLUE}<<< ${py_file}[co]${NORMAL}"
1372 rm -f "${py_file}"[co]
1373 done
1374
1375 # Attempt to delete directories, which may be empty.
1376 find "${path}" -type d | sort -r | while read -r dir; do
1377 rmdir "${dir}" 2>/dev/null && einfo "${CYAN}<<< ${dir}${NORMAL}"
1378 done
1379 elif [[ "${path}" == *.py && ! -f "${path}" && (-f "${path}c" || -f "${path}o") ]]; then
1380 einfo "${BLUE}<<< ${path}[co]${NORMAL}"
1381 rm -f "${path}"[co]
1382 fi 2562 fi
1383 done 2563
2564 _python_clean_compiled_modules "${search_paths[@]}"
1384} 2565}
2566
2567# ================================================================================================
2568# ===================================== DEPRECATED FUNCTIONS =====================================
2569# ================================================================================================
2570
2571# Scheduled for deletion on 2011-01-01.
2572python_version() {
2573 eerror "Use PYTHON() instead of python variable. Use python_get_*() instead of PYVER* variables."
2574 die "${FUNCNAME}() is banned"
2575}
2576
2577# Scheduled for deletion on 2011-01-01.
2578python_mod_exists() {
2579 eerror "Use USE dependencies and/or has_version() instead of ${FUNCNAME}()."
2580 die "${FUNCNAME}() is banned"
2581}
2582
2583# Scheduled for deletion on 2011-01-01.
2584python_tkinter_exists() {
2585 eerror "Use PYTHON_USE_WITH=\"xml\" and python_pkg_setup() instead of ${FUNCNAME}()."
2586 die "${FUNCNAME}() is banned"
2587}
2588
2589# Scheduled for deletion on 2011-04-01.
2590python_mod_compile() {
2591 eerror "Use python_mod_optimize() instead of ${FUNCNAME}()."
2592 die "${FUNCNAME}() is banned"
2593}

Legend:
Removed from v.1.84  
changed lines
  Added in v.1.105

  ViewVC Help
Powered by ViewVC 1.1.20