← 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: 2008-11-25 17:15:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3851.
  • Revision ID: john@arbash-meinel.com-20081125171526-pi2g4m1w70pkie1f
Add a bit of help text when supplying --help.

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.canonical.com/',
 
40
    'url':          'http://www.bazaar-vcs.org/',
41
41
    'description':  'Friendly distributed version control system',
42
42
    'license':      'GNU GPL v2',
43
 
    'download_url': 'https://launchpad.net/bzr/+download',
 
43
    'download_url': 'http://bazaar-vcs.org/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'
71
68
                                       ]},
72
69
           }
73
70
 
96
93
BZRLIB['packages'] = get_bzrlib_packages()
97
94
 
98
95
 
99
 
from distutils import log
100
96
from distutils.core import setup
101
97
from distutils.command.install_scripts import install_scripts
102
98
from distutils.command.install_data import install_data
152
148
    def run(self):
153
149
        build.run(self)
154
150
 
155
 
        from tools import generate_docs
 
151
        import generate_docs
156
152
        generate_docs.main(argv=["bzr", "man"])
157
153
 
158
154
 
167
163
from distutils.extension import Extension
168
164
ext_modules = []
169
165
try:
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
    from Pyrex.Distutils import build_ext
177
167
except ImportError:
178
168
    have_pyrex = False
179
169
    # try to build the extension from the prior generated source.
186
176
    from distutils.command.build_ext import build_ext
187
177
else:
188
178
    have_pyrex = True
189
 
    pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
 
179
    from Pyrex.Compiler.Version import version as pyrex_version
190
180
 
191
181
 
192
182
class build_ext_if_possible(build_ext):
207
197
        except DistutilsPlatformError, e:
208
198
            if not self.allow_python_fallback:
209
199
                log.warn('\n  Cannot build extensions.\n'
210
 
                         '  Use "build_ext --allow-python-fallback" to use'
211
 
                         ' slower python implementations instead.\n')
 
200
                         '  Use --allow-python-fallback to use slower'
 
201
                         ' python implementations instead.\n')
212
202
                raise
213
203
            log.warn(str(e))
214
204
            log.warn('\n  Extensions cannot be built.\n'
219
209
            build_ext.build_extension(self, ext)
220
210
        except CCompilerError:
221
211
            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'
 
212
                log.warn('\n  Failed to build "%s".\n'
 
213
                         '  Use --allow-python-fallback to use slower'
 
214
                         ' python implementations instead.\n'
225
215
                         % (ext.name,))
226
216
                raise
227
217
            log.warn('\n  Building of "%s" extension failed.\n'
234
224
unavailable_files = []
235
225
 
236
226
 
237
 
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
 
227
def add_pyrex_extension(module_name, libraries=None):
238
228
    """Add a pyrex module to build.
239
229
 
240
230
    This will use Pyrex to auto-generate the .c file if it is available.
252
242
    c_name = path + '.c'
253
243
    define_macros = []
254
244
    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.
 
245
        # pyrex uses the macro WIN32 to detect the platform, even though it should
 
246
        # be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
 
247
        # right value.
258
248
        define_macros.append(('WIN32', None))
259
249
    if have_pyrex:
260
 
        source = [pyrex_name]
 
250
        ext_modules.append(Extension(module_name, [pyrex_name],
 
251
            define_macros=define_macros, libraries=libraries))
261
252
    else:
262
253
        if not os.path.isfile(c_name):
263
254
            unavailable_files.append(c_name)
264
 
            return
265
255
        else:
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')
 
256
            ext_modules.append(Extension(module_name, [c_name],
 
257
                define_macros=define_macros, libraries=libraries))
 
258
 
 
259
 
 
260
add_pyrex_extension('bzrlib._btree_serializer_c')
 
261
add_pyrex_extension('bzrlib._knit_load_data_c')
280
262
if sys.platform == 'win32':
281
 
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
 
263
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
282
264
                        libraries=['Ws2_32'])
283
265
    add_pyrex_extension('bzrlib._walkdirs_win32')
284
 
    z_lib = 'zdll'
285
266
else:
286
 
    if have_pyrex and pyrex_version_info[:3] == (0,9,4):
 
267
    if have_pyrex and pyrex_version == '0.9.4.1':
287
268
        # Pyrex 0.9.4.1 fails to compile this extension correctly
288
269
        # The code it generates re-uses a "local" pointer and
289
270
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
290
271
        # 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'
 
272
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
294
273
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
295
274
            pyrex_version,)
296
275
        print 'install. For now, the non-compiled (python) version will'
297
276
        print 'be used instead.'
298
277
    else:
299
 
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
 
278
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
300
279
    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')
 
280
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
320
281
 
321
282
 
322
283
if unavailable_files:
327
288
 
328
289
 
329
290
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
330
 
                         gui_targets, data_files):
 
291
                         gui_targets):
331
292
    packages.append('tbzrcommands')
332
293
 
333
294
    # ModuleFinder can't handle runtime changes to __path__, but
349
310
    # Ensure tbzrlib itself is on sys.path
350
311
    sys.path.append(tbzr_root)
351
312
 
 
313
    # Ensure our COM "entry-point" is on sys.path
 
314
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
 
315
 
352
316
    packages.append("tbzrlib")
353
317
 
354
318
    # collect up our icons.
376
340
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
377
341
                       win32ui crawler.Crawler""".split())
378
342
 
 
343
    tbzr = dict(
 
344
        modules=["tbzr"],
 
345
        create_exe = False, # we only want a .dll
 
346
    )
 
347
    com_targets.append(tbzr)
 
348
 
379
349
    # tbzrcache executables - a "console" version for debugging and a
380
350
    # GUI version that is generally used.
381
351
    tbzrcache = dict(
382
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
 
352
        script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
383
353
        icon_resources = icon_resources,
384
354
        other_resources = other_resources,
385
355
    )
392
362
 
393
363
    # ditto for the tbzrcommand tool
394
364
    tbzrcommand = dict(
395
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
 
365
        script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
396
366
        icon_resources = [(0,'bzr.ico')],
397
367
    )
398
368
    console_targets.append(tbzrcommand)
400
370
    tbzrcommandw["dest_base"]="tbzrcommandw"
401
371
    gui_targets.append(tbzrcommandw)
402
372
    
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"))
 
373
    # tbzr tests
 
374
    tbzrtest = dict(
 
375
        script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
 
376
    )
 
377
    console_targets.append(tbzrtest)
 
378
 
 
379
    # A utility to see python output from the shell extension - this will
 
380
    # die when we get a c++ extension
 
381
    # any .py file from pywin32's win32 lib will do (other than
 
382
    # win32traceutil itself that is)
 
383
    import winerror
 
384
    win32_lib_dir = os.path.dirname(winerror.__file__)
 
385
    tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
 
386
                  dest_base="tbzr_tracer")
406
387
    console_targets.append(tracer)
407
388
 
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):
 
389
 
 
390
def get_qbzr_py2exe_info(includes, excludes, packages):
415
391
    # PyQt4 itself still escapes the plugin detection code for some reason...
416
392
    packages.append('PyQt4')
417
393
    excludes.append('PyQt4.elementtree.ElementTree')
418
 
    excludes.append('PyQt4.uic.port_v3')
419
394
    includes.append('sip') # extension module required for Qt.
420
395
    packages.append('pygments') # colorizer for qbzr
421
396
    packages.append('docutils') # html formatting
422
 
    includes.append('win32event')  # for qsubprocess stuff
423
397
    # but we can avoid many Qt4 Dlls.
424
398
    dll_excludes.extend(
425
399
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
427
401
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
428
402
        qscintilla2.dll""".split())
429
403
    # the qt binaries might not be on PATH...
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')
 
404
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
 
405
    path = os.environ.get("PATH","")
 
406
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
407
        os.environ["PATH"] = path + os.pathsep + qt_dir
473
408
 
474
409
 
475
410
if 'bdist_wininst' in sys.argv:
553
488
                                     version = version_str,
554
489
                                     description = META_INFO['description'],
555
490
                                     author = META_INFO['author'],
556
 
                                     copyright = "(c) Canonical Ltd, 2005-2009",
 
491
                                     copyright = "(c) Canonical Ltd, 2005-2007",
557
492
                                     company_name = "Canonical Ltd.",
558
493
                                     comments = META_INFO['description'],
559
494
                                    )
586
521
                  ImaginaryModule cElementTree elementtree.ElementTree
587
522
                  Crypto.PublicKey._fastmath
588
523
                  medusa medusa.filesys medusa.ftp_server
589
 
                  tools
 
524
                  tools tools.doc_generate
590
525
                  resource validate""".split()
591
526
    dll_excludes = []
592
527
 
615
550
    for root, dirs, files in os.walk('bzrlib/plugins'):
616
551
        if root == 'bzrlib/plugins':
617
552
            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])
625
553
        x = []
626
554
        for i in files:
627
555
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
644
572
                       'tools/win32/bzr_postinstall.py',
645
573
                       ]
646
574
    gui_targets = []
647
 
    data_files = topics_files + plugins_files
 
575
    com_targets = []
648
576
 
649
577
    if 'qbzr' in plugins:
650
 
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
651
 
 
652
 
    if 'svn' in plugins:
653
 
        get_svn_py2exe_info(includes, excludes, packages)
 
578
        get_qbzr_py2exe_info(includes, excludes, packages)
654
579
 
655
580
    if "TBZR" in os.environ:
656
581
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
657
582
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
658
583
        # can be downloaded from (username=guest, blank password):
659
 
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
660
 
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
661
 
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
662
 
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
663
 
                       'TORTOISE_OVERLAYS_MSI_X64'):
664
 
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
665
 
                   '/TortoiseOverlays')
666
 
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
667
 
                raise RuntimeError(
668
 
                    "\nPlease set %s to the location of the relevant"
669
 
                    "\nTortoiseOverlays .msi installer file."
670
 
                    " The installers can be found at"
671
 
                    "\n  %s"
672
 
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
 
584
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
 
585
        if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
 
586
                                             '<nofile>')):
 
587
            raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
 
588
                               " location of the Win32 TortoiseOverlays .msi"
 
589
                               " installer file")
673
590
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
674
 
                             gui_targets, data_files)
 
591
                             gui_targets)
675
592
    else:
676
593
        # print this warning to stderr as output is redirected, so it is seen
677
594
        # at build time.  Also to stdout so it appears in the log
681
598
 
682
599
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
683
600
    # in on Vista.
684
 
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
 
601
    dll_excludes.append("MSWSOCK.dll")
685
602
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
686
603
                               "includes": includes,
687
604
                               "excludes": excludes,
694
611
    setup(options=options_list,
695
612
          console=console_targets,
696
613
          windows=gui_targets,
 
614
          com_server=com_targets,
697
615
          zipfile='lib/library.zip',
698
 
          data_files=data_files,
 
616
          data_files=topics_files + plugins_files,
699
617
          cmdclass={'install_data': install_data_with_bytecompile},
700
618
          )
701
619
 
703
621
    # ad-hoc for easy_install
704
622
    DATA_FILES = []
705
623
    if not 'bdist_egg' in sys.argv:
706
 
        # generate and install bzr.1 only with plain install, not the
707
 
        # easy_install one
 
624
        # generate and install bzr.1 only with plain install, not easy_install one
708
625
        DATA_FILES = [('man/man1', ['bzr.1'])]
709
626
 
710
627
    # std setup