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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.113

  ViewVC Help
Powered by ViewVC 1.1.20