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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.60  
changed lines
  Added in v.1.132

  ViewVC Help
Powered by ViewVC 1.1.20