gentoo-x86/eclass/python.eclass

# Copyright 1999-2004 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.21 2005/07/11 15:08:06 swegener Exp $
#
# Author: Alastair Tse <liquidx@gentoo.org>
#
# A Utility Eclass that should be inherited by anything that deals with
# Python or Python modules.
#
# - Features:
# python_version()        - sets PYVER/PYVER_MAJOR/PYVER_MINOR
# python_tkinter_exists() - Checks for tkinter support in python
# python_mod_exists()     - Checks if a python module exists
# python_mod_compile()    - Compiles a .py file to a .pyc/.pyo
# python_mod_optimize()   - Generates .pyc/.pyo precompiled scripts
# python_mod_cleanup()    - Goes through /usr/lib*/python* to remove
#                           orphaned *.pyc *.pyo
# python_makesym()        - Makes /usr/bin/python symlinks

inherit alternatives


__python_eclass_test() {
        __python_version_extract 2.3
        echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
        echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
        __python_version_extract 2.3.4
        echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
        echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
        __python_version_extract 2.3.5
        echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
        echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
        __python_version_extract 2.4
        echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
        echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
}

#
# name:   python_disable/enable_pyc
# desc:   tells python not to automatically recompile modules to .pyc/.pyo
#         even if the timestamps/version stamps don't match. this is
#         done to protect sandbox.
#
# note:   supported by >=dev-lang/python-2.2.3-r3 only.
#
python_disable_pyc() {
        export PYTHON_DONTCOMPILE=1
}

python_enable_pyc() {
        unset PYTHON_DONTCOMPILE
}

python_disable_pyc

#
# name:   python_version
# desc:   run without arguments and it will export the version of python
#         currently in use as $PYVER
#

__python_version_extract() {
        verstr=$1
        export PYVER_MAJOR=${verstr:0:1}
        export PYVER_MINOR=${verstr:2:1}
        export PYVER_MICRO=${verstr:4}
        export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
}

python_version() {
        local tmpstr
        python=${python:-/usr/bin/python}
        tmpstr="$(${python} -V 2>&1 )"
        export PYVER_ALL="${tmpstr#Python }"
        __python_version_extract $PYVER_ALL
}

#
# name:   python_makesym
# desc:   run without arguments, it will create the /usr/bin/python symlinks
#         to the latest installed version
#
python_makesym() {
        alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
        alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
}

#
# name:   python_tkinter_exists
# desc:   run without arguments, checks if python was compiled with Tkinter
#         support.  If not, prints an error message and dies.
#
python_tkinter_exists() {
        if ! python -c "import Tkinter" >/dev/null 2>&1; then
                eerror "You need to recompile python with Tkinter support."
                eerror "That means: USE='tcltk' emerge python"
                echo
                die "missing tkinter support with installed python"
        fi
}

#
# name:   python_mod_exists
# desc:   run with the module name as an argument. it will check if a
#         python module is installed and loadable. it will return
#         TRUE(0) if the module exists, and FALSE(1) if the module does
#         not exist.
# exam:
#         if python_mod_exists gtk; then
#             echo "gtk support enabled
#         fi
#
python_mod_exists() {
        [ -z "$1" ] && die "${FUNCTION} requires an argument!"
        if ! python -c "import $1" >/dev/null 2>&1; then
                return 1
        fi
        return 0
}

#
# name:   python_mod_compile
# desc:   given a filename, it will pre-compile the module's .pyc and .pyo.
#         should only be run in pkg_postinst()
# exam:
#         python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
#
python_mod_compile() {
        # allow compiling for older python versions
        if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
                PYVER=${PYTHON_OVERRIDE_PYVER}
        else
                python_version
        fi

        if [ -f "$1" ]; then
                python${PYVER} -c "import py_compile; py_compile.compile('${1}')" || \
                        ewarn "Failed to compile ${1}"
                python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" || \
                        ewarn "Failed to compile ${1}"
        else
                ewarn "Unable to find ${1}"
        fi
}

#
# name:   python_mod_optimize
# desc:   if no arguments supplied, it will recompile all modules under
#         sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
#         no recursively
#
#         if supplied with arguments, it will recompile all modules recursively
#         in the supplied directory
# exam:
#         python_mod_optimize ${ROOT}usr/share/codegen
#
python_mod_optimize() {
        local myroot
        # strip trailing slash
        myroot="${ROOT%/}"

        # allow compiling for older python versions
        if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
                PYVER=${PYTHON_OVERRIDE_PYVER}
        else
                python_version
        fi

        # set opts
        if [ "${PYVER}" = "2.2" ]; then
                compileopts=""
        else
                compileopts="-q"
        fi

        ebegin "Byte compiling python modules for python-${PYVER} .."
        python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
        python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
        eend $?
}

#
# name:   python_mod_cleanup
# desc:   run with optional arguments, where arguments are directories of
#         python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
#
#         it will recursively scan all compiled python modules in the directories
#         and determine if they are orphaned (eg. their corresponding .py is missing.)
#         if they are, then it will remove their corresponding .pyc and .pyo
#
python_mod_cleanup() {
        local SEARCH_PATH myroot

        # strip trailing slash
        myroot="${ROOT%/}"

        if [ $# -gt 0 ]; then
                for path in $@; do
                        SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
                done
        else
                for path in ${myroot}/usr/lib*/python*/site-packages; do
                        SEARCH_PATH="${SEARCH_PATH} ${path}"
                done
        fi

        for path in ${SEARCH_PATH}; do
                einfo "Cleaning orphaned Python bytecode from ${path} .."
                for obj in $(find ${path} -name *.pyc); do
                        src_py="${obj%c}"
                        if [ ! -f "${src_py}" ]; then
                                einfo "Purging ${src_py}[co]"
                                rm -f ${src_py}[co]
                        fi
                done
                # attempt to remove directories that maybe empty
                for dir in $(find ${path} -type d | sort -r); do
                        rmdir ${dir} 2>/dev/null
                done
        done
}
1	chriswhite	1.1.1.1	# Copyright 1999-2004 Gentoo Foundation
2	liquidx	1.1	# Distributed under the terms of the GNU General Public License v2
3	chriswhite	1.1.1.1	# $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.21 2005/07/11 15:08:06 swegener Exp $
4	liquidx	1.1	#
5			# Author: Alastair Tse <liquidx@gentoo.org>
6			#
7			# A Utility Eclass that should be inherited by anything that deals with
8			# Python or Python modules.
9			#
10			# - Features:
11			# python_version() - sets PYVER/PYVER_MAJOR/PYVER_MINOR
12			# python_tkinter_exists() - Checks for tkinter support in python
13			# python_mod_exists() - Checks if a python module exists
14			# python_mod_compile() - Compiles a .py file to a .pyc/.pyo
15			# python_mod_optimize() - Generates .pyc/.pyo precompiled scripts
16	chriswhite	1.1.1.1	# python_mod_cleanup() - Goes through /usr/lib/python to remove
17	liquidx	1.1	# orphaned .pyc .pyo
18			# python_makesym() - Makes /usr/bin/python symlinks
19
20			inherit alternatives
21
22	chriswhite	1.1.1.1
23
24			__python_eclass_test() {
25			__python_version_extract 2.3
26			echo -n "2.3 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
27			echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
28			__python_version_extract 2.3.4
29			echo -n "2.3.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
30			echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
31			__python_version_extract 2.3.5
32			echo -n "2.3.5 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
33			echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
34			__python_version_extract 2.4
35			echo -n "2.4 -> PYVER: $PYVER PYVER_MAJOR: $PYVER_MAJOR"
36			echo " PYVER_MINOR: $PYVER_MINOR PYVER_MICRO: $PYVER_MICRO"
37			}
38
39			#
40			# name: python_disable/enable_pyc
41			# desc: tells python not to automatically recompile modules to .pyc/.pyo
42			# even if the timestamps/version stamps don't match. this is
43			# done to protect sandbox.
44			#
45			# note: supported by >=dev-lang/python-2.2.3-r3 only.
46			#
47			python_disable_pyc() {
48			export PYTHON_DONTCOMPILE=1
49			}
50
51			python_enable_pyc() {
52			unset PYTHON_DONTCOMPILE
53			}
54
55			python_disable_pyc
56	liquidx	1.1
57			#
58			# name: python_version
59			# desc: run without arguments and it will export the version of python
60			# currently in use as $PYVER
61			#
62	chriswhite	1.1.1.1
63			__python_version_extract() {
64			verstr=$1
65			export PYVER_MAJOR=${verstr:0:1}
66			export PYVER_MINOR=${verstr:2:1}
67			export PYVER_MICRO=${verstr:4}
68			export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
69			}
70
71	liquidx	1.1	python_version() {
72			local tmpstr
73			python=${python:-/usr/bin/python}
74			tmpstr="$(${python} -V 2>&1 )"
75			export PYVER_ALL="${tmpstr#Python }"
76	chriswhite	1.1.1.1	__python_version_extract $PYVER_ALL
77	liquidx	1.1	}
78
79			#
80			# name: python_makesym
81			# desc: run without arguments, it will create the /usr/bin/python symlinks
82			# to the latest installed version
83			#
84			python_makesym() {
85	chriswhite	1.1.1.1	alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
86			alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
87	liquidx	1.1	}
88
89			#
90			# name: python_tkinter_exists
91	chriswhite	1.1.1.1	# desc: run without arguments, checks if python was compiled with Tkinter
92			# support. If not, prints an error message and dies.
93	liquidx	1.1	#
94			python_tkinter_exists() {
95			if ! python -c "import Tkinter" >/dev/null 2>&1; then
96			eerror "You need to recompile python with Tkinter support."
97			eerror "That means: USE='tcltk' emerge python"
98			echo
99			die "missing tkinter support with installed python"
100			fi
101			}
102
103			#
104			# name: python_mod_exists
105	chriswhite	1.1.1.1	# desc: run with the module name as an argument. it will check if a
106	liquidx	1.1	# python module is installed and loadable. it will return
107			# TRUE(0) if the module exists, and FALSE(1) if the module does
108			# not exist.
109	chriswhite	1.1.1.1	# exam:
110	liquidx	1.1	# if python_mod_exists gtk; then
111			# echo "gtk support enabled
112			# fi
113			#
114			python_mod_exists() {
115	chriswhite	1.1.1.1	[ -z "$1" ] && die "${FUNCTION} requires an argument!"
116	liquidx	1.1	if ! python -c "import $1" >/dev/null 2>&1; then
117			return 1
118			fi
119			return 0
120			}
121
122			#
123			# name: python_mod_compile
124			# desc: given a filename, it will pre-compile the module's .pyc and .pyo.
125			# should only be run in pkg_postinst()
126			# exam:
127			# python_mod_compile ${ROOT}usr/lib/python2.3/site-packages/pygoogle.py
128			#
129			python_mod_compile() {
130	chriswhite	1.1.1.1	# allow compiling for older python versions
131			if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
132			PYVER=${PYTHON_OVERRIDE_PYVER}
133			else
134			python_version
135			fi
136
137	liquidx	1.1	if [ -f "$1" ]; then
138	chriswhite	1.1.1.1	python${PYVER} -c "import py_compile; py_compile.compile('${1}')" \|\| \
139			ewarn "Failed to compile ${1}"
140			python${PYVER} -O -c "import py_compile; py_compile.compile('${1}')" \|\| \
141	liquidx	1.1	ewarn "Failed to compile ${1}"
142			else
143			ewarn "Unable to find ${1}"
144	chriswhite	1.1.1.1	fi
145	liquidx	1.1	}
146
147			#
148			# name: python_mod_optimize
149			# desc: if no arguments supplied, it will recompile all modules under
150			# sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
151			# no recursively
152	chriswhite	1.1.1.1	#
153	liquidx	1.1	# if supplied with arguments, it will recompile all modules recursively
154			# in the supplied directory
155			# exam:
156			# python_mod_optimize ${ROOT}usr/share/codegen
157			#
158			python_mod_optimize() {
159	chriswhite	1.1.1.1	local myroot
160			# strip trailing slash
161			myroot="${ROOT%/}"
162
163			# allow compiling for older python versions
164			if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
165			PYVER=${PYTHON_OVERRIDE_PYVER}
166			else
167			python_version
168			fi
169
170			# set opts
171			if [ "${PYVER}" = "2.2" ]; then
172			compileopts=""
173			else
174			compileopts="-q"
175			fi
176
177			ebegin "Byte compiling python modules for python-${PYVER} .."
178			python${PYVER} ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
179			python${PYVER} -O ${myroot}/usr/lib/python${PYVER}/compileall.py ${compileopts} $@
180			eend $?
181	liquidx	1.1	}
182
183			#
184			# name: python_mod_cleanup
185			# desc: run with optional arguments, where arguments are directories of
186			# python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
187	chriswhite	1.1.1.1	#
188	liquidx	1.1	# it will recursively scan all compiled python modules in the directories
189			# and determine if they are orphaned (eg. their corresponding .py is missing.)
190			# if they are, then it will remove their corresponding .pyc and .pyo
191			#
192			python_mod_cleanup() {
193	chriswhite	1.1.1.1	local SEARCH_PATH myroot
194	liquidx	1.1
195	chriswhite	1.1.1.1	# strip trailing slash
196			myroot="${ROOT%/}"
197
198			if [ $# -gt 0 ]; then
199			for path in $@; do
200			SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
201			done
202			else
203			for path in ${myroot}/usr/lib/python/site-packages; do
204			SEARCH_PATH="${SEARCH_PATH} ${path}"
205			done
206			fi
207	liquidx	1.1
208			for path in ${SEARCH_PATH}; do
209	chriswhite	1.1.1.1	einfo "Cleaning orphaned Python bytecode from ${path} .."
210	liquidx	1.1	for obj in $(find ${path} -name *.pyc); do
211	chriswhite	1.1.1.1	src_py="${obj%c}"
212	liquidx	1.1	if [ ! -f "${src_py}" ]; then
213			einfo "Purging ${src_py}[co]"
214			rm -f ${src_py}[co]
215			fi
216			done
217	chriswhite	1.1.1.1	# attempt to remove directories that maybe empty
218			for dir in $(find ${path} -type d \| sort -r); do
219			rmdir ${dir} 2>/dev/null
220			done
221			done
222	liquidx	1.1	}