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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.168 - (show annotations) (download)
Wed Sep 18 18:47:59 2013 UTC (14 months, 1 week ago) by mgorny
Branch: MAIN
Changes since 1.167: +4 -1 lines
Add a note not to add new Python versions to python.eclass.

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

  ViewVC Help
Powered by ViewVC 1.1.20