← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: John Arbash Meinel
  • Date: 2009-07-08 15:43:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4521.
  • Revision ID: john@arbash-meinel.com-20090708154351-u0t41fwjqm28pbnu
Add comments in the finally sections as to why we want them.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
9
9
import os
10
10
import os.path
11
11
import sys
12
 
import copy
13
12
 
14
 
if sys.version_info < (2, 6):
15
 
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.6+\n")
 
13
if sys.version_info < (2, 4):
 
14
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.4+\n")
16
15
    sys.exit(1)
17
16
 
18
17
# NOTE: The directory containing setup.py, whether run by 'python setup.py' or
38
37
    'version':      bzrlib.__version__,
39
38
    'author':       'Canonical Ltd',
40
39
    'author_email': 'bazaar@lists.canonical.com',
41
 
    'url':          'http://bazaar.canonical.com/',
 
40
    'url':          'http://www.bazaar-vcs.org/',
42
41
    'description':  'Friendly distributed version control system',
43
42
    'license':      'GNU GPL v2',
44
 
    'download_url': 'https://launchpad.net/bzr/+download',
 
43
    'download_url': 'http://bazaar-vcs.org/Download',
45
44
    'long_description': get_long_description(),
46
45
    'classifiers': [
47
46
        'Development Status :: 6 - Mature',
66
65
            'package_data': {'bzrlib': ['doc/api/*.txt',
67
66
                                        'tests/test_patches_data/*',
68
67
                                        'help_topics/en/*.txt',
69
 
                                        'tests/ssl_certs/ca.crt',
70
 
                                        'tests/ssl_certs/server_without_pass.key',
71
 
                                        'tests/ssl_certs/server_with_pass.key',
72
 
                                        'tests/ssl_certs/server.crt',
73
 
                                        'locale/*/LC_MESSAGES/*.mo',
74
68
                                       ]},
75
69
           }
76
70
 
99
93
BZRLIB['packages'] = get_bzrlib_packages()
100
94
 
101
95
 
102
 
from distutils import log
103
96
from distutils.core import setup
104
97
from distutils.command.install_scripts import install_scripts
105
98
from distutils.command.install_data import install_data
128
121
                f = file(batch_path, "w")
129
122
                f.write(batch_str)
130
123
                f.close()
131
 
                print("Created: %s" % batch_path)
132
 
            except Exception:
133
 
                e = sys.exc_info()[1]
134
 
                print("ERROR: Unable to create %s: %s" % (batch_path, e))
 
124
                print "Created:", batch_path
 
125
            except Exception, e:
 
126
                print "ERROR: Unable to create %s: %s" % (batch_path, e)
135
127
 
136
128
    def _quoted_path(self, path):
137
129
        if ' ' in path:
153
145
    Generate bzr.1.
154
146
    """
155
147
 
156
 
    sub_commands = build.sub_commands + [
157
 
            ('build_mo', lambda _: True),
158
 
            ]
159
 
 
160
148
    def run(self):
161
149
        build.run(self)
162
150
 
168
156
## Setup
169
157
########################
170
158
 
171
 
from tools.build_mo import build_mo
172
 
 
173
159
command_classes = {'install_scripts': my_install_scripts,
174
 
                   'build': bzr_build,
175
 
                   'build_mo': build_mo,
176
 
                   }
 
160
                   'build': bzr_build}
177
161
from distutils import log
178
162
from distutils.errors import CCompilerError, DistutilsPlatformError
179
163
from distutils.extension import Extension
180
164
ext_modules = []
181
165
try:
182
 
    try:
183
 
        from Cython.Distutils import build_ext
184
 
        from Cython.Compiler.Version import version as pyrex_version
185
 
    except ImportError:
186
 
        print("No Cython, trying Pyrex...")
187
 
        from Pyrex.Distutils import build_ext
188
 
        from Pyrex.Compiler.Version import version as pyrex_version
 
166
    from Pyrex.Distutils import build_ext
189
167
except ImportError:
190
168
    have_pyrex = False
191
169
    # try to build the extension from the prior generated source.
192
 
    print("")
193
 
    print("The python package 'Pyrex' is not available."
194
 
          " If the .c files are available,")
195
 
    print("they will be built,"
196
 
          " but modifying the .pyx files will not rebuild them.")
197
 
    print("")
 
170
    print
 
171
    print ("The python package 'Pyrex' is not available."
 
172
           " If the .c files are available,")
 
173
    print ("they will be built,"
 
174
           " but modifying the .pyx files will not rebuild them.")
 
175
    print
198
176
    from distutils.command.build_ext import build_ext
199
177
else:
200
178
    have_pyrex = True
201
 
    pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
 
179
    from Pyrex.Compiler.Version import version as pyrex_version
202
180
 
203
181
 
204
182
class build_ext_if_possible(build_ext):
216
194
    def run(self):
217
195
        try:
218
196
            build_ext.run(self)
219
 
        except DistutilsPlatformError:
220
 
            e = sys.exc_info()[1]
 
197
        except DistutilsPlatformError, e:
221
198
            if not self.allow_python_fallback:
222
199
                log.warn('\n  Cannot build extensions.\n'
223
200
                         '  Use "build_ext --allow-python-fallback" to use'
282
259
        define_macros=define_macros, libraries=libraries))
283
260
 
284
261
 
285
 
add_pyrex_extension('bzrlib._annotator_pyx')
286
262
add_pyrex_extension('bzrlib._bencode_pyx')
 
263
add_pyrex_extension('bzrlib._btree_serializer_pyx')
287
264
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
288
265
add_pyrex_extension('bzrlib._groupcompress_pyx',
289
266
                    extra_source=['bzrlib/diff-delta.c'])
294
271
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
295
272
                        libraries=['Ws2_32'])
296
273
    add_pyrex_extension('bzrlib._walkdirs_win32')
 
274
    z_lib = 'zdll'
297
275
else:
298
 
    if have_pyrex and pyrex_version_info[:3] == (0,9,4):
 
276
    if have_pyrex and pyrex_version == '0.9.4.1':
299
277
        # Pyrex 0.9.4.1 fails to compile this extension correctly
300
278
        # The code it generates re-uses a "local" pointer and
301
279
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
302
280
        # which is NULL safe with PY_DECREF which is not.)
303
 
        # <https://bugs.launchpad.net/bzr/+bug/449372>
304
 
        # <https://bugs.launchpad.net/bzr/+bug/276868>
305
 
        print('Cannot build extension "bzrlib._dirstate_helpers_pyx" using')
306
 
        print('your version of pyrex "%s". Please upgrade your pyrex'
307
 
              % (pyrex_version,))
308
 
        print('install. For now, the non-compiled (python) version will')
309
 
        print('be used instead.')
 
281
        print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
 
282
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
 
283
            pyrex_version,)
 
284
        print 'install. For now, the non-compiled (python) version will'
 
285
        print 'be used instead.'
310
286
    else:
311
287
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
312
288
    add_pyrex_extension('bzrlib._readdir_pyx')
313
 
add_pyrex_extension('bzrlib._chk_map_pyx')
 
289
    z_lib = 'z'
 
290
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
314
291
ext_modules.append(Extension('bzrlib._patiencediff_c',
315
292
                             ['bzrlib/_patiencediff_c.c']))
316
 
if have_pyrex and pyrex_version_info < (0, 9, 6, 3):
317
 
    print("")
318
 
    print('Your Pyrex/Cython version %s is too old to build the simple_set' % (
319
 
        pyrex_version))
320
 
    print('and static_tuple extensions.')
321
 
    print('Please upgrade to at least Pyrex 0.9.6.3')
322
 
    print("")
323
 
    # TODO: Should this be a fatal error?
324
 
else:
325
 
    # We only need 0.9.6.3 to build _simple_set_pyx, but static_tuple depends
326
 
    # on simple_set
327
 
    add_pyrex_extension('bzrlib._simple_set_pyx')
328
 
    ext_modules.append(Extension('bzrlib._static_tuple_c',
329
 
                                 ['bzrlib/_static_tuple_c.c']))
330
 
add_pyrex_extension('bzrlib._btree_serializer_pyx')
331
293
 
332
294
 
333
295
if unavailable_files:
334
 
    print('C extension(s) not found:')
335
 
    print('   %s' % ('\n  '.join(unavailable_files),))
336
 
    print('The python versions will be used instead.')
337
 
    print("")
 
296
    print 'C extension(s) not found:'
 
297
    print '   %s' % ('\n  '.join(unavailable_files),)
 
298
    print 'The python versions will be used instead.'
 
299
    print
338
300
 
339
301
 
340
302
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
360
322
    # Ensure tbzrlib itself is on sys.path
361
323
    sys.path.append(tbzr_root)
362
324
 
 
325
    # Ensure our COM "entry-point" is on sys.path
 
326
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
 
327
 
363
328
    packages.append("tbzrlib")
364
329
 
365
330
    # collect up our icons.
387
352
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
388
353
                       win32ui crawler.Crawler""".split())
389
354
 
 
355
    # NOTE: We still create a DLL version of the Python implemented shell
 
356
    # extension for testing purposes - but it is *not* registered by
 
357
    # default - our C++ one is instead.  To discourage people thinking
 
358
    # this DLL is still necessary, its called 'tbzr_old.dll'
 
359
    tbzr = dict(
 
360
        modules=["tbzr"],
 
361
        create_exe = False, # we only want a .dll
 
362
        dest_base = 'tbzr_old',
 
363
    )
 
364
    com_targets.append(tbzr)
 
365
 
390
366
    # tbzrcache executables - a "console" version for debugging and a
391
367
    # GUI version that is generally used.
392
368
    tbzrcache = dict(
404
380
    # ditto for the tbzrcommand tool
405
381
    tbzrcommand = dict(
406
382
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
407
 
        icon_resources = icon_resources,
408
 
        other_resources = other_resources,
 
383
        icon_resources = [(0,'bzr.ico')],
409
384
    )
410
385
    console_targets.append(tbzrcommand)
411
386
    tbzrcommandw = tbzrcommand.copy()
418
393
    console_targets.append(tracer)
419
394
 
420
395
    # The C++ implemented shell extensions.
421
 
    dist_dir = os.path.join(tbzr_root, "shellext", "build")
 
396
    dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
 
397
                            "build", "dist")
422
398
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
423
399
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
424
400
 
425
401
 
426
 
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
 
402
def get_qbzr_py2exe_info(includes, excludes, packages):
427
403
    # PyQt4 itself still escapes the plugin detection code for some reason...
428
 
    includes.append('PyQt4.QtCore')
429
 
    includes.append('PyQt4.QtGui')
 
404
    packages.append('PyQt4')
 
405
    excludes.append('PyQt4.elementtree.ElementTree')
430
406
    includes.append('sip') # extension module required for Qt.
431
407
    packages.append('pygments') # colorizer for qbzr
432
408
    packages.append('docutils') # html formatting
433
 
    includes.append('win32event')  # for qsubprocess stuff
 
409
    # but we can avoid many Qt4 Dlls.
 
410
    dll_excludes.extend(
 
411
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
 
412
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
 
413
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
 
414
        qscintilla2.dll""".split())
434
415
    # the qt binaries might not be on PATH...
435
 
    # They seem to install to a place like C:\Python25\PyQt4\*
436
 
    # Which is not the same as C:\Python25\Lib\site-packages\PyQt4
437
 
    pyqt_dir = os.path.join(sys.prefix, "PyQt4")
438
 
    pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
439
 
    if os.path.isdir(pyqt_bin_dir):
440
 
        path = os.environ.get("PATH", "")
441
 
        if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
442
 
            os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
443
 
    # also add all imageformat plugins to distribution
444
 
    # We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
445
 
    base_dirs_to_check = []
446
 
    if os.path.isdir(pyqt_dir):
447
 
        base_dirs_to_check.append(pyqt_dir)
448
 
    try:
449
 
        import PyQt4
450
 
    except ImportError:
451
 
        pass
452
 
    else:
453
 
        pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
454
 
        if pyqt4_base_dir != pyqt_dir:
455
 
            base_dirs_to_check.append(pyqt4_base_dir)
456
 
    if not base_dirs_to_check:
457
 
        log.warn("Can't find PyQt4 installation -> not including imageformat"
458
 
                 " plugins")
459
 
    else:
460
 
        files = []
461
 
        for base_dir in base_dirs_to_check:
462
 
            plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
463
 
            if os.path.isdir(plug_dir):
464
 
                for fname in os.listdir(plug_dir):
465
 
                    # Include plugin dlls, but not debugging dlls
466
 
                    fullpath = os.path.join(plug_dir, fname)
467
 
                    if fname.endswith('.dll') and not fname.endswith('d4.dll'):
468
 
                        files.append(fullpath)
469
 
        if files:
470
 
            data_files.append(('imageformats', files))
471
 
        else:
472
 
            log.warn('PyQt4 was found, but we could not find any imageformat'
473
 
                     ' plugins. Are you sure your configuration is correct?')
 
416
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
 
417
    path = os.environ.get("PATH","")
 
418
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
419
        os.environ["PATH"] = path + os.pathsep + qt_dir
474
420
 
475
421
 
476
422
def get_svn_py2exe_info(includes, excludes, packages):
477
423
    packages.append('subvertpy')
478
 
    packages.append('sqlite3')
479
 
 
480
 
 
481
 
def get_fastimport_py2exe_info(includes, excludes, packages):
482
 
    # This is the python-fastimport package, not to be confused with the
483
 
    # bzr-fastimport plugin.
484
 
    packages.append('fastimport')
485
424
 
486
425
 
487
426
if 'bdist_wininst' in sys.argv:
508
447
            # help pages
509
448
            'data_files': find_docs(),
510
449
            # for building pyrex extensions
511
 
            'cmdclass': command_classes,
 
450
            'cmdclass': {'build_ext': build_ext_if_possible},
512
451
           }
513
452
 
514
453
    ARGS.update(META_INFO)
515
454
    ARGS.update(BZRLIB)
516
455
    ARGS.update(PKG_DATA)
517
 
 
 
456
    
518
457
    setup(**ARGS)
519
458
 
520
459
elif 'py2exe' in sys.argv:
545
484
            install_data.run(self)
546
485
 
547
486
            py2exe = self.distribution.get_command_obj('py2exe', False)
548
 
            # GZ 2010-04-19: Setup has py2exe.optimize as 2, but give plugins
549
 
            #                time before living with docstring stripping
550
 
            optimize = 1
 
487
            optimize = py2exe.optimize
551
488
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
552
 
            # Round mtime to nearest even second so that installing on a FAT
553
 
            # filesystem bytecode internal and script timestamps will match
554
 
            for f in compile_names:
555
 
                mtime = os.stat(f).st_mtime
556
 
                remainder = mtime % 2
557
 
                if remainder:
558
 
                    mtime -= remainder
559
 
                    os.utime(f, (mtime, mtime))
560
489
            byte_compile(compile_names,
561
490
                         optimize=optimize,
562
491
                         force=self.force, prefix=self.install_dir,
563
492
                         dry_run=self.dry_run)
564
 
            self.outfiles.extend([f + 'o' for f in compile_names])
 
493
            if optimize:
 
494
                suffix = 'o'
 
495
            else:
 
496
                suffix = 'c'
 
497
            self.outfiles.extend([f + suffix for f in compile_names])
565
498
    # end of class install_data_with_bytecompile
566
499
 
567
500
    target = py2exe.build_exe.Target(script = "bzr",
571
504
                                     version = version_str,
572
505
                                     description = META_INFO['description'],
573
506
                                     author = META_INFO['author'],
574
 
                                     copyright = "(c) Canonical Ltd, 2005-2010",
 
507
                                     copyright = "(c) Canonical Ltd, 2005-2007",
575
508
                                     company_name = "Canonical Ltd.",
576
509
                                     comments = META_INFO['description'],
577
510
                                    )
578
 
    gui_target = copy.copy(target)
579
 
    gui_target.dest_base = "bzrw"
580
511
 
581
512
    packages = BZRLIB['packages']
582
513
    packages.remove('bzrlib')
592
523
    if sys.version.startswith('2.4'):
593
524
        # adding elementtree package
594
525
        additional_packages.add('elementtree')
595
 
    elif sys.version.startswith('2.6') or sys.version.startswith('2.5'):
 
526
    elif sys.version.startswith('2.5'):
596
527
        additional_packages.add('xml.etree')
597
528
    else:
598
529
        import warnings
644
575
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
645
576
        x = []
646
577
        for i in files:
647
 
            # Throw away files we don't want packaged. Note that plugins may
648
 
            # have data files with all sorts of extensions so we need to
649
 
            # be conservative here about what we ditch.
650
 
            ext = os.path.splitext(i)[1]
651
 
            if ext.endswith('~') or ext in [".pyc", ".swp"]:
 
578
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
652
579
                continue
653
580
            if i == '__init__.py' and root == 'bzrlib/plugins':
654
581
                continue
667
594
    console_targets = [target,
668
595
                       'tools/win32/bzr_postinstall.py',
669
596
                       ]
670
 
    gui_targets = [gui_target]
 
597
    gui_targets = []
 
598
    com_targets = []
671
599
    data_files = topics_files + plugins_files
672
600
 
673
601
    if 'qbzr' in plugins:
674
 
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
 
602
        get_qbzr_py2exe_info(includes, excludes, packages)
675
603
 
676
604
    if 'svn' in plugins:
677
605
        get_svn_py2exe_info(includes, excludes, packages)
678
606
 
679
 
    if 'fastimport' in plugins:
680
 
        get_fastimport_py2exe_info(includes, excludes, packages)
681
 
 
682
607
    if "TBZR" in os.environ:
683
608
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
684
609
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
703
628
        # print this warning to stderr as output is redirected, so it is seen
704
629
        # at build time.  Also to stdout so it appears in the log
705
630
        for f in (sys.stderr, sys.stdout):
706
 
            f.write("Skipping TBZR binaries - "
707
 
                "please set TBZR to a directory to enable\n")
 
631
            print >> f, \
 
632
                "Skipping TBZR binaries - please set TBZR to a directory to enable"
708
633
 
709
634
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
710
635
    # in on Vista.
711
 
    dll_excludes.extend(["MSWSOCK.dll",
712
 
                         "MSVCP60.dll",
713
 
                         "MSVCP90.dll",
714
 
                         "powrprof.dll",
715
 
                         "SHFOLDER.dll"])
 
636
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
716
637
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
717
638
                               "includes": includes,
718
639
                               "excludes": excludes,
719
640
                               "dll_excludes": dll_excludes,
720
641
                               "dist_dir": "win32_bzr.exe",
721
 
                               "optimize": 2,
722
 
                               "custom_boot_script":
723
 
                                        "tools/win32/py2exe_boot_common.py",
 
642
                               "optimize": 1,
724
643
                              },
725
644
                   }
726
645
 
727
 
    # We want the libaray.zip to have optimize = 2, but the exe to have
728
 
    # optimize = 1, so that .py files that get compilied at run time
729
 
    # (e.g. user installed plugins) dont have their doc strings removed.
730
 
    class py2exe_no_oo_exe(py2exe.build_exe.py2exe):
731
 
        def build_executable(self, *args, **kwargs):
732
 
            self.optimize = 1
733
 
            py2exe.build_exe.py2exe.build_executable(self, *args, **kwargs)
734
 
            self.optimize = 2
735
 
 
736
 
    if __name__ == '__main__':
737
 
        command_classes['install_data'] = install_data_with_bytecompile
738
 
        command_classes['py2exe'] = py2exe_no_oo_exe
739
 
        setup(options=options_list,
740
 
              console=console_targets,
741
 
              windows=gui_targets,
742
 
              zipfile='lib/library.zip',
743
 
              data_files=data_files,
744
 
              cmdclass=command_classes,
745
 
              )
 
646
    setup(options=options_list,
 
647
          console=console_targets,
 
648
          windows=gui_targets,
 
649
          com_server=com_targets,
 
650
          zipfile='lib/library.zip',
 
651
          data_files=data_files,
 
652
          cmdclass={'install_data': install_data_with_bytecompile},
 
653
          )
746
654
 
747
655
else:
748
656
    # ad-hoc for easy_install
763
671
    ARGS.update(BZRLIB)
764
672
    ARGS.update(PKG_DATA)
765
673
 
766
 
    if __name__ == '__main__':
767
 
        setup(**ARGS)
 
674
    setup(**ARGS)