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

Diff of /eclass/python.eclass

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

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

Legend:
Removed from v.1.53  
changed lines
  Added in v.1.123

  ViewVC Help
Powered by ViewVC 1.1.20