← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
37
37
    'version':      bzrlib.__version__,
38
38
    'author':       'Canonical Ltd',
39
39
    'author_email': 'bazaar@lists.canonical.com',
40
 
    'url':          'http://www.bazaar-vcs.org/',
 
40
    'url':          'http://bazaar.canonical.com/',
41
41
    'description':  'Friendly distributed version control system',
42
42
    'license':      'GNU GPL v2',
43
 
    'download_url': 'http://bazaar-vcs.org/Download',
 
43
    'download_url': 'https://launchpad.net/bzr/+download',
44
44
    'long_description': get_long_description(),
45
45
    'classifiers': [
46
46
        'Development Status :: 6 - Mature',
65
65
            'package_data': {'bzrlib': ['doc/api/*.txt',
66
66
                                        'tests/test_patches_data/*',
67
67
                                        'help_topics/en/*.txt',
 
68
                                        'tests/ssl_certs/server_without_pass.key',
 
69
                                        'tests/ssl_certs/server_with_pass.key',
 
70
                                        'tests/ssl_certs/server.crt'
68
71
                                       ]},
69
72
           }
70
73
 
93
96
BZRLIB['packages'] = get_bzrlib_packages()
94
97
 
95
98
 
 
99
from distutils import log
96
100
from distutils.core import setup
97
101
from distutils.command.install_scripts import install_scripts
98
102
from distutils.command.install_data import install_data
144
148
    """Customized build distutils action.
145
149
    Generate bzr.1.
146
150
    """
 
151
 
147
152
    def run(self):
148
153
        build.run(self)
149
154
 
150
 
        import generate_docs
 
155
        from tools import generate_docs
151
156
        generate_docs.main(argv=["bzr", "man"])
152
157
 
153
158
 
162
167
from distutils.extension import Extension
163
168
ext_modules = []
164
169
try:
165
 
    from Pyrex.Distutils import build_ext
 
170
    try:
 
171
        from Pyrex.Distutils import build_ext
 
172
        from Pyrex.Compiler.Version import version as pyrex_version
 
173
    except ImportError:
 
174
        print "No Pyrex, trying Cython..."
 
175
        from Cython.Distutils import build_ext
 
176
        from Cython.Compiler.Version import version as pyrex_version
166
177
except ImportError:
167
178
    have_pyrex = False
168
179
    # try to build the extension from the prior generated source.
175
186
    from distutils.command.build_ext import build_ext
176
187
else:
177
188
    have_pyrex = True
 
189
    pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
178
190
 
179
191
 
180
192
class build_ext_if_possible(build_ext):
181
193
 
 
194
    user_options = build_ext.user_options + [
 
195
        ('allow-python-fallback', None,
 
196
         "When an extension cannot be built, allow falling"
 
197
         " back to the pure-python implementation.")
 
198
        ]
 
199
 
 
200
    def initialize_options(self):
 
201
        build_ext.initialize_options(self)
 
202
        self.allow_python_fallback = False
 
203
 
182
204
    def run(self):
183
205
        try:
184
206
            build_ext.run(self)
185
207
        except DistutilsPlatformError, e:
 
208
            if not self.allow_python_fallback:
 
209
                log.warn('\n  Cannot build extensions.\n'
 
210
                         '  Use "build_ext --allow-python-fallback" to use'
 
211
                         ' slower python implementations instead.\n')
 
212
                raise
186
213
            log.warn(str(e))
187
 
            log.warn('Extensions cannot be built, '
188
 
                     'will use the Python versions instead')
 
214
            log.warn('\n  Extensions cannot be built.\n'
 
215
                     '  Using the slower Python implementations instead.\n')
189
216
 
190
217
    def build_extension(self, ext):
191
218
        try:
192
219
            build_ext.build_extension(self, ext)
193
220
        except CCompilerError:
194
 
            log.warn('Building of "%s" extension failed, '
195
 
                     'will use the Python version instead' % (ext.name,))
 
221
            if not self.allow_python_fallback:
 
222
                log.warn('\n  Cannot build extension "%s".\n'
 
223
                         '  Use "build_ext --allow-python-fallback" to use'
 
224
                         ' slower python implementations instead.\n'
 
225
                         % (ext.name,))
 
226
                raise
 
227
            log.warn('\n  Building of "%s" extension failed.\n'
 
228
                     '  Using the slower Python implementation instead.'
 
229
                     % (ext.name,))
196
230
 
197
231
 
198
232
# Override the build_ext if we have Pyrex available
200
234
unavailable_files = []
201
235
 
202
236
 
203
 
def add_pyrex_extension(module_name, **kwargs):
 
237
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
204
238
    """Add a pyrex module to build.
205
239
 
206
240
    This will use Pyrex to auto-generate the .c file if it is available.
216
250
    path = module_name.replace('.', '/')
217
251
    pyrex_name = path + '.pyx'
218
252
    c_name = path + '.c'
 
253
    define_macros = []
 
254
    if sys.platform == 'win32':
 
255
        # pyrex uses the macro WIN32 to detect the platform, even though it
 
256
        # should be using something like _WIN32 or MS_WINDOWS, oh well, we can
 
257
        # give it the right value.
 
258
        define_macros.append(('WIN32', None))
219
259
    if have_pyrex:
220
 
        ext_modules.append(Extension(module_name, [pyrex_name], **kwargs))
 
260
        source = [pyrex_name]
221
261
    else:
222
262
        if not os.path.isfile(c_name):
223
263
            unavailable_files.append(c_name)
 
264
            return
224
265
        else:
225
 
            ext_modules.append(Extension(module_name, [c_name], **kwargs))
226
 
 
227
 
 
228
 
add_pyrex_extension('bzrlib._btree_serializer_c')
229
 
add_pyrex_extension('bzrlib._dirstate_helpers_c')
230
 
add_pyrex_extension('bzrlib._knit_load_data_c')
231
 
add_pyrex_extension('bzrlib._readdir_pyx')
 
266
            source = [c_name]
 
267
    source.extend(extra_source)
 
268
    ext_modules.append(Extension(module_name, source,
 
269
        define_macros=define_macros, libraries=libraries))
 
270
 
 
271
 
 
272
add_pyrex_extension('bzrlib._annotator_pyx')
 
273
add_pyrex_extension('bzrlib._bencode_pyx')
 
274
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
 
275
add_pyrex_extension('bzrlib._groupcompress_pyx',
 
276
                    extra_source=['bzrlib/diff-delta.c'])
 
277
add_pyrex_extension('bzrlib._knit_load_data_pyx')
 
278
add_pyrex_extension('bzrlib._known_graph_pyx')
 
279
add_pyrex_extension('bzrlib._rio_pyx')
232
280
if sys.platform == 'win32':
233
 
    # pyrex uses the macro WIN32 to detect the platform, even though it should
234
 
    # be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
235
 
    # right value.
236
 
    add_pyrex_extension('bzrlib._walkdirs_win32',
237
 
                        define_macros=[('WIN32', None)])
238
 
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
 
281
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
 
282
                        libraries=['Ws2_32'])
 
283
    add_pyrex_extension('bzrlib._walkdirs_win32')
 
284
    z_lib = 'zdll'
 
285
else:
 
286
    if have_pyrex and pyrex_version_info[:3] == (0,9,4):
 
287
        # Pyrex 0.9.4.1 fails to compile this extension correctly
 
288
        # The code it generates re-uses a "local" pointer and
 
289
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
 
290
        # which is NULL safe with PY_DECREF which is not.)
 
291
        # <https://bugs.edge.launchpad.net/bzr/+bug/449372>
 
292
        # <https://bugs.edge.launchpad.net/bzr/+bug/276868>
 
293
        print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
 
294
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
 
295
            pyrex_version,)
 
296
        print 'install. For now, the non-compiled (python) version will'
 
297
        print 'be used instead.'
 
298
    else:
 
299
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
 
300
    add_pyrex_extension('bzrlib._readdir_pyx')
 
301
    z_lib = 'z'
 
302
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
 
303
ext_modules.append(Extension('bzrlib._patiencediff_c',
 
304
                             ['bzrlib/_patiencediff_c.c']))
 
305
if have_pyrex and pyrex_version_info < (0, 9, 6, 3):
 
306
    print
 
307
    print 'Your Pyrex/Cython version %s is too old to build the simple_set' % (
 
308
        pyrex_version)
 
309
    print 'and static_tuple extensions.'
 
310
    print 'Please upgrade to at least Pyrex 0.9.6.3'
 
311
    print
 
312
    # TODO: Should this be a fatal error?
 
313
else:
 
314
    # We only need 0.9.6.3 to build _simple_set_pyx, but static_tuple depends
 
315
    # on simple_set
 
316
    add_pyrex_extension('bzrlib._simple_set_pyx')
 
317
    ext_modules.append(Extension('bzrlib._static_tuple_c',
 
318
                                 ['bzrlib/_static_tuple_c.c']))
 
319
add_pyrex_extension('bzrlib._btree_serializer_pyx')
239
320
 
240
321
 
241
322
if unavailable_files:
246
327
 
247
328
 
248
329
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
249
 
                         gui_targets):
 
330
                         gui_targets, data_files):
250
331
    packages.append('tbzrcommands')
251
332
 
252
333
    # ModuleFinder can't handle runtime changes to __path__, but
268
349
    # Ensure tbzrlib itself is on sys.path
269
350
    sys.path.append(tbzr_root)
270
351
 
271
 
    # Ensure our COM "entry-point" is on sys.path
272
 
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
273
 
 
274
352
    packages.append("tbzrlib")
275
353
 
276
354
    # collect up our icons.
298
376
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
299
377
                       win32ui crawler.Crawler""".split())
300
378
 
301
 
    tbzr = dict(
302
 
        modules=["tbzr"],
303
 
        create_exe = False, # we only want a .dll
304
 
    )
305
 
    com_targets.append(tbzr)
306
 
 
307
379
    # tbzrcache executables - a "console" version for debugging and a
308
380
    # GUI version that is generally used.
309
381
    tbzrcache = dict(
310
 
        script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
 
382
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
311
383
        icon_resources = icon_resources,
312
384
        other_resources = other_resources,
313
385
    )
320
392
 
321
393
    # ditto for the tbzrcommand tool
322
394
    tbzrcommand = dict(
323
 
        script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
 
395
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
324
396
        icon_resources = [(0,'bzr.ico')],
325
397
    )
326
398
    console_targets.append(tbzrcommand)
328
400
    tbzrcommandw["dest_base"]="tbzrcommandw"
329
401
    gui_targets.append(tbzrcommandw)
330
402
    
331
 
    # tbzr tests
332
 
    tbzrtest = dict(
333
 
        script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
334
 
    )
335
 
    console_targets.append(tbzrtest)
336
 
 
337
 
    # A utility to see python output from the shell extension - this will
338
 
    # die when we get a c++ extension
339
 
    # any .py file from pywin32's win32 lib will do (other than
340
 
    # win32traceutil itself that is)
341
 
    import winerror
342
 
    win32_lib_dir = os.path.dirname(winerror.__file__)
343
 
    tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
344
 
                  dest_base="tbzr_tracer")
 
403
    # A utility to see python output from both C++ and Python based shell
 
404
    # extensions
 
405
    tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
345
406
    console_targets.append(tracer)
346
407
 
347
 
 
348
 
def get_qbzr_py2exe_info(includes, excludes, packages):
 
408
    # The C++ implemented shell extensions.
 
409
    dist_dir = os.path.join(tbzr_root, "shellext", "build")
 
410
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
 
411
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
 
412
 
 
413
 
 
414
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
349
415
    # PyQt4 itself still escapes the plugin detection code for some reason...
350
416
    packages.append('PyQt4')
351
417
    excludes.append('PyQt4.elementtree.ElementTree')
 
418
    excludes.append('PyQt4.uic.port_v3')
352
419
    includes.append('sip') # extension module required for Qt.
353
420
    packages.append('pygments') # colorizer for qbzr
 
421
    packages.append('docutils') # html formatting
 
422
    includes.append('win32event')  # for qsubprocess stuff
354
423
    # but we can avoid many Qt4 Dlls.
355
424
    dll_excludes.extend(
356
425
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
358
427
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
359
428
        qscintilla2.dll""".split())
360
429
    # the qt binaries might not be on PATH...
361
 
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
362
 
    path = os.environ.get("PATH","")
363
 
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
364
 
        os.environ["PATH"] = path + os.pathsep + qt_dir
 
430
    # They seem to install to a place like C:\Python25\PyQt4\*
 
431
    # Which is not the same as C:\Python25\Lib\site-packages\PyQt4
 
432
    pyqt_dir = os.path.join(sys.prefix, "PyQt4")
 
433
    pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
 
434
    if os.path.isdir(pyqt_bin_dir):
 
435
        path = os.environ.get("PATH", "")
 
436
        if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
437
            os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
 
438
    # also add all imageformat plugins to distribution
 
439
    # We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
 
440
    base_dirs_to_check = []
 
441
    if os.path.isdir(pyqt_dir):
 
442
        base_dirs_to_check.append(pyqt_dir)
 
443
    try:
 
444
        import PyQt4
 
445
    except ImportError:
 
446
        pass
 
447
    else:
 
448
        pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
 
449
        if pyqt4_base_dir != pyqt_dir:
 
450
            base_dirs_to_check.append(pyqt4_base_dir)
 
451
    if not base_dirs_to_check:
 
452
        log.warn("Can't find PyQt4 installation -> not including imageformat"
 
453
                 " plugins")
 
454
    else:
 
455
        files = []
 
456
        for base_dir in base_dirs_to_check:
 
457
            plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
 
458
            if os.path.isdir(plug_dir):
 
459
                for fname in os.listdir(plug_dir):
 
460
                    # Include plugin dlls, but not debugging dlls
 
461
                    fullpath = os.path.join(plug_dir, fname)
 
462
                    if fname.endswith('.dll') and not fname.endswith('d4.dll'):
 
463
                        files.append(fullpath)
 
464
        if files:
 
465
            data_files.append(('imageformats', files))
 
466
        else:
 
467
            log.warn('PyQt4 was found, but we could not find any imageformat'
 
468
                     ' plugins. Are you sure your configuration is correct?')
 
469
 
 
470
 
 
471
def get_svn_py2exe_info(includes, excludes, packages):
 
472
    packages.append('subvertpy')
365
473
 
366
474
 
367
475
if 'bdist_wininst' in sys.argv:
445
553
                                     version = version_str,
446
554
                                     description = META_INFO['description'],
447
555
                                     author = META_INFO['author'],
448
 
                                     copyright = "(c) Canonical Ltd, 2005-2007",
 
556
                                     copyright = "(c) Canonical Ltd, 2005-2010",
449
557
                                     company_name = "Canonical Ltd.",
450
558
                                     comments = META_INFO['description'],
451
559
                                    )
478
586
                  ImaginaryModule cElementTree elementtree.ElementTree
479
587
                  Crypto.PublicKey._fastmath
480
588
                  medusa medusa.filesys medusa.ftp_server
481
 
                  tools tools.doc_generate
 
589
                  tools
482
590
                  resource validate""".split()
483
591
    dll_excludes = []
484
592
 
507
615
    for root, dirs, files in os.walk('bzrlib/plugins'):
508
616
        if root == 'bzrlib/plugins':
509
617
            plugins = set(dirs)
 
618
            # We ship plugins as normal files on the file-system - however,
 
619
            # the build process can cause *some* of these plugin files to end
 
620
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
 
621
            # library.zip, and then saw import errors related to that as the
 
622
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
 
623
            # plugins out of the .zip file
 
624
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
510
625
        x = []
511
626
        for i in files:
512
 
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll"]:
 
627
            # Throw away files we don't want packaged. Note that plugins may
 
628
            # have data files with all sorts of extensions so we need to
 
629
            # be conservative here about what we ditch.
 
630
            ext = os.path.splitext(i)[1]
 
631
            if ext.endswith('~') or ext in [".pyc", ".swp"]:
513
632
                continue
514
633
            if i == '__init__.py' and root == 'bzrlib/plugins':
515
634
                continue
529
648
                       'tools/win32/bzr_postinstall.py',
530
649
                       ]
531
650
    gui_targets = []
532
 
    com_targets = []
 
651
    data_files = topics_files + plugins_files
533
652
 
534
653
    if 'qbzr' in plugins:
535
 
        get_qbzr_py2exe_info(includes, excludes, packages)
 
654
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
 
655
 
 
656
    if 'svn' in plugins:
 
657
        get_svn_py2exe_info(includes, excludes, packages)
536
658
 
537
659
    if "TBZR" in os.environ:
538
660
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
539
661
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
540
662
        # can be downloaded from (username=guest, blank password):
541
 
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
542
 
        if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
543
 
                                             '<nofile>')):
544
 
            raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
545
 
                               " location of the Win32 TortoiseOverlays .msi"
546
 
                               " installer file")
 
663
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
 
664
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
 
665
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
 
666
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
 
667
                       'TORTOISE_OVERLAYS_MSI_X64'):
 
668
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
 
669
                   '/TortoiseOverlays')
 
670
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
 
671
                raise RuntimeError(
 
672
                    "\nPlease set %s to the location of the relevant"
 
673
                    "\nTortoiseOverlays .msi installer file."
 
674
                    " The installers can be found at"
 
675
                    "\n  %s"
 
676
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
547
677
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
548
 
                             gui_targets)
 
678
                             gui_targets, data_files)
549
679
    else:
550
680
        # print this warning to stderr as output is redirected, so it is seen
551
681
        # at build time.  Also to stdout so it appears in the log
555
685
 
556
686
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
557
687
    # in on Vista.
558
 
    dll_excludes.append("MSWSOCK.dll")
 
688
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
559
689
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
560
690
                               "includes": includes,
561
691
                               "excludes": excludes,
568
698
    setup(options=options_list,
569
699
          console=console_targets,
570
700
          windows=gui_targets,
571
 
          com_server=com_targets,
572
701
          zipfile='lib/library.zip',
573
 
          data_files=topics_files + plugins_files,
 
702
          data_files=data_files,
574
703
          cmdclass={'install_data': install_data_with_bytecompile},
575
704
          )
576
705
 
578
707
    # ad-hoc for easy_install
579
708
    DATA_FILES = []
580
709
    if not 'bdist_egg' in sys.argv:
581
 
        # generate and install bzr.1 only with plain install, not easy_install one
 
710
        # generate and install bzr.1 only with plain install, not the
 
711
        # easy_install one
582
712
        DATA_FILES = [('man/man1', ['bzr.1'])]
583
713
 
584
714
    # std setup