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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.72  
changed lines
  Added in v.1.145

  ViewVC Help
Powered by ViewVC 1.1.20