setup.py revision 2c60f7a13697bbc19c4d5ef0b052c34cf1848244
1# Autodetecting setup.py script for building the Python extensions
2#
3
4__version__ = "$Revision$"
5
6import sys, os, getopt, imp, re
7
8from distutils import log
9from distutils import sysconfig
10from distutils import text_file
11from distutils.errors import *
12from distutils.core import Extension, setup
13from distutils.command.build_ext import build_ext
14from distutils.command.install import install
15from distutils.command.install_lib import install_lib
16
17# This global variable is used to hold the list of modules to be disabled.
18disabled_module_list = []
19
20def add_dir_to_list(dirlist, dir):
21    """Add the directory 'dir' to the list 'dirlist' (at the front) if
22    1) 'dir' is not already in 'dirlist'
23    2) 'dir' actually exists, and is a directory."""
24    if dir is not None and os.path.isdir(dir) and dir not in dirlist:
25        dirlist.insert(0, dir)
26
27def find_file(filename, std_dirs, paths):
28    """Searches for the directory where a given file is located,
29    and returns a possibly-empty list of additional directories, or None
30    if the file couldn't be found at all.
31
32    'filename' is the name of a file, such as readline.h or libcrypto.a.
33    'std_dirs' is the list of standard system directories; if the
34        file is found in one of them, no additional directives are needed.
35    'paths' is a list of additional locations to check; if the file is
36        found in one of them, the resulting list will contain the directory.
37    """
38
39    # Check the standard locations
40    for dir in std_dirs:
41        f = os.path.join(dir, filename)
42        if os.path.exists(f): return []
43
44    # Check the additional directories
45    for dir in paths:
46        f = os.path.join(dir, filename)
47        if os.path.exists(f):
48            return [dir]
49
50    # Not found anywhere
51    return None
52
53def find_library_file(compiler, libname, std_dirs, paths):
54    result = compiler.find_library_file(std_dirs + paths, libname)
55    if result is None:
56        return None
57
58    # Check whether the found file is in one of the standard directories
59    dirname = os.path.dirname(result)
60    for p in std_dirs:
61        # Ensure path doesn't end with path separator
62        if p.endswith(os.sep):
63            p = p.strip(os.sep)
64        if p == dirname:
65            return [ ]
66
67    # Otherwise, it must have been in one of the additional directories,
68    # so we have to figure out which one.
69    for p in paths:
70        # Ensure path doesn't end with path separator
71        if p.endswith(os.sep):
72            p = p.strip(os.sep)
73        if p == dirname:
74            return [p]
75    else:
76        assert False, "Internal error: Path not found in std_dirs or paths"
77
78def module_enabled(extlist, modname):
79    """Returns whether the module 'modname' is present in the list
80    of extensions 'extlist'."""
81    extlist = [ext for ext in extlist if ext.name == modname]
82    return len(extlist)
83
84def find_module_file(module, dirlist):
85    """Find a module in a set of possible folders. If it is not found
86    return the unadorned filename"""
87    list = find_file(module, [], dirlist)
88    if not list:
89        return module
90    if len(list) > 1:
91        self.announce("WARNING: multiple copies of %s found"%module)
92    return os.path.join(list[0], module)
93
94class PyBuildExt(build_ext):
95
96    def build_extensions(self):
97
98        # Detect which modules should be compiled
99        self.detect_modules()
100
101        # Remove modules that are present on the disabled list
102        self.extensions = [ext for ext in self.extensions
103                           if ext.name not in disabled_module_list]
104
105        # Fix up the autodetected modules, prefixing all the source files
106        # with Modules/ and adding Python's include directory to the path.
107        (srcdir,) = sysconfig.get_config_vars('srcdir')
108        if not srcdir:
109            # Maybe running on Windows but not using CYGWIN?
110            raise ValueError("No source directory; cannot proceed.")
111
112        # Figure out the location of the source code for extension modules
113        moddir = os.path.join(os.getcwd(), srcdir, 'Modules')
114        moddir = os.path.normpath(moddir)
115        srcdir, tail = os.path.split(moddir)
116        srcdir = os.path.normpath(srcdir)
117        moddir = os.path.normpath(moddir)
118
119        moddirlist = [moddir]
120        incdirlist = ['./Include']
121
122        # Platform-dependent module source and include directories
123        platform = self.get_platform()
124        if platform in ('darwin', 'mac'):
125            # Mac OS X also includes some mac-specific modules
126            macmoddir = os.path.join(os.getcwd(), srcdir, 'Mac/Modules')
127            moddirlist.append(macmoddir)
128            incdirlist.append('./Mac/Include')
129
130        alldirlist = moddirlist + incdirlist
131
132        # Fix up the paths for scripts, too
133        self.distribution.scripts = [os.path.join(srcdir, filename)
134                                     for filename in self.distribution.scripts]
135
136        for ext in self.extensions[:]:
137            ext.sources = [ find_module_file(filename, moddirlist)
138                            for filename in ext.sources ]
139            if ext.depends is not None:
140                ext.depends = [find_module_file(filename, alldirlist)
141                               for filename in ext.depends]
142            ext.include_dirs.append( '.' ) # to get config.h
143            for incdir in incdirlist:
144                ext.include_dirs.append( os.path.join(srcdir, incdir) )
145
146            # If a module has already been built statically,
147            # don't build it here
148            if ext.name in sys.builtin_module_names:
149                self.extensions.remove(ext)
150
151        if platform != 'mac':
152            # Parse Modules/Setup to figure out which modules are turned
153            # on in the file.
154            input = text_file.TextFile('Modules/Setup', join_lines=1)
155            remove_modules = []
156            while 1:
157                line = input.readline()
158                if not line: break
159                line = line.split()
160                remove_modules.append( line[0] )
161            input.close()
162
163            for ext in self.extensions[:]:
164                if ext.name in remove_modules:
165                    self.extensions.remove(ext)
166
167        # When you run "make CC=altcc" or something similar, you really want
168        # those environment variables passed into the setup.py phase.  Here's
169        # a small set of useful ones.
170        compiler = os.environ.get('CC')
171        linker_so = os.environ.get('LDSHARED')
172        args = {}
173        # unfortunately, distutils doesn't let us provide separate C and C++
174        # compilers
175        if compiler is not None:
176            (ccshared,opt,base) = sysconfig.get_config_vars('CCSHARED','OPT','BASECFLAGS')
177            args['compiler_so'] = compiler + ' ' + opt + ' ' + ccshared + ' ' + base
178        if linker_so is not None:
179            args['linker_so'] = linker_so
180        self.compiler.set_executables(**args)
181
182        build_ext.build_extensions(self)
183
184    def build_extension(self, ext):
185
186        try:
187            build_ext.build_extension(self, ext)
188        except (CCompilerError, DistutilsError), why:
189            self.announce('WARNING: building of extension "%s" failed: %s' %
190                          (ext.name, sys.exc_info()[1]))
191            return
192        # Workaround for Mac OS X: The Carbon-based modules cannot be
193        # reliably imported into a command-line Python
194        if 'Carbon' in ext.extra_link_args:
195            self.announce(
196                'WARNING: skipping import check for Carbon-based "%s"' %
197                ext.name)
198            return
199        # Workaround for Cygwin: Cygwin currently has fork issues when many
200        # modules have been imported
201        if self.get_platform() == 'cygwin':
202            self.announce('WARNING: skipping import check for Cygwin-based "%s"'
203                % ext.name)
204            return
205        ext_filename = os.path.join(
206            self.build_lib,
207            self.get_ext_filename(self.get_ext_fullname(ext.name)))
208        try:
209            imp.load_dynamic(ext.name, ext_filename)
210        except ImportError, why:
211
212            if 1:
213                self.announce('*** WARNING: renaming "%s" since importing it'
214                              ' failed: %s' % (ext.name, why))
215                assert not self.inplace
216                basename, tail = os.path.splitext(ext_filename)
217                newname = basename + "_failed" + tail
218                if os.path.exists(newname): os.remove(newname)
219                os.rename(ext_filename, newname)
220
221                # XXX -- This relies on a Vile HACK in
222                # distutils.command.build_ext.build_extension().  The
223                # _built_objects attribute is stored there strictly for
224                # use here.
225                # If there is a failure, _built_objects may not be there,
226                # so catch the AttributeError and move on.
227                try:
228                    for filename in self._built_objects:
229                        os.remove(filename)
230                except AttributeError:
231                    self.announce('unable to remove files (ignored)')
232            else:
233                self.announce('*** WARNING: importing extension "%s" '
234                              'failed: %s' % (ext.name, why))
235
236    def get_platform (self):
237        # Get value of sys.platform
238        platform = sys.platform
239        if platform[:6] =='cygwin':
240            platform = 'cygwin'
241        elif platform[:4] =='beos':
242            platform = 'beos'
243        elif platform[:6] == 'darwin':
244            platform = 'darwin'
245        elif platform[:6] == 'atheos':
246            platform = 'atheos'
247
248        return platform
249
250    def detect_modules(self):
251        # Ensure that /usr/local is always used
252        add_dir_to_list(self.compiler.library_dirs, '/usr/local/lib')
253        add_dir_to_list(self.compiler.include_dirs, '/usr/local/include')
254
255        # fink installs lots of goodies in /sw/... - make sure we
256        # check there
257        if sys.platform == "darwin":
258            add_dir_to_list(self.compiler.library_dirs, '/sw/lib')
259            add_dir_to_list(self.compiler.include_dirs, '/sw/include')
260
261        if os.path.normpath(sys.prefix) != '/usr':
262            add_dir_to_list(self.compiler.library_dirs,
263                            sysconfig.get_config_var("LIBDIR"))
264            add_dir_to_list(self.compiler.include_dirs,
265                            sysconfig.get_config_var("INCLUDEDIR"))
266
267        try:
268            have_unicode = unicode
269        except NameError:
270            have_unicode = 0
271
272        # lib_dirs and inc_dirs are used to search for files;
273        # if a file is found in one of those directories, it can
274        # be assumed that no additional -I,-L directives are needed.
275        lib_dirs = self.compiler.library_dirs + ['/lib', '/usr/lib']
276        inc_dirs = self.compiler.include_dirs + ['/usr/include']
277        exts = []
278
279        platform = self.get_platform()
280        (srcdir,) = sysconfig.get_config_vars('srcdir')
281
282        # Check for AtheOS which has libraries in non-standard locations
283        if platform == 'atheos':
284            lib_dirs += ['/system/libs', '/atheos/autolnk/lib']
285            lib_dirs += os.getenv('LIBRARY_PATH', '').split(os.pathsep)
286            inc_dirs += ['/system/include', '/atheos/autolnk/include']
287            inc_dirs += os.getenv('C_INCLUDE_PATH', '').split(os.pathsep)
288
289        # Check for MacOS X, which doesn't need libm.a at all
290        math_libs = ['m']
291        if platform in ['darwin', 'beos', 'mac']:
292            math_libs = []
293
294        # XXX Omitted modules: gl, pure, dl, SGI-specific modules
295
296        #
297        # The following modules are all pretty straightforward, and compile
298        # on pretty much any POSIXish platform.
299        #
300
301        # Some modules that are normally always on:
302        exts.append( Extension('regex', ['regexmodule.c', 'regexpr.c']) )
303        exts.append( Extension('pcre', ['pcremodule.c', 'pypcre.c']) )
304
305        exts.append( Extension('_hotshot', ['_hotshot.c']) )
306        exts.append( Extension('_weakref', ['_weakref.c']) )
307        exts.append( Extension('xreadlines', ['xreadlinesmodule.c']) )
308
309        # array objects
310        exts.append( Extension('array', ['arraymodule.c']) )
311        # complex math library functions
312        exts.append( Extension('cmath', ['cmathmodule.c'],
313                               libraries=math_libs) )
314
315        # math library functions, e.g. sin()
316        exts.append( Extension('math',  ['mathmodule.c'],
317                               libraries=math_libs) )
318        # fast string operations implemented in C
319        exts.append( Extension('strop', ['stropmodule.c']) )
320        # time operations and variables
321        exts.append( Extension('time', ['timemodule.c'],
322                               libraries=math_libs) )
323        exts.append( Extension('datetime', ['datetimemodule.c'],
324                               libraries=math_libs) )
325        # random number generator implemented in C
326        exts.append( Extension("_random", ["_randommodule.c"]) )
327        # operator.add() and similar goodies
328        exts.append( Extension('operator', ['operator.c']) )
329        # Python C API test module
330        exts.append( Extension('_testcapi', ['_testcapimodule.c']) )
331        # static Unicode character database
332        if have_unicode:
333            exts.append( Extension('unicodedata', ['unicodedata.c']) )
334        # access to ISO C locale support
335        if platform in ['cygwin']:
336            locale_libs = ['intl']
337        else:
338            locale_libs = []
339        exts.append( Extension('_locale', ['_localemodule.c'],
340                               libraries=locale_libs ) )
341
342        # Modules with some UNIX dependencies -- on by default:
343        # (If you have a really backward UNIX, select and socket may not be
344        # supported...)
345
346        # fcntl(2) and ioctl(2)
347        exts.append( Extension('fcntl', ['fcntlmodule.c']) )
348        if platform not in ['mac']:
349                # pwd(3)
350            exts.append( Extension('pwd', ['pwdmodule.c']) )
351            # grp(3)
352            exts.append( Extension('grp', ['grpmodule.c']) )
353        # select(2); not on ancient System V
354        exts.append( Extension('select', ['selectmodule.c']) )
355
356        # The md5 module implements the RSA Data Security, Inc. MD5
357        # Message-Digest Algorithm, described in RFC 1321.  The
358        # necessary files md5c.c and md5.h are included here.
359        exts.append( Extension('md5', ['md5module.c', 'md5c.c']) )
360
361        # The sha module implements the SHA checksum algorithm.
362        # (NIST's Secure Hash Algorithm.)
363        exts.append( Extension('sha', ['shamodule.c']) )
364
365        # Helper module for various ascii-encoders
366        exts.append( Extension('binascii', ['binascii.c']) )
367
368        # Fred Drake's interface to the Python parser
369        exts.append( Extension('parser', ['parsermodule.c']) )
370
371        # cStringIO and cPickle
372        exts.append( Extension('cStringIO', ['cStringIO.c']) )
373        exts.append( Extension('cPickle', ['cPickle.c']) )
374
375        # Memory-mapped files (also works on Win32).
376        if platform not in ['atheos', 'mac']:
377            exts.append( Extension('mmap', ['mmapmodule.c']) )
378
379        # Lance Ellinghaus's modules:
380        # enigma-inspired encryption
381        exts.append( Extension('rotor', ['rotormodule.c']) )
382        if platform not in ['mac']:
383            # syslog daemon interface
384            exts.append( Extension('syslog', ['syslogmodule.c']) )
385
386        # George Neville-Neil's timing module:
387        exts.append( Extension('timing', ['timingmodule.c']) )
388
389        #
390        # Here ends the simple stuff.  From here on, modules need certain
391        # libraries, are platform-specific, or present other surprises.
392        #
393
394        # Multimedia modules
395        # These don't work for 64-bit platforms!!!
396        # These represent audio samples or images as strings:
397
398        # Disabled on 64-bit platforms
399        if sys.maxint != 9223372036854775807L:
400            # Operations on audio samples
401            exts.append( Extension('audioop', ['audioop.c']) )
402            # Operations on images
403            exts.append( Extension('imageop', ['imageop.c']) )
404            # Read SGI RGB image files (but coded portably)
405            exts.append( Extension('rgbimg', ['rgbimgmodule.c']) )
406
407        # readline
408        if self.compiler.find_library_file(lib_dirs, 'readline'):
409            readline_libs = ['readline']
410            if self.compiler.find_library_file(lib_dirs,
411                                                 'ncurses'):
412                readline_libs.append('ncurses')
413            elif self.compiler.find_library_file(lib_dirs +
414                                               ['/usr/lib/termcap'],
415                                               'termcap'):
416                readline_libs.append('termcap')
417            exts.append( Extension('readline', ['readline.c'],
418                                   library_dirs=['/usr/lib/termcap'],
419                                   libraries=readline_libs) )
420        if platform not in ['mac']:
421                # crypt module.
422
423            if self.compiler.find_library_file(lib_dirs, 'crypt'):
424                libs = ['crypt']
425            else:
426                libs = []
427            exts.append( Extension('crypt', ['cryptmodule.c'], libraries=libs) )
428
429        # socket(2)
430        exts.append( Extension('_socket', ['socketmodule.c'],
431                               depends = ['socketmodule.h']) )
432        # Detect SSL support for the socket module (via _ssl)
433        ssl_incs = find_file('openssl/ssl.h', inc_dirs,
434                             ['/usr/local/ssl/include',
435                              '/usr/contrib/ssl/include/'
436                             ]
437                             )
438        ssl_libs = find_library_file(self.compiler, 'ssl',lib_dirs,
439                                     ['/usr/local/ssl/lib',
440                                      '/usr/contrib/ssl/lib/'
441                                     ] )
442
443        if (ssl_incs is not None and
444            ssl_libs is not None):
445            exts.append( Extension('_ssl', ['_ssl.c'],
446                                   include_dirs = ssl_incs,
447                                   library_dirs = ssl_libs,
448                                   libraries = ['ssl', 'crypto'],
449                                   depends = ['socketmodule.h']), )
450
451        # Modules that provide persistent dictionary-like semantics.  You will
452        # probably want to arrange for at least one of them to be available on
453        # your machine, though none are defined by default because of library
454        # dependencies.  The Python module anydbm.py provides an
455        # implementation independent wrapper for these; dumbdbm.py provides
456        # similar functionality (but slower of course) implemented in Python.
457
458        # Sleepycat Berkeley DB interface.  http://www.sleepycat.com
459        #
460        # This requires the Sleepycat DB code. The earliest supported version
461        # of that library is 3.0, the latest supported version is 4.1.  A list
462        # of available releases can be found at
463        #
464        # http://www.sleepycat.com/update/index.html
465
466        # when sorted in reverse order, keys for this dict must appear in the
467        # order you wish to search - e.g., search for db4 before db3
468        db_try_this = {
469            'db4': {'libs': ('db-4.1', 'db-4.0',),
470                    'libdirs': ('/usr/local/BerkeleyDB.4.1/lib',
471                                '/usr/local/BerkeleyDB.4.0/lib',
472                                '/usr/local/lib',
473                                '/opt/sfw',
474                                '/sw/lib',
475                                ),
476                    'incdirs': ('/usr/local/BerkeleyDB.4.1/include',
477                                '/usr/local/BerkeleyDB.4.0/include',
478                                '/usr/local/include/db4',
479                                '/opt/sfw/include/db4',
480                                '/sw/include/db4',
481                                '/usr/include/db4',
482                                )},
483            'db3': {'libs': ('db-3.3', 'db-3.2', 'db-3.1'),
484                    'libdirs': ('/usr/local/BerkeleyDB.3.3/lib',
485                                '/usr/local/BerkeleyDB.3.2/lib',
486                                '/usr/local/BerkeleyDB.3.1/lib',
487                                '/usr/local/lib',
488                                '/opt/sfw/lib',
489                                '/sw/lib',
490                                ),
491                    'incdirs': ('/usr/local/BerkeleyDB.3.3/include',
492                                '/usr/local/BerkeleyDB.3.2/include',
493                                '/usr/local/BerkeleyDB.3.1/include',
494                                '/usr/local/include/db3',
495                                '/opt/sfw/include/db3',
496                                '/sw/include/db3',
497                                '/usr/include/db3',
498                                )},
499            }
500
501        db_search_order = db_try_this.keys()
502        db_search_order.sort()
503        db_search_order.reverse()
504
505        class found(Exception): pass
506        try:
507            # See whether there is a Sleepycat header in the standard
508            # search path.
509            std_dbinc = None
510            for d in inc_dirs:
511                f = os.path.join(d, "db.h")
512                if os.path.exists(f):
513                    f = open(f).read()
514                    m = re.search(r"#define\WDB_VERSION_MAJOR\W([1-9]+)", f)
515                    if m:
516                        std_dbinc = 'db' + m.group(1)
517            for dbkey in db_search_order:
518                dbd = db_try_this[dbkey]
519                for dblib in dbd['libs']:
520                    # Prefer version-specific includes over standard
521                    # include locations.
522                    db_incs = find_file('db.h', [], dbd['incdirs'])
523                    dblib_dir = find_library_file(self.compiler,
524                                                  dblib,
525                                                  lib_dirs,
526                                                  list(dbd['libdirs']))
527                    if (db_incs or dbkey == std_dbinc) and \
528                           dblib_dir is not None:
529                        dblibs = [dblib]
530                        raise found
531        except found:
532            dblibs = [dblib]
533            # A default source build puts Berkeley DB in something like
534            # /usr/local/Berkeley.3.3 and the lib dir under that isn't
535            # normally on ld.so's search path, unless the sysadmin has hacked
536            # /etc/ld.so.conf.  We add the directory to runtime_library_dirs
537            # so the proper -R/--rpath flags get passed to the linker.  This
538            # is usually correct and most trouble free, but may cause problems
539            # in some unusual system configurations (e.g. the directory is on
540            # an NFS server that goes away).
541            exts.append(Extension('_bsddb', ['_bsddb.c'],
542                                  library_dirs=dblib_dir,
543                                  runtime_library_dirs=dblib_dir,
544                                  include_dirs=db_incs,
545                                  libraries=dblibs))
546        else:
547            db_incs = None
548            dblibs = []
549            dblib_dir = None
550
551        # The standard Unix dbm module:
552        if platform not in ['cygwin']:
553            if find_file("ndbm.h", inc_dirs, []) is not None:
554                # Some systems have -lndbm, others don't
555                if self.compiler.find_library_file(lib_dirs, 'ndbm'):
556                    ndbm_libs = ['ndbm']
557                else:
558                    ndbm_libs = []
559                exts.append( Extension('dbm', ['dbmmodule.c'],
560                                       define_macros=[('HAVE_NDBM_H',None)],
561                                       libraries = ndbm_libs ) )
562            elif (self.compiler.find_library_file(lib_dirs, 'gdbm')
563                  and find_file("gdbm/ndbm.h", inc_dirs, []) is not None):
564                exts.append( Extension('dbm', ['dbmmodule.c'],
565                                       define_macros=[('HAVE_GDBM_NDBM_H',None)],
566                                       libraries = ['gdbm'] ) )
567            elif db_incs is not None:
568                exts.append( Extension('dbm', ['dbmmodule.c'],
569                                       library_dirs=dblib_dir,
570                                       runtime_library_dirs=dblib_dir,
571                                       include_dirs=db_incs,
572                                       define_macros=[('HAVE_BERKDB_H',None),
573                                                      ('DB_DBM_HSEARCH',None)],
574                                       libraries=dblibs))
575
576        # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
577        if (self.compiler.find_library_file(lib_dirs, 'gdbm')):
578            exts.append( Extension('gdbm', ['gdbmmodule.c'],
579                                   libraries = ['gdbm'] ) )
580
581        # The mpz module interfaces to the GNU Multiple Precision library.
582        # You need to ftp the GNU MP library.
583        # This was originally written and tested against GMP 1.2 and 1.3.2.
584        # It has been modified by Rob Hooft to work with 2.0.2 as well, but I
585        # haven't tested it recently, and it definitely doesn't work with
586        # GMP 4.0.  For more complete modules, refer to
587        # http://gmpy.sourceforge.net and
588        # http://www.egenix.com/files/python/mxNumber.html
589
590        # A compatible MP library unencumbered by the GPL also exists.  It was
591        # posted to comp.sources.misc in volume 40 and is widely available from
592        # FTP archive sites. One URL for it is:
593        # ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/volume40/fgmp/part01.Z
594
595        if (self.compiler.find_library_file(lib_dirs, 'gmp')):
596            exts.append( Extension('mpz', ['mpzmodule.c'],
597                                   libraries = ['gmp'] ) )
598
599
600        # Unix-only modules
601        if platform not in ['mac', 'win32']:
602            # Steen Lumholt's termios module
603            exts.append( Extension('termios', ['termios.c']) )
604            # Jeremy Hylton's rlimit interface
605            if platform not in ['atheos']:
606                exts.append( Extension('resource', ['resource.c']) )
607
608            # Sun yellow pages. Some systems have the functions in libc.
609            if platform not in ['cygwin', 'atheos']:
610                if (self.compiler.find_library_file(lib_dirs, 'nsl')):
611                    libs = ['nsl']
612                else:
613                    libs = []
614                exts.append( Extension('nis', ['nismodule.c'],
615                                       libraries = libs) )
616
617            # Hye-Shik Chang's iconv_codec C interface
618            iconv_incs = find_file('iconv.h', inc_dirs,
619                                   ['/usr/local/include', '/usr/pkg/include'])
620            iconv_libs = find_library_file(self.compiler, 'iconv', lib_dirs,
621                                           ['/usr/local/lib', '/usr/pkg/lib'])
622
623            if (iconv_incs is not None):
624                if iconv_libs is not None:
625                    iconv_libraries = ['iconv']
626                else:
627                    iconv_libraries = [] # in libc
628
629                exts.append( Extension('_iconv_codec',
630                                       ['_iconv_codec.c'],
631                                       include_dirs = iconv_incs,
632                                       library_dirs = iconv_libs,
633                                       libraries = iconv_libraries), )
634
635        # Curses support, requring the System V version of curses, often
636        # provided by the ncurses library.
637        if platform == 'sunos4':
638            inc_dirs += ['/usr/5include']
639            lib_dirs += ['/usr/5lib']
640
641        if (self.compiler.find_library_file(lib_dirs, 'ncurses')):
642            curses_libs = ['ncurses']
643            exts.append( Extension('_curses', ['_cursesmodule.c'],
644                                   libraries = curses_libs) )
645        elif (self.compiler.find_library_file(lib_dirs, 'curses')
646              and platform != 'darwin'):
647                # OSX has an old Berkeley curses, not good enough for
648                # the _curses module.
649            if (self.compiler.find_library_file(lib_dirs, 'terminfo')):
650                curses_libs = ['curses', 'terminfo']
651            else:
652                curses_libs = ['curses', 'termcap']
653
654            exts.append( Extension('_curses', ['_cursesmodule.c'],
655                                   libraries = curses_libs) )
656
657        # If the curses module is enabled, check for the panel module
658        if (module_enabled(exts, '_curses') and
659            self.compiler.find_library_file(lib_dirs, 'panel')):
660            exts.append( Extension('_curses_panel', ['_curses_panel.c'],
661                                   libraries = ['panel'] + curses_libs) )
662
663
664        # Andrew Kuchling's zlib module.  Note that some versions of zlib
665        # 1.1.3 have security problems.  See CERT Advisory CA-2002-07:
666        # http://www.cert.org/advisories/CA-2002-07.html
667        #
668        # zlib 1.1.4 is fixed, but at least one vendor (RedHat) has decided to
669        # patch its zlib 1.1.3 package instead of upgrading to 1.1.4.  For
670        # now, we still accept 1.1.3, because we think it's difficult to
671        # exploit this in Python, and we'd rather make it RedHat's problem
672        # than our problem <wink>.
673        #
674        # You can upgrade zlib to version 1.1.4 yourself by going to
675        # http://www.gzip.org/zlib/
676        zlib_inc = find_file('zlib.h', [], inc_dirs)
677        if zlib_inc is not None:
678            zlib_h = zlib_inc[0] + '/zlib.h'
679            version = '"0.0.0"'
680            version_req = '"1.1.3"'
681            fp = open(zlib_h)
682            while 1:
683                line = fp.readline()
684                if not line:
685                    break
686                if line.startswith('#define ZLIB_VERSION'):
687                    version = line.split()[2]
688                    break
689            if version >= version_req:
690                if (self.compiler.find_library_file(lib_dirs, 'z')):
691                    exts.append( Extension('zlib', ['zlibmodule.c'],
692                                           libraries = ['z']) )
693
694        # Gustavo Niemeyer's bz2 module.
695        if (self.compiler.find_library_file(lib_dirs, 'bz2')):
696            exts.append( Extension('bz2', ['bz2module.c'],
697                                   libraries = ['bz2']) )
698
699        # Interface to the Expat XML parser
700        #
701        # Expat was written by James Clark and is now maintained by a
702        # group of developers on SourceForge; see www.libexpat.org for
703        # more information.  The pyexpat module was written by Paul
704        # Prescod after a prototype by Jack Jansen.  Source of Expat
705        # 1.95.2 is included in Modules/expat/.  Usage of a system
706        # shared libexpat.so/expat.dll is not advised.
707        #
708        # More information on Expat can be found at www.libexpat.org.
709        #
710        if sys.byteorder == "little":
711            xmlbo = "1234"
712        else:
713            xmlbo = "4321"
714        expatinc = os.path.join(os.getcwd(), srcdir, 'Modules', 'expat')
715        exts.append(Extension('pyexpat',
716                              sources = [
717            'pyexpat.c',
718            'expat/xmlparse.c',
719            'expat/xmlrole.c',
720            'expat/xmltok.c',
721            ],
722                              define_macros = [
723            ('XML_NS', '1'),
724            ('XML_DTD', '1'),
725            ('BYTEORDER', xmlbo),
726            ('XML_CONTEXT_BYTES','1024'),
727            ],
728                              include_dirs = [expatinc]
729                               ))
730
731        # Dynamic loading module
732        if sys.maxint == 0x7fffffff:
733            # This requires sizeof(int) == sizeof(long) == sizeof(char*)
734            dl_inc = find_file('dlfcn.h', [], inc_dirs)
735            if (dl_inc is not None) and (platform not in ['atheos']):
736                exts.append( Extension('dl', ['dlmodule.c']) )
737
738        # Platform-specific libraries
739        if platform == 'linux2':
740            # Linux-specific modules
741            exts.append( Extension('linuxaudiodev', ['linuxaudiodev.c']) )
742
743            # ossaudiodev currently doesn't work, so don't build.
744##             # XXX should also build this on FreeBSD!
745##             exts.append( Extension('ossaudiodev', ['ossaudiodev.c']) )
746
747        if platform == 'sunos5':
748            # SunOS specific modules
749            exts.append( Extension('sunaudiodev', ['sunaudiodev.c']) )
750
751        if platform == 'darwin':
752            # Mac OS X specific modules.
753            exts.append( Extension('_CF', ['cf/_CFmodule.c', 'cf/pycfbridge.c'],
754                        extra_link_args=['-framework', 'CoreFoundation']) )
755
756            exts.append( Extension('gestalt', ['gestaltmodule.c'],
757                        extra_link_args=['-framework', 'Carbon']) )
758            exts.append( Extension('MacOS', ['macosmodule.c'],
759                        extra_link_args=['-framework', 'Carbon']) )
760            exts.append( Extension('icglue', ['icgluemodule.c'],
761                        extra_link_args=['-framework', 'Carbon']) )
762            exts.append( Extension('_Res', ['res/_Resmodule.c'],
763                        extra_link_args=['-framework', 'Carbon']) )
764            exts.append( Extension('_Snd', ['snd/_Sndmodule.c'],
765                        extra_link_args=['-framework', 'Carbon']) )
766            exts.append( Extension('Nav', ['Nav.c'],
767                    extra_link_args=['-framework', 'Carbon']) )
768            exts.append( Extension('_AE', ['ae/_AEmodule.c'],
769                    extra_link_args=['-framework', 'Carbon']) )
770            exts.append( Extension('_AH', ['ah/_AHmodule.c'],
771                    extra_link_args=['-framework', 'Carbon']) )
772            exts.append( Extension('_App', ['app/_Appmodule.c'],
773                    extra_link_args=['-framework', 'Carbon']) )
774            exts.append( Extension('_CarbonEvt', ['carbonevt/_CarbonEvtmodule.c'],
775                    extra_link_args=['-framework', 'Carbon']) )
776            exts.append( Extension('_CG', ['cg/_CGmodule.c'],
777                    extra_link_args=['-framework', 'ApplicationServices',
778                                     '-framework', 'Carbon']) )
779            exts.append( Extension('_Cm', ['cm/_Cmmodule.c'],
780                    extra_link_args=['-framework', 'Carbon']) )
781            exts.append( Extension('_Ctl', ['ctl/_Ctlmodule.c'],
782                    extra_link_args=['-framework', 'Carbon']) )
783            exts.append( Extension('_Dlg', ['dlg/_Dlgmodule.c'],
784                    extra_link_args=['-framework', 'Carbon']) )
785            exts.append( Extension('_Drag', ['drag/_Dragmodule.c'],
786                    extra_link_args=['-framework', 'Carbon']) )
787            exts.append( Extension('_Evt', ['evt/_Evtmodule.c'],
788                    extra_link_args=['-framework', 'Carbon']) )
789            exts.append( Extension('_File', ['file/_Filemodule.c'],
790                    extra_link_args=['-framework', 'Carbon']) )
791            exts.append( Extension('_Folder', ['folder/_Foldermodule.c'],
792                    extra_link_args=['-framework', 'Carbon']) )
793            exts.append( Extension('_Fm', ['fm/_Fmmodule.c'],
794                    extra_link_args=['-framework', 'Carbon']) )
795            exts.append( Extension('_Help', ['help/_Helpmodule.c'],
796                    extra_link_args=['-framework', 'Carbon']) )
797            exts.append( Extension('_Icn', ['icn/_Icnmodule.c'],
798                    extra_link_args=['-framework', 'Carbon']) )
799            exts.append( Extension('_IBCarbon', ['ibcarbon/_IBCarbon.c'],
800                    extra_link_args=['-framework', 'Carbon']) )
801            exts.append( Extension('_List', ['list/_Listmodule.c'],
802                    extra_link_args=['-framework', 'Carbon']) )
803            exts.append( Extension('_Menu', ['menu/_Menumodule.c'],
804                    extra_link_args=['-framework', 'Carbon']) )
805            exts.append( Extension('_Mlte', ['mlte/_Mltemodule.c'],
806                    extra_link_args=['-framework', 'Carbon']) )
807            exts.append( Extension('_Qd', ['qd/_Qdmodule.c'],
808                    extra_link_args=['-framework', 'Carbon']) )
809            exts.append( Extension('_Qdoffs', ['qdoffs/_Qdoffsmodule.c'],
810                    extra_link_args=['-framework', 'Carbon']) )
811            exts.append( Extension('_Qt', ['qt/_Qtmodule.c'],
812                    extra_link_args=['-framework', 'QuickTime',
813                                     '-framework', 'Carbon']) )
814            exts.append( Extension('_Scrap', ['scrap/_Scrapmodule.c'],
815                    extra_link_args=['-framework', 'Carbon']) )
816            exts.append( Extension('_TE', ['te/_TEmodule.c'],
817                    extra_link_args=['-framework', 'Carbon']) )
818            # As there is no standardized place (yet) to put
819            # user-installed Mac libraries on OSX, we search for "waste"
820            # in parent directories of the Python source tree. You
821            # should put a symlink to your Waste installation in the
822            # same folder as your python source tree.  Or modify the
823            # next few lines:-)
824            waste_incs = find_file("WASTE.h", [],
825                    ['../'*n + 'waste/C_C++ Headers' for n in (0,1,2,3,4)])
826            waste_libs = find_library_file(self.compiler, "WASTE", [],
827                    ["../"*n + "waste/Static Libraries" for n in (0,1,2,3,4)])
828            if waste_incs != None and waste_libs != None:
829                (srcdir,) = sysconfig.get_config_vars('srcdir')
830                exts.append( Extension('waste',
831                               ['waste/wastemodule.c'] + [
832                                os.path.join(srcdir, d) for d in
833                                'Mac/Wastemods/WEObjectHandlers.c',
834                                'Mac/Wastemods/WETabHooks.c',
835                                'Mac/Wastemods/WETabs.c'
836                               ],
837                               include_dirs = waste_incs + [os.path.join(srcdir, 'Mac/Wastemods')],
838                               library_dirs = waste_libs,
839                               libraries = ['WASTE'],
840                               extra_link_args = ['-framework', 'Carbon'],
841                ) )
842            exts.append( Extension('_Win', ['win/_Winmodule.c'],
843                    extra_link_args=['-framework', 'Carbon']) )
844
845        self.extensions.extend(exts)
846
847        # Call the method for detecting whether _tkinter can be compiled
848        self.detect_tkinter(inc_dirs, lib_dirs)
849
850    def detect_tkinter_darwin(self, inc_dirs, lib_dirs):
851        # The _tkinter module, using frameworks. Since frameworks are quite
852        # different the UNIX search logic is not sharable.
853        from os.path import join, exists
854        framework_dirs = [
855            '/System/Library/Frameworks/',
856            '/Library/Frameworks',
857            join(os.getenv('HOME'), '/Library/Frameworks')
858        ]
859
860        # Find the directory that contains the Tcl.framwork and Tk.framework
861        # bundles.
862        # XXX distutils should support -F!
863        for F in framework_dirs:
864            # both Tcl.framework and Tk.framework should be present
865            for fw in 'Tcl', 'Tk':
866                if not exists(join(F, fw + '.framework')):
867                    break
868            else:
869                # ok, F is now directory with both frameworks. Continure
870                # building
871                break
872        else:
873            # Tk and Tcl frameworks not found. Normal "unix" tkinter search
874            # will now resume.
875            return 0
876
877        # For 8.4a2, we must add -I options that point inside the Tcl and Tk
878        # frameworks. In later release we should hopefully be able to pass
879        # the -F option to gcc, which specifies a framework lookup path.
880        #
881        include_dirs = [
882            join(F, fw + '.framework', H)
883            for fw in 'Tcl', 'Tk'
884            for H in 'Headers', 'Versions/Current/PrivateHeaders'
885        ]
886
887        # For 8.4a2, the X11 headers are not included. Rather than include a
888        # complicated search, this is a hard-coded path. It could bail out
889        # if X11 libs are not found...
890        include_dirs.append('/usr/X11R6/include')
891        frameworks = ['-framework', 'Tcl', '-framework', 'Tk']
892
893        ext = Extension('_tkinter', ['_tkinter.c', 'tkappinit.c'],
894                        define_macros=[('WITH_APPINIT', 1)],
895                        include_dirs = include_dirs,
896                        libraries = [],
897                        extra_compile_args = frameworks,
898                        extra_link_args = frameworks,
899                        )
900        self.extensions.append(ext)
901        return 1
902
903
904    def detect_tkinter(self, inc_dirs, lib_dirs):
905        # The _tkinter module.
906
907        # Rather than complicate the code below, detecting and building
908        # AquaTk is a separate method. Only one Tkinter will be built on
909        # Darwin - either AquaTk, if it is found, or X11 based Tk.
910        platform = self.get_platform()
911        if platform == 'darwin' and \
912           self.detect_tkinter_darwin(inc_dirs, lib_dirs):
913            return
914
915        # Set platform specific library prefix, if any
916        if platform == 'cygwin':
917            lib_prefix = 'cyg'
918        else:
919            lib_prefix = ''
920
921        # Assume we haven't found any of the libraries or include files
922        # The versions with dots are used on Unix, and the versions without
923        # dots on Windows, for detection by cygwin.
924        tcllib = tklib = tcl_includes = tk_includes = None
925        for version in ['8.4', '84', '8.3', '83', '8.2',
926                        '82', '8.1', '81', '8.0', '80']:
927            tklib = self.compiler.find_library_file(lib_dirs,
928                                                    lib_prefix + 'tk' + version)
929            tcllib = self.compiler.find_library_file(lib_dirs,
930                                                     lib_prefix + 'tcl' + version)
931            if tklib and tcllib:
932                # Exit the loop when we've found the Tcl/Tk libraries
933                break
934
935        # Now check for the header files
936        if tklib and tcllib:
937            # Check for the include files on Debian, where
938            # they're put in /usr/include/{tcl,tk}X.Y
939            debian_tcl_include = [ '/usr/include/tcl' + version ]
940            debian_tk_include =  [ '/usr/include/tk'  + version ] + \
941                                 debian_tcl_include
942            tcl_includes = find_file('tcl.h', inc_dirs, debian_tcl_include)
943            tk_includes = find_file('tk.h', inc_dirs, debian_tk_include)
944
945        if (tcllib is None or tklib is None and
946            tcl_includes is None or tk_includes is None):
947            # Something's missing, so give up
948            return
949
950        # OK... everything seems to be present for Tcl/Tk.
951
952        include_dirs = [] ; libs = [] ; defs = [] ; added_lib_dirs = []
953        for dir in tcl_includes + tk_includes:
954            if dir not in include_dirs:
955                include_dirs.append(dir)
956
957        # Check for various platform-specific directories
958        if platform == 'sunos5':
959            include_dirs.append('/usr/openwin/include')
960            added_lib_dirs.append('/usr/openwin/lib')
961        elif platform == 'cygwin':
962            # Verify that the pseudo-X headers are installed before proceeding
963            x11_inc = find_file('X11/Xlib.h', [], inc_dirs)
964            if x11_inc is None:
965                return
966        elif os.path.exists('/usr/X11R6/include'):
967            include_dirs.append('/usr/X11R6/include')
968            added_lib_dirs.append('/usr/X11R6/lib')
969        elif os.path.exists('/usr/X11R5/include'):
970            include_dirs.append('/usr/X11R5/include')
971            added_lib_dirs.append('/usr/X11R5/lib')
972        else:
973            # Assume default location for X11
974            include_dirs.append('/usr/X11/include')
975            added_lib_dirs.append('/usr/X11/lib')
976
977        # Check for BLT extension
978        if self.compiler.find_library_file(lib_dirs + added_lib_dirs,
979                                           'BLT8.0'):
980            defs.append( ('WITH_BLT', 1) )
981            libs.append('BLT8.0')
982        elif self.compiler.find_library_file(lib_dirs + added_lib_dirs,
983                                           'BLT'):
984            defs.append( ('WITH_BLT', 1) )
985            libs.append('BLT')
986
987        # Add the Tcl/Tk libraries
988        libs.append(lib_prefix + 'tk'+ version)
989        libs.append(lib_prefix + 'tcl'+ version)
990
991        if platform in ['aix3', 'aix4']:
992            libs.append('ld')
993
994        # Finally, link with the X11 libraries (not appropriate on cygwin)
995        if platform != "cygwin":
996            libs.append('X11')
997
998        ext = Extension('_tkinter', ['_tkinter.c', 'tkappinit.c'],
999                        define_macros=[('WITH_APPINIT', 1)] + defs,
1000                        include_dirs = include_dirs,
1001                        libraries = libs,
1002                        library_dirs = added_lib_dirs,
1003                        )
1004        self.extensions.append(ext)
1005
1006        # XXX handle these, but how to detect?
1007        # *** Uncomment and edit for PIL (TkImaging) extension only:
1008        #       -DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
1009        # *** Uncomment and edit for TOGL extension only:
1010        #       -DWITH_TOGL togl.c \
1011        # *** Uncomment these for TOGL extension only:
1012        #       -lGL -lGLU -lXext -lXmu \
1013
1014class PyBuildInstall(install):
1015    # Suppress the warning about installation into the lib_dynload
1016    # directory, which is not in sys.path when running Python during
1017    # installation:
1018    def initialize_options (self):
1019        install.initialize_options(self)
1020        self.warn_dir=0
1021
1022class PyBuildInstallLib(install_lib):
1023    # Do exactly what install_lib does but make sure correct access modes get
1024    # set on installed directories and files. All installed files with get
1025    # mode 644 unless they are a shared library in which case they will get
1026    # mode 755. All installed directories will get mode 755.
1027
1028    so_ext = sysconfig.get_config_var("SO")
1029
1030    def install(self):
1031        outfiles = install_lib.install(self)
1032        self.set_file_modes(outfiles, 0644, 0755)
1033        self.set_dir_modes(self.install_dir, 0755)
1034        return outfiles
1035
1036    def set_file_modes(self, files, defaultMode, sharedLibMode):
1037        if not self.is_chmod_supported(): return
1038        if not files: return
1039
1040        for filename in files:
1041            if os.path.islink(filename): continue
1042            mode = defaultMode
1043            if filename.endswith(self.so_ext): mode = sharedLibMode
1044            log.info("changing mode of %s to %o", filename, mode)
1045            if not self.dry_run: os.chmod(filename, mode)
1046
1047    def set_dir_modes(self, dirname, mode):
1048        if not self.is_chmod_supported(): return
1049        os.path.walk(dirname, self.set_dir_modes_visitor, mode)
1050
1051    def set_dir_modes_visitor(self, mode, dirname, names):
1052        if os.path.islink(dirname): return
1053        log.info("changing mode of %s to %o", dirname, mode)
1054        if not self.dry_run: os.chmod(dirname, mode)
1055
1056    def is_chmod_supported(self):
1057        return hasattr(os, 'chmod')
1058
1059def main():
1060    # turn off warnings when deprecated modules are imported
1061    import warnings
1062    warnings.filterwarnings("ignore",category=DeprecationWarning)
1063    setup(name = 'Python standard library',
1064          version = '%d.%d' % sys.version_info[:2],
1065          cmdclass = {'build_ext':PyBuildExt, 'install':PyBuildInstall,
1066                      'install_lib':PyBuildInstallLib},
1067          # The struct module is defined here, because build_ext won't be
1068          # called unless there's at least one extension module defined.
1069          ext_modules=[Extension('struct', ['structmodule.c'])],
1070
1071          # Scripts to install
1072          scripts = ['Tools/scripts/pydoc']
1073        )
1074
1075# --install-platlib
1076if __name__ == '__main__':
1077    main()
1078