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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.163 - (show annotations) (download)
Thu Dec 20 06:26:16 2012 UTC (22 months ago) by floppym
Branch: MAIN
Changes since 1.162: +2 -1 lines
Add pypy version mapping for 2.0 => 2.7.

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

  ViewVC Help
Powered by ViewVC 1.1.20