gentoo-x86/eclass/python.eclass

# Copyright 1999-2004 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /home/cvsroot/gentoo-x86/eclass/python.eclass,v 1.13 2004/01/18 01:32:35 liquidx 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

ECLASS="python"
INHERITED="$INHERITED $ECLASS"

#
# 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() {
        local tmpstr
        python=${python:-/usr/bin/python}
        tmpstr="$(${python} -V 2>&1 )"
        export PYVER_ALL="${tmpstr#Python }"

        export PYVER_MAJOR=$(echo ${PYVER_ALL} | cut -d. -f1)
        export PYVER_MINOR=$(echo ${PYVER_ALL} | cut -d. -f2)
        export PYVER_MICRO=$(echo ${PYVER_ALL} | cut -d. -f3-)
        export PYVER="${PYVER_MAJOR}.${PYVER_MINOR}"
}

#
# 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, it will return TRUE(0) if python is compiled
#         with tkinter or FALSE(1) if python is compiled without tkinter.
#
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() {
        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=$(echo ${ROOT} | sed 's:/$::')

        # 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=$(echo ${ROOT} | sed 's:/$::')

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