| 1 |
# Copyright 1999-2008 Gentoo Foundation
|
| 2 |
# Distributed under the terms of the GNU General Public License v2
|
| 3 |
# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.50 2008/10/26 21:21:34 hawking Exp $
|
| 4 |
|
| 5 |
# @ECLASS: python.eclass
|
| 6 |
# @MAINTAINER:
|
| 7 |
# python@gentoo.org
|
| 8 |
#
|
| 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:
|
| 12 |
# Some useful functions for dealing with python.
|
| 13 |
inherit alternatives multilib
|
| 14 |
|
| 15 |
|
| 16 |
if [[ -n "${NEED_PYTHON}" ]] ; then
|
| 17 |
DEPEND=">=dev-lang/python-${NEED_PYTHON}"
|
| 18 |
RDEPEND="${DEPEND}"
|
| 19 |
fi
|
| 20 |
|
| 21 |
__python_eclass_test() {
|
| 22 |
__python_version_extract 2.3
|
| 23 |
echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
|
| 24 |
echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
|
| 25 |
__python_version_extract 2.3.4
|
| 26 |
echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
|
| 27 |
echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
|
| 28 |
__python_version_extract 2.3.5
|
| 29 |
echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
|
| 30 |
echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
|
| 31 |
__python_version_extract 2.4
|
| 32 |
echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
|
| 33 |
echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
|
| 34 |
__python_version_extract 2.5b3
|
| 35 |
echo -n "2.5b3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
|
| 36 |
echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
|
| 37 |
}
|
| 38 |
|
| 39 |
# @FUNCTION: python_version
|
| 40 |
# @DESCRIPTION:
|
| 41 |
# Run without arguments and it will export the version of python
|
| 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 |
|
| 53 |
python_version() {
|
| 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 |
|
| 62 |
# @FUNCTION: python_disable_pyc
|
| 63 |
# @DESCRIPTION:
|
| 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 |
#
|
| 70 |
python_disable_pyc() {
|
| 71 |
python_version
|
| 72 |
if [[ ${PYVER/./,} -ge 2,6 ]]; then
|
| 73 |
export PYTHONDONTWRITEBYTECODE=1
|
| 74 |
else
|
| 75 |
export PYTHON_DONTCOMPILE=1
|
| 76 |
fi
|
| 77 |
}
|
| 78 |
|
| 79 |
# @FUNCTION: python_enable_pyc
|
| 80 |
# @DESCRIPTION:
|
| 81 |
# Tells python to automatically recompile modules to .pyc/.pyo if the
|
| 82 |
# timestamps/version stamps change
|
| 83 |
python_enable_pyc() {
|
| 84 |
python_version
|
| 85 |
if [[ ${PYVER/./,} -ge 2,6 ]]; then
|
| 86 |
unset PYTHONDONTWRITEBYTECODE
|
| 87 |
else
|
| 88 |
unset PYTHON_DONTCOMPILE
|
| 89 |
fi
|
| 90 |
}
|
| 91 |
|
| 92 |
python_disable_pyc
|
| 93 |
|
| 94 |
# @FUNCTION: python_get_libdir
|
| 95 |
# @DESCRIPTION:
|
| 96 |
# Run without arguments, returns the python library dir
|
| 97 |
python_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
|
| 105 |
python_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
|
| 113 |
python_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.
|
| 122 |
python_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
|
| 144 |
python_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 |
#
|
| 158 |
python_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
|
| 203 |
python_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
|
| 215 |
case $1 in
|
| 216 |
-l|-f|-q)
|
| 217 |
myopts+=("$1")
|
| 218 |
;;
|
| 219 |
-d|-x)
|
| 220 |
myopts+=("$1" "$2")
|
| 221 |
shift
|
| 222 |
;;
|
| 223 |
-*)
|
| 224 |
ewarn "${FUNCNAME}: Ignoring compile option $1"
|
| 225 |
;;
|
| 226 |
*)
|
| 227 |
if [[ -d "${myroot}"/$1 ]]; then
|
| 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 |
;;
|
| 238 |
esac
|
| 239 |
shift
|
| 240 |
done
|
| 241 |
|
| 242 |
# allow compiling for older python versions
|
| 243 |
if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
|
| 244 |
PYVER=${PYTHON_OVERRIDE_PYVER}
|
| 245 |
else
|
| 246 |
python_version
|
| 247 |
fi
|
| 248 |
|
| 249 |
# set additional opts
|
| 250 |
myopts+=(-q)
|
| 251 |
|
| 252 |
ebegin "Byte compiling python modules for python-${PYVER} .."
|
| 253 |
if ((${#mydirs[@]})); then
|
| 254 |
python${PYVER} \
|
| 255 |
"${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
|
| 256 |
"${myopts[@]}" "${mydirs[@]}"
|
| 257 |
python${PYVER} -O \
|
| 258 |
"${myroot}"/usr/$(get_libdir)/python${PYVER}/compileall.py \
|
| 259 |
"${myopts[@]}" "${mydirs[@]}"
|
| 260 |
fi
|
| 261 |
|
| 262 |
if ((${#myfiles[@]})); then
|
| 263 |
python_mod_compile "${myfiles[@]}"
|
| 264 |
fi
|
| 265 |
|
| 266 |
eend $?
|
| 267 |
}
|
| 268 |
|
| 269 |
# @FUNCTION: python_mod_cleanup
|
| 270 |
# @USAGE: [ dir ]
|
| 271 |
# @DESCRIPTION:
|
| 272 |
# Run with optional arguments, where arguments are directories of
|
| 273 |
# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
|
| 274 |
#
|
| 275 |
# It will recursively scan all compiled python modules in the directories
|
| 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()
|
| 280 |
python_mod_cleanup() {
|
| 281 |
local SEARCH_PATH=() myroot src_py
|
| 282 |
|
| 283 |
# Check if phase is pkg_postrm()
|
| 284 |
[[ ${EBUILD_PHASE} != postrm ]] &&\
|
| 285 |
die "${FUNCNAME} should only be run in pkg_postrm()"
|
| 286 |
|
| 287 |
# strip trailing slash
|
| 288 |
myroot="${ROOT%/}"
|
| 289 |
|
| 290 |
if (($#)); then
|
| 291 |
SEARCH_PATH=("${@#/}")
|
| 292 |
SEARCH_PATH=("${SEARCH_PATH[@]/#/$myroot/}")
|
| 293 |
else
|
| 294 |
SEARCH_PATH=("${myroot}"/usr/lib*/python*/site-packages)
|
| 295 |
fi
|
| 296 |
|
| 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
|
| 311 |
}
|
Parent Directory
| 
Revision Log