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

Contents of /eclass/python.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.43 - (hide annotations) (download)
Fri Aug 1 22:22:21 2008 UTC (6 years, 4 months ago) by pythonhead
Branch: MAIN
Changes since 1.42: +8 -8 lines
Renamed get_python_ funcs to python_get_

1 dev-zero 1.33 # Copyright 1999-2008 Gentoo Foundation
2 liquidx 1.1 # Distributed under the terms of the GNU General Public License v2
3 pythonhead 1.43 # $Header: /var/cvsroot/gentoo-x86/eclass/python.eclass,v 1.42 2008/07/28 21:56:40 pythonhead Exp $
4 liquidx 1.1
5 dev-zero 1.33 # @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 kloeri 1.32 inherit alternatives multilib
14 liquidx 1.1
15 liquidx 1.2
16 carlo 1.23 if [[ -n "${NEED_PYTHON}" ]] ; then
17 swegener 1.24 DEPEND=">=dev-lang/python-${NEED_PYTHON}"
18     RDEPEND="${DEPEND}"
19 carlo 1.22 fi
20 liquidx 1.18
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 liquidx 1.28 __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 liquidx 1.18 }
38    
39 dev-zero 1.33 # @FUNCTION: python_disable_pyc
40     # @DESCRIPTION:
41     # Tells python not to automatically recompile modules to .pyc/.pyo
42     # even if the timestamps/version stamps don't match. This is done
43     # to protect sandbox.
44 liquidx 1.5 #
45     # note: supported by >=dev-lang/python-2.2.3-r3 only.
46     #
47 liquidx 1.2 python_disable_pyc() {
48 liquidx 1.3 export PYTHON_DONTCOMPILE=1
49 liquidx 1.2 }
50 liquidx 1.1
51 dev-zero 1.33 # @FUNCTION: python_enable_pyc
52     # @DESCRIPTION:
53     # Tells python to automatically recompile modules to .pyc/.pyo if the
54     # timestamps/version stamps change
55 liquidx 1.4 python_enable_pyc() {
56     unset PYTHON_DONTCOMPILE
57     }
58    
59     python_disable_pyc
60    
61 dev-zero 1.33 # @FUNCTION: python_version
62     # @DESCRIPTION:
63     # Run without arguments and it will export the version of python
64     # currently in use as $PYVER; sets PYVER/PYVER_MAJOR/PYVER_MINOR
65 liquidx 1.18 __python_version_extract() {
66     verstr=$1
67     export PYVER_MAJOR=${verstr:0:1}
68     export PYVER_MINOR=${verstr:2:1}
69 liquidx 1.28 if [ "${verstr:3}x" = ".x" ]; then
70 swegener 1.29 export PYVER_MICRO=${verstr:4}
71 liquidx 1.28 fi
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 pythonhead 1.43 # @FUNCTION: python_get_libdir
84     # @DESCRIPTION:
85 pythonhead 1.42 # Run without arguments, returns the python library dir
86 pythonhead 1.43 python_get_libdir() {
87 pythonhead 1.42 python_version
88     echo "/usr/$(get_libdir)/python${PYVER}"
89     }
90    
91 pythonhead 1.43 # @FUNCTION: python_get_sitedir
92     # @DESCRIPTION:
93 pythonhead 1.42 # Run without arguments, returns the python site-packages dir
94 pythonhead 1.43 python_get_sitedir() {
95     echo "$(python_get_libdir)/site-packages"
96 pythonhead 1.42 }
97    
98 dev-zero 1.33 # @FUNCTION: python_makesym
99     # @DESCRIPTION:
100     # Run without arguments, it will create the /usr/bin/python symlinks
101     # to the latest installed version
102 liquidx 1.1 python_makesym() {
103 liquidx 1.10 alternatives_auto_makesym "/usr/bin/python" "python[0-9].[0-9]"
104     alternatives_auto_makesym "/usr/bin/python2" "python2.[0-9]"
105 liquidx 1.1 }
106    
107 dev-zero 1.33 # @FUNCTION: python_tkinter_exists
108     # @DESCRIPTION:
109     # Run without arguments, checks if python was compiled with Tkinter
110     # support. If not, prints an error message and dies.
111 liquidx 1.1 python_tkinter_exists() {
112     if ! python -c "import Tkinter" >/dev/null 2>&1; then
113     eerror "You need to recompile python with Tkinter support."
114 kloeri 1.30 eerror "Try adding: 'dev-lang/python tk'"
115 liquidx 1.27 eerror "in to /etc/portage/package.use"
116 liquidx 1.1 echo
117     die "missing tkinter support with installed python"
118     fi
119     }
120    
121 dev-zero 1.33 # @FUNCTION: python_mod_exists
122     # @USAGE: < module >
123     # @DESCRIPTION:
124     # Run with the module name as an argument. it will check if a
125     # python module is installed and loadable. it will return
126     # TRUE(0) if the module exists, and FALSE(1) if the module does
127     # not exist.
128 liquidx 1.1 #
129 dev-zero 1.33 # Example:
130 liquidx 1.1 # if python_mod_exists gtk; then
131 liquidx 1.28 # echo "gtk support enabled"
132 liquidx 1.1 # fi
133     python_mod_exists() {
134 liquidx 1.16 [ -z "$1" ] && die "${FUNCTION} requires an argument!"
135 pythonhead 1.7 if ! python -c "import $1" >/dev/null 2>&1; then
136 liquidx 1.1 return 1
137     fi
138     return 0
139     }
140    
141 dev-zero 1.33 # @FUNCTION: python_mod_compile
142 hawking 1.35 # @USAGE: < file > [more files ...]
143 dev-zero 1.33 # @DESCRIPTION:
144 hawking 1.35 # Given filenames, it will pre-compile the module's .pyc and .pyo.
145 hawking 1.37 # This function should only be run in pkg_postinst()
146 liquidx 1.1 #
147 dev-zero 1.33 # Example:
148 hawking 1.35 # python_mod_compile /usr/lib/python2.3/site-packages/pygoogle.py
149 liquidx 1.1 #
150     python_mod_compile() {
151 hawking 1.35 local f myroot
152 hawking 1.37
153     # Check if phase is pkg_postinst()
154     [[ ${EBUILD_PHASE} != postinst ]] &&\
155 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
156 hawking 1.37
157 liquidx 1.5 # allow compiling for older python versions
158     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
159     PYVER=${PYTHON_OVERRIDE_PYVER}
160 pythonhead 1.7 else
161 liquidx 1.5 python_version
162     fi
163 pythonhead 1.7
164 hawking 1.35 # strip trailing slash
165     myroot="${ROOT%/}"
166    
167     # respect ROOT
168     for f in $@; do
169     [ -f "${myroot}/${f}" ] && myfiles="${myfiles} ${myroot}/${f}"
170     done
171    
172     if [ -n "${myfiles}" ]; then
173     python${PYVER} ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
174     python${PYVER} -O ${myroot}/usr/$(get_libdir)/python${PYVER}/py_compile.py ${myfiles}
175 liquidx 1.1 else
176 hawking 1.35 ewarn "No files to compile!"
177 pythonhead 1.7 fi
178 liquidx 1.1 }
179    
180 dev-zero 1.33 # @FUNCTION: python_mod_optimize
181     # @USAGE: [ path ]
182     # @DESCRIPTION:
183     # If no arguments supplied, it will recompile all modules under
184     # sys.path (eg. /usr/lib/python2.3, /usr/lib/python2.3/site-packages/ ..)
185     # no recursively
186 liquidx 1.1 #
187 dev-zero 1.33 # If supplied with arguments, it will recompile all modules recursively
188     # in the supplied directory
189 hawking 1.37 # This function should only be run in pkg_postinst()
190 dev-zero 1.33 #
191 hawking 1.39 # Options passed to this function are passed to compileall.py
192     #
193 dev-zero 1.33 # Example:
194 hawking 1.36 # python_mod_optimize /usr/share/codegen
195 liquidx 1.1 python_mod_optimize() {
196 hawking 1.40 local mydirs myfiles myroot myopts
197 hawking 1.37
198     # Check if phase is pkg_postinst()
199     [[ ${EBUILD_PHASE} != postinst ]] &&\
200 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postinst()"
201 hawking 1.37
202 liquidx 1.13 # strip trailing slash
203 liquidx 1.16 myroot="${ROOT%/}"
204 liquidx 1.13
205 hawking 1.39 # respect ROOT and options passed to compileall.py
206     while [ $# -gt 0 ]; do
207     case $1 in
208     -l|-f|-q)
209     myopts="${myopts} $1"
210     ;;
211     -d|-x)
212 hawking 1.41 myopts="${myopts} $1 $2"
213 hawking 1.39 shift
214     ;;
215     -*)
216     ewarn "${FUNCNAME}: Ignoring compile option $1"
217     ;;
218     *)
219 hawking 1.40 [ ! -e "${myroot}/${1}" ] && ewarn "${myroot}/${1} doesn't exist!"
220     [ -d "${myroot}/${1#/}" ] && mydirs="${mydirs} ${myroot}/${1#/}"
221     # Files are passed to python_mod_compile which is ROOT-aware
222     [ -f "${myroot}/${1}" ] && myfiles="${myfiles} ${1}"
223 hawking 1.39 ;;
224     esac
225     shift
226 hawking 1.36 done
227    
228 liquidx 1.5 # allow compiling for older python versions
229     if [ -n "${PYTHON_OVERRIDE_PYVER}" ]; then
230     PYVER=${PYTHON_OVERRIDE_PYVER}
231 pythonhead 1.7 else
232 liquidx 1.5 python_version
233     fi
234 pythonhead 1.7
235 hawking 1.41 # set additional opts
236     myopts="${myopts} -q"
237 pythonhead 1.7
238 liquidx 1.10 ebegin "Byte compiling python modules for python-${PYVER} .."
239 hawking 1.36 if [ -n "${mydirs}" ]; then
240     python${PYVER} \
241     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
242 hawking 1.41 ${myopts} ${mydirs}
243 hawking 1.36 python${PYVER} -O \
244     ${myroot}/usr/$(get_libdir)/python${PYVER}/compileall.py \
245 hawking 1.41 ${myopts} ${mydirs}
246 hawking 1.36 fi
247    
248     if [ -n "${myfiles}" ]; then
249     python_mod_compile ${myfiles}
250     fi
251    
252 liquidx 1.5 eend $?
253 liquidx 1.1 }
254    
255 dev-zero 1.33 # @FUNCTION: python_mod_cleanup
256     # @USAGE: [ dir ]
257     # @DESCRIPTION:
258     # Run with optional arguments, where arguments are directories of
259     # python modules. if none given, it will look in /usr/lib/python[0-9].[0-9]
260     #
261     # It will recursively scan all compiled python modules in the directories
262     # and determine if they are orphaned (eg. their corresponding .py is missing.)
263     # if they are, then it will remove their corresponding .pyc and .pyo
264 hawking 1.37 #
265     # This function should only be run in pkg_postrm()
266 liquidx 1.1 python_mod_cleanup() {
267 liquidx 1.13 local SEARCH_PATH myroot
268 liquidx 1.16
269 hawking 1.38 # Check if phase is pkg_postrm()
270 hawking 1.37 [[ ${EBUILD_PHASE} != postrm ]] &&\
271 hawking 1.39 die "${FUNCNAME} should only be run in pkg_postrm()"
272 hawking 1.37
273 liquidx 1.13 # strip trailing slash
274 liquidx 1.16 myroot="${ROOT%/}"
275 liquidx 1.1
276 liquidx 1.5 if [ $# -gt 0 ]; then
277     for path in $@; do
278 liquidx 1.13 SEARCH_PATH="${SEARCH_PATH} ${myroot}/${path#/}"
279 pythonhead 1.7 done
280 liquidx 1.5 else
281 eradicator 1.15 for path in ${myroot}/usr/lib*/python*/site-packages; do
282 liquidx 1.5 SEARCH_PATH="${SEARCH_PATH} ${path}"
283     done
284     fi
285 pythonhead 1.7
286 liquidx 1.1 for path in ${SEARCH_PATH}; do
287 liquidx 1.11 einfo "Cleaning orphaned Python bytecode from ${path} .."
288 hawking 1.34 for obj in $(find ${path} -name '*.py[co]'); do
289 kloeri 1.31 src_py="${obj%[co]}"
290 liquidx 1.1 if [ ! -f "${src_py}" ]; then
291     einfo "Purging ${src_py}[co]"
292     rm -f ${src_py}[co]
293     fi
294 liquidx 1.12 done
295     # attempt to remove directories that maybe empty
296     for dir in $(find ${path} -type d | sort -r); do
297     rmdir ${dir} 2>/dev/null
298 liquidx 1.1 done
299 pythonhead 1.7 done
300 liquidx 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20