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.25 2006/06/16 13:54:25 marienz 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


if [[ -n "${NEED_PYTHON}" ]] ; then
        DEPEND=">=dev-lang/python-${NEED_PYTHON}"
        RDEPEND="${DEPEND}"
fi

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