setup.py revision 9b5abcd48c3f2277c8c328ff7d2db26b272618c5 
1# Autodetecting setup.py script for building the Python extensions
2#
3# To be fixed:
4#   Implement --disable-modules setting
5#
6
7__version__ = "$Revision$"
8
9import sys, os, getopt
10from distutils import sysconfig
11from distutils import text_file
12from distutils.errors import *
13from distutils.core import Extension, setup
14from distutils.command.build_ext import build_ext
15
16# This global variable is used to hold the list of modules to be disabled.
17disabled_module_list = []
18
19def find_file(filename, std_dirs, paths):
20    """Searches for the directory where a given file is located,
21    and returns a possibly-empty list of additional directories, or None
22    if the file couldn't be found at all.
23
24    'filename' is the name of a file, such as readline.h or libcrypto.a.
25    'std_dirs' is the list of standard system directories; if the
26        file is found in one of them, no additional directives are needed.
27    'paths' is a list of additional locations to check; if the file is
28        found in one of them, the resulting list will contain the directory.
29    """
30
31    # Check the standard locations
32    for dir in std_dirs:
33        f = os.path.join(dir, filename)
34        if os.path.exists(f): return []
35
36    # Check the additional directories
37    for dir in paths:
38        f = os.path.join(dir, filename)
39        if os.path.exists(f):
40            return [dir]
41
42    # Not found anywhere
43    return None
44
45def find_library_file(compiler, libname, std_dirs, paths):
46    filename = compiler.library_filename(libname, lib_type='shared')
47    result = find_file(filename, std_dirs, paths)
48    if result is not None: return result
49
50    filename = compiler.library_filename(libname, lib_type='static')
51    result = find_file(filename, std_dirs, paths)
52    return result
53
54def module_enabled(extlist, modname):
55    """Returns whether the module 'modname' is present in the list
56    of extensions 'extlist'."""
57    extlist = [ext for ext in extlist if ext.name == modname]
58    return len(extlist)
59
60class PyBuildExt(build_ext):
61
62    def build_extensions(self):
63
64        # Detect which modules should be compiled
65        self.detect_modules()
66
67        # Remove modules that are present on the disabled list
68        self.extensions = [ext for ext in self.extensions
69                           if ext.name not in disabled_module_list]
70
71        # Fix up the autodetected modules, prefixing all the source files
72        # with Modules/ and adding Python's include directory to the path.
73        (srcdir,) = sysconfig.get_config_vars('srcdir')
74
75        # Figure out the location of the source code for extension modules
76        moddir = os.path.join(os.getcwd(), srcdir, 'Modules')
77        moddir = os.path.normpath(moddir)
78        srcdir, tail = os.path.split(moddir)
79        srcdir = os.path.normpath(srcdir)
80        moddir = os.path.normpath(moddir)
81
82        # Fix up the paths for scripts, too
83        self.distribution.scripts = [os.path.join(srcdir, filename)
84                                     for filename in self.distribution.scripts]
85
86        for ext in self.extensions[:]:
87            ext.sources = [ os.path.join(moddir, filename)
88                            for filename in ext.sources ]
89            ext.include_dirs.append( '.' ) # to get config.h
90            ext.include_dirs.append( os.path.join(srcdir, './Include') )
91
92            # If a module has already been built statically,
93            # don't build it here
94            if ext.name in sys.builtin_module_names:
95                self.extensions.remove(ext)
96
97        # Parse Modules/Setup to figure out which modules are turned
98        # on in the file.
99        input = text_file.TextFile('Modules/Setup', join_lines=1)
100        remove_modules = []
101        while 1:
102            line = input.readline()
103            if not line: break
104            line = line.split()
105            remove_modules.append( line[0] )
106        input.close()
107
108        for ext in self.extensions[:]:
109            if ext.name in remove_modules:
110                self.extensions.remove(ext)
111
112        # When you run "make CC=altcc" or something similar, you really want
113        # those environment variables passed into the setup.py phase.  Here's
114        # a small set of useful ones.
115        compiler = os.environ.get('CC')
116        linker_so = os.environ.get('LDSHARED')
117        args = {}
118        # unfortunately, distutils doesn't let us provide separate C and C++
119        # compilers
120        if compiler is not None:
121            args['compiler_so'] = compiler
122        if linker_so is not None:
123            args['linker_so'] = linker_so + ' -shared'
124        self.compiler.set_executables(**args)
125
126        build_ext.build_extensions(self)
127
128    def build_extension(self, ext):
129
130        try:
131            build_ext.build_extension(self, ext)
132        except (CCompilerError, DistutilsError), why:
133            self.announce('WARNING: building of extension "%s" failed: %s' %
134                          (ext.name, sys.exc_info()[1]))
135
136    def get_platform (self):
137        # Get value of sys.platform
138        platform = sys.platform
139        if platform[:6] =='cygwin':
140            platform = 'cygwin'
141        elif platform[:4] =='beos':
142            platform = 'beos'
143
144        return platform
145
146    def detect_modules(self):
147        # Ensure that /usr/local is always used
148        if '/usr/local/lib' not in self.compiler.library_dirs:
149            self.compiler.library_dirs.insert(0, '/usr/local/lib')
150        if '/usr/local/include' not in self.compiler.include_dirs:
151            self.compiler.include_dirs.insert(0, '/usr/local/include' )
152
153        # lib_dirs and inc_dirs are used to search for files;
154        # if a file is found in one of those directories, it can
155        # be assumed that no additional -I,-L directives are needed.
156        lib_dirs = self.compiler.library_dirs + ['/lib', '/usr/lib']
157        inc_dirs = self.compiler.include_dirs + ['/usr/include']
158        exts = []
159
160        platform = self.get_platform()
161
162        # Check for MacOS X, which doesn't need libm.a at all
163        math_libs = ['m']
164        if platform in ['Darwin1.2', 'beos']:
165            math_libs = []
166
167        # XXX Omitted modules: gl, pure, dl, SGI-specific modules
168
169        #
170        # The following modules are all pretty straightforward, and compile
171        # on pretty much any POSIXish platform.
172        #
173
174        # Some modules that are normally always on:
175        exts.append( Extension('regex', ['regexmodule.c', 'regexpr.c']) )
176        exts.append( Extension('pcre', ['pcremodule.c', 'pypcre.c']) )
177
178        exts.append( Extension('_weakref', ['_weakref.c']) )
179        exts.append( Extension('_symtable', ['symtablemodule.c']) )
180        exts.append( Extension('xreadlines', ['xreadlinesmodule.c']) )
181
182        # array objects
183        exts.append( Extension('array', ['arraymodule.c']) )
184        # complex math library functions
185        exts.append( Extension('cmath', ['cmathmodule.c'],
186                               libraries=math_libs) )
187
188        # math library functions, e.g. sin()
189        exts.append( Extension('math',  ['mathmodule.c'],
190                               libraries=math_libs) )
191        # fast string operations implemented in C
192        exts.append( Extension('strop', ['stropmodule.c']) )
193        # time operations and variables
194        exts.append( Extension('time', ['timemodule.c'],
195                               libraries=math_libs) )
196        # operator.add() and similar goodies
197        exts.append( Extension('operator', ['operator.c']) )
198        # access to the builtin codecs and codec registry
199        exts.append( Extension('_codecs', ['_codecsmodule.c']) )
200        # Python C API test module
201        exts.append( Extension('_testcapi', ['_testcapimodule.c']) )
202        # static Unicode character database
203        exts.append( Extension('unicodedata', ['unicodedata.c']) )
204        # access to ISO C locale support
205        exts.append( Extension('_locale', ['_localemodule.c']) )
206
207        # Modules with some UNIX dependencies -- on by default:
208        # (If you have a really backward UNIX, select and socket may not be
209        # supported...)
210
211        # fcntl(2) and ioctl(2)
212        exts.append( Extension('fcntl', ['fcntlmodule.c']) )
213        # pwd(3)
214        exts.append( Extension('pwd', ['pwdmodule.c']) )
215        # grp(3)
216        exts.append( Extension('grp', ['grpmodule.c']) )
217        # posix (UNIX) errno values
218        exts.append( Extension('errno', ['errnomodule.c']) )
219        # select(2); not on ancient System V
220        exts.append( Extension('select', ['selectmodule.c']) )
221
222        # The md5 module implements the RSA Data Security, Inc. MD5
223        # Message-Digest Algorithm, described in RFC 1321.  The necessary files
224        # md5c.c and md5.h are included here.
225        exts.append( Extension('md5', ['md5module.c', 'md5c.c']) )
226
227        # The sha module implements the SHA checksum algorithm.
228        # (NIST's Secure Hash Algorithm.)
229        exts.append( Extension('sha', ['shamodule.c']) )
230
231        # Tommy Burnette's 'new' module (creates new empty objects of certain
232        # kinds):
233        exts.append( Extension('new', ['newmodule.c']) )
234
235        # Helper module for various ascii-encoders
236        exts.append( Extension('binascii', ['binascii.c']) )
237
238        # Fred Drake's interface to the Python parser
239        exts.append( Extension('parser', ['parsermodule.c']) )
240
241        # Digital Creations' cStringIO and cPickle
242        exts.append( Extension('cStringIO', ['cStringIO.c']) )
243        exts.append( Extension('cPickle', ['cPickle.c']) )
244
245        # Memory-mapped files (also works on Win32).
246        exts.append( Extension('mmap', ['mmapmodule.c']) )
247
248        # Lance Ellinghaus's modules:
249        # enigma-inspired encryption
250        exts.append( Extension('rotor', ['rotormodule.c']) )
251        # syslog daemon interface
252        exts.append( Extension('syslog', ['syslogmodule.c']) )
253
254        # George Neville-Neil's timing module:
255        exts.append( Extension('timing', ['timingmodule.c']) )
256
257        #
258        # Here ends the simple stuff.  From here on, modules need certain
259        # libraries, are platform-specific, or present other surprises.
260        #
261
262        # Multimedia modules
263        # These don't work for 64-bit platforms!!!
264        # These represent audio samples or images as strings:
265
266        # Disabled on 64-bit platforms
267        if sys.maxint != 9223372036854775807L:
268            # Operations on audio samples
269            exts.append( Extension('audioop', ['audioop.c']) )
270            # Operations on images
271            exts.append( Extension('imageop', ['imageop.c']) )
272            # Read SGI RGB image files (but coded portably)
273            exts.append( Extension('rgbimg', ['rgbimgmodule.c']) )
274
275        # readline
276        if self.compiler.find_library_file(lib_dirs, 'readline'):
277            readline_libs = ['readline']
278            if self.compiler.find_library_file(lib_dirs +
279                                               ['/usr/lib/termcap'],
280                                               'termcap'):
281                readline_libs.append('termcap')
282            exts.append( Extension('readline', ['readline.c'],
283                                   library_dirs=['/usr/lib/termcap'],
284                                   libraries=readline_libs) )
285
286        # The crypt module is now disabled by default because it breaks builds
287        # on many systems (where -lcrypt is needed), e.g. Linux (I believe).
288
289        if self.compiler.find_library_file(lib_dirs, 'crypt'):
290            libs = ['crypt']
291        else:
292            libs = []
293        exts.append( Extension('crypt', ['cryptmodule.c'], libraries=libs) )
294
295        # socket(2)
296        # Detect SSL support for the socket module
297        ssl_incs = find_file('openssl/ssl.h', inc_dirs,
298                             ['/usr/local/ssl/include',
299                              '/usr/contrib/ssl/include/'
300                             ]
301                             )
302        ssl_libs = find_library_file(self.compiler, 'ssl',lib_dirs,
303                                     ['/usr/local/ssl/lib',
304                                      '/usr/contrib/ssl/lib/'
305                                     ] )
306
307        if (ssl_incs is not None and
308            ssl_libs is not None):
309            exts.append( Extension('_socket', ['socketmodule.c'],
310                                   include_dirs = ssl_incs,
311                                   library_dirs = ssl_libs,
312                                   libraries = ['ssl', 'crypto'],
313                                   define_macros = [('USE_SSL',1)] ) )
314        else:
315            exts.append( Extension('_socket', ['socketmodule.c']) )
316
317        # Modules that provide persistent dictionary-like semantics.  You will
318        # probably want to arrange for at least one of them to be available on
319        # your machine, though none are defined by default because of library
320        # dependencies.  The Python module anydbm.py provides an
321        # implementation independent wrapper for these; dumbdbm.py provides
322        # similar functionality (but slower of course) implemented in Python.
323
324        # The standard Unix dbm module:
325        if platform not in ['cygwin']:
326            if (self.compiler.find_library_file(lib_dirs, 'ndbm')):
327                exts.append( Extension('dbm', ['dbmmodule.c'],
328                                       libraries = ['ndbm'] ) )
329            else:
330                exts.append( Extension('dbm', ['dbmmodule.c']) )
331
332        # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
333        if (self.compiler.find_library_file(lib_dirs, 'gdbm')):
334            exts.append( Extension('gdbm', ['gdbmmodule.c'],
335                                   libraries = ['gdbm'] ) )
336
337        # Berkeley DB interface.
338        #
339        # This requires the Berkeley DB code, see
340        # ftp://ftp.cs.berkeley.edu/pub/4bsd/db.1.85.tar.gz
341        #
342        # Edit the variables DB and DBPORT to point to the db top directory
343        # and the subdirectory of PORT where you built it.
344        #
345        # (See http://electricrain.com/greg/python/bsddb3/ for an interface to
346        # BSD DB 3.x.)
347
348        dblib = []
349        if self.compiler.find_library_file(lib_dirs, 'db'):
350            dblib = ['db']
351
352        db185_incs = find_file('db_185.h', inc_dirs,
353                               ['/usr/include/db3', '/usr/include/db2'])
354        db_inc = find_file('db.h', inc_dirs, ['/usr/include/db1'])
355        if db185_incs is not None:
356            exts.append( Extension('bsddb', ['bsddbmodule.c'],
357                                   include_dirs = db185_incs,
358                                   define_macros=[('HAVE_DB_185_H',1)],
359                                   libraries = dblib ) )
360        elif db_inc is not None:
361            exts.append( Extension('bsddb', ['bsddbmodule.c'],
362                                   include_dirs = db_inc,
363                                   libraries = dblib) )
364
365        # The mpz module interfaces to the GNU Multiple Precision library.
366        # You need to ftp the GNU MP library.
367        # This was originally written and tested against GMP 1.2 and 1.3.2.
368        # It has been modified by Rob Hooft to work with 2.0.2 as well, but I
369        # haven't tested it recently.   For a more complete module,
370        # refer to pympz.sourceforge.net.
371
372        # A compatible MP library unencombered by the GPL also exists.  It was
373        # posted to comp.sources.misc in volume 40 and is widely available from
374        # FTP archive sites. One URL for it is:
375        # ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/volume40/fgmp/part01.Z
376
377        if (self.compiler.find_library_file(lib_dirs, 'gmp')):
378            exts.append( Extension('mpz', ['mpzmodule.c'],
379                                   libraries = ['gmp'] ) )
380
381
382        # Unix-only modules
383        if platform not in ['mac', 'win32']:
384            # Steen Lumholt's termios module
385            exts.append( Extension('termios', ['termios.c']) )
386            # Jeremy Hylton's rlimit interface
387            if platform not in ['cygwin']:
388                exts.append( Extension('resource', ['resource.c']) )
389
390            # Generic dynamic loading module
391            #exts.append( Extension('dl', ['dlmodule.c']) )
392
393            # Sun yellow pages. Some systems have the functions in libc.
394            if platform not in ['cygwin']:
395                if (self.compiler.find_library_file(lib_dirs, 'nsl')):
396                    libs = ['nsl']
397                else:
398                    libs = []
399                exts.append( Extension('nis', ['nismodule.c'],
400                                       libraries = libs) )
401
402        # Curses support, requring the System V version of curses, often
403        # provided by the ncurses library.
404        if platform == 'sunos4':
405            inc_dirs += ['/usr/5include']
406            lib_dirs += ['/usr/5lib']
407
408        if (self.compiler.find_library_file(lib_dirs, 'ncurses')):
409            curses_libs = ['ncurses']
410            exts.append( Extension('_curses', ['_cursesmodule.c'],
411                                   libraries = curses_libs) )
412        elif (self.compiler.find_library_file(lib_dirs, 'curses')):
413            if (self.compiler.find_library_file(lib_dirs, 'terminfo')):
414                curses_libs = ['curses', 'terminfo']
415            else:
416                curses_libs = ['curses', 'termcap']
417
418            exts.append( Extension('_curses', ['_cursesmodule.c'],
419                                   libraries = curses_libs) )
420
421        # If the curses module is enabled, check for the panel module
422        if (os.path.exists('Modules/_curses_panel.c') and
423            module_enabled(exts, '_curses') and
424            self.compiler.find_library_file(lib_dirs, 'panel')):
425            exts.append( Extension('_curses_panel', ['_curses_panel.c'],
426                                   libraries = ['panel'] + curses_libs) )
427
428
429
430        # Lee Busby's SIGFPE modules.
431        # The library to link fpectl with is platform specific.
432        # Choose *one* of the options below for fpectl:
433
434        if platform == 'irix5':
435            # For SGI IRIX (tested on 5.3):
436            exts.append( Extension('fpectl', ['fpectlmodule.c'],
437                                   libraries=['fpe']) )
438        elif 0: # XXX how to detect SunPro?
439            # For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
440            # (Without the compiler you don't have -lsunmath.)
441            #fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
442            pass
443        else:
444            # For other systems: see instructions in fpectlmodule.c.
445            #fpectl fpectlmodule.c ...
446            exts.append( Extension('fpectl', ['fpectlmodule.c']) )
447
448
449        # Andrew Kuchling's zlib module.
450        # This require zlib 1.1.3 (or later).
451        # See http://www.cdrom.com/pub/infozip/zlib/
452        if (self.compiler.find_library_file(lib_dirs, 'z')):
453            exts.append( Extension('zlib', ['zlibmodule.c'],
454                                   libraries = ['z']) )
455
456        # Interface to the Expat XML parser
457        #
458        # Expat is written by James Clark and must be downloaded separately
459        # (see below).  The pyexpat module was written by Paul Prescod after a
460        # prototype by Jack Jansen.
461        #
462        # The Expat dist includes Windows .lib and .dll files.  Home page is
463        # at http://www.jclark.com/xml/expat.html, the current production
464        # release is always ftp://ftp.jclark.com/pub/xml/expat.zip.
465        #
466        # EXPAT_DIR, below, should point to the expat/ directory created by
467        # unpacking the Expat source distribution.
468        #
469        # Note: the expat build process doesn't yet build a libexpat.a; you
470        # can do this manually while we try convince the author to add it.  To
471        # do so, cd to EXPAT_DIR, run "make" if you have not done so, then
472        # run:
473        #
474        #    ar cr libexpat.a xmltok/*.o xmlparse/*.o
475        #
476        expat_defs = []
477        expat_incs = find_file('expat.h', inc_dirs, [])
478        if expat_incs is not None:
479            # expat.h was found
480            expat_defs = [('HAVE_EXPAT_H', 1)]
481        else:
482            expat_incs = find_file('xmlparse.h', inc_dirs, [])
483
484        if (expat_incs is not None and
485            self.compiler.find_library_file(lib_dirs, 'expat')):
486            exts.append( Extension('pyexpat', ['pyexpat.c'],
487                                   define_macros = expat_defs,
488                                   libraries = ['expat']) )
489
490        # Platform-specific libraries
491        if platform == 'linux2':
492            # Linux-specific modules
493            exts.append( Extension('linuxaudiodev', ['linuxaudiodev.c']) )
494
495        if platform == 'sunos5':
496            # SunOS specific modules
497            exts.append( Extension('sunaudiodev', ['sunaudiodev.c']) )
498
499        self.extensions.extend(exts)
500
501        # Call the method for detecting whether _tkinter can be compiled
502        self.detect_tkinter(inc_dirs, lib_dirs)
503
504
505    def detect_tkinter(self, inc_dirs, lib_dirs):
506        # The _tkinter module.
507        #
508        # The command for _tkinter is long and site specific.  Please
509        # uncomment and/or edit those parts as indicated.  If you don't have a
510        # specific extension (e.g. Tix or BLT), leave the corresponding line
511        # commented out.  (Leave the trailing backslashes in!  If you
512        # experience strange errors, you may want to join all uncommented
513        # lines and remove the backslashes -- the backslash interpretation is
514        # done by the shell's "read" command and it may not be implemented on
515        # every system.
516
517        # Assume we haven't found any of the libraries or include files
518        tcllib = tklib = tcl_includes = tk_includes = None
519        for version in ['8.4', '8.3', '8.2', '8.1', '8.0']:
520             tklib = self.compiler.find_library_file(lib_dirs,
521                                                     'tk' + version )
522             tcllib = self.compiler.find_library_file(lib_dirs,
523                                                      'tcl' + version )
524             if tklib and tcllib:
525                # Exit the loop when we've found the Tcl/Tk libraries
526                break
527
528        # Now check for the header files
529        if tklib and tcllib:
530            # Check for the include files on Debian, where
531            # they're put in /usr/include/{tcl,tk}X.Y
532            debian_tcl_include = [ '/usr/include/tcl' + version ]
533            debian_tk_include =  [ '/usr/include/tk'  + version ] + debian_tcl_include
534            tcl_includes = find_file('tcl.h', inc_dirs, debian_tcl_include)
535            tk_includes = find_file('tk.h', inc_dirs, debian_tk_include)
536
537        if (tcllib is None or tklib is None and
538            tcl_includes is None or tk_includes is None):
539            # Something's missing, so give up
540            return
541
542        # OK... everything seems to be present for Tcl/Tk.
543
544        include_dirs = [] ; libs = [] ; defs = [] ; added_lib_dirs = []
545        for dir in tcl_includes + tk_includes:
546            if dir not in include_dirs:
547                include_dirs.append(dir)
548
549        # Check for various platform-specific directories
550        platform = self.get_platform()
551        if platform == 'sunos5':
552            include_dirs.append('/usr/openwin/include')
553            added_lib_dirs.append('/usr/openwin/lib')
554        elif os.path.exists('/usr/X11R6/include'):
555            include_dirs.append('/usr/X11R6/include')
556            added_lib_dirs.append('/usr/X11R6/lib')
557        elif os.path.exists('/usr/X11R5/include'):
558            include_dirs.append('/usr/X11R5/include')
559            added_lib_dirs.append('/usr/X11R5/lib')
560        else:
561            # Assume default location for X11
562            include_dirs.append('/usr/X11/include')
563            added_lib_dirs.append('/usr/X11/lib')
564
565        # Check for Tix extension
566        if self.compiler.find_library_file(lib_dirs + added_lib_dirs, 'tix4.1.8.0'):
567            defs.append( ('WITH_TIX', 1) )
568            libs.append('tix4.1.8.0')
569
570        # Check for BLT extension
571        if self.compiler.find_library_file(lib_dirs + added_lib_dirs, 'BLT8.0'):
572            defs.append( ('WITH_BLT', 1) )
573            libs.append('BLT8.0')
574
575        # Add the Tcl/Tk libraries
576        libs.append('tk'+version)
577        libs.append('tcl'+version)
578
579        if platform in ['aix3', 'aix4']:
580            libs.append('ld')
581
582        # Finally, link with the X11 libraries
583        libs.append('X11')
584
585        ext = Extension('_tkinter', ['_tkinter.c', 'tkappinit.c'],
586                        define_macros=[('WITH_APPINIT', 1)] + defs,
587                        include_dirs = include_dirs,
588                        libraries = libs,
589                        library_dirs = added_lib_dirs,
590                        )
591        self.extensions.append(ext)
592
593        # XXX handle these, but how to detect?
594        # *** Uncomment and edit for PIL (TkImaging) extension only:
595        #       -DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
596        # *** Uncomment and edit for TOGL extension only:
597        #       -DWITH_TOGL togl.c \
598        # *** Uncomment these for TOGL extension only:
599        #       -lGL -lGLU -lXext -lXmu \
600
601def main():
602    setup(name = 'Python standard library',
603          version = '%d.%d' % sys.version_info[:2],
604          cmdclass = {'build_ext':PyBuildExt},
605          # The struct module is defined here, because build_ext won't be
606          # called unless there's at least one extension module defined.
607          ext_modules=[Extension('struct', ['structmodule.c'])],
608
609          # Scripts to install
610          scripts = ['Tools/scripts/pydoc']
611        )
612
613# --install-platlib
614if __name__ == '__main__':
615    sysconfig.set_python_build()
616    main()
617