/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
37
37
    'version':      bzrlib.__version__,
38
38
    'author':       'Canonical Ltd',
39
39
    'author_email': 'bazaar@lists.canonical.com',
40
 
    'url':          'http://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
148
144
    """Customized build distutils action.
149
145
    Generate bzr.1.
150
146
    """
151
 
 
152
147
    def run(self):
153
148
        build.run(self)
154
149
 
155
 
        from tools import generate_docs
 
150
        import generate_docs
156
151
        generate_docs.main(argv=["bzr", "man"])
157
152
 
158
153
 
167
162
from distutils.extension import Extension
168
163
ext_modules = []
169
164
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
 
165
    from Pyrex.Distutils import build_ext
177
166
except ImportError:
178
167
    have_pyrex = False
179
168
    # try to build the extension from the prior generated source.
186
175
    from distutils.command.build_ext import build_ext
187
176
else:
188
177
    have_pyrex = True
189
 
    pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
 
178
    from Pyrex.Compiler.Version import version as pyrex_version
190
179
 
191
180
 
192
181
class build_ext_if_possible(build_ext):
193
182
 
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
 
 
204
183
    def run(self):
205
184
        try:
206
185
            build_ext.run(self)
207
186
        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
213
187
            log.warn(str(e))
214
 
            log.warn('\n  Extensions cannot be built.\n'
215
 
                     '  Using the slower Python implementations instead.\n')
 
188
            log.warn('Extensions cannot be built, '
 
189
                     'will use the Python versions instead')
216
190
 
217
191
    def build_extension(self, ext):
218
192
        try:
219
193
            build_ext.build_extension(self, ext)
220
194
        except CCompilerError:
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,))
 
195
            log.warn('Building of "%s" extension failed, '
 
196
                     'will use the Python version instead' % (ext.name,))
230
197
 
231
198
 
232
199
# Override the build_ext if we have Pyrex available
234
201
unavailable_files = []
235
202
 
236
203
 
237
 
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
 
204
def add_pyrex_extension(module_name, **kwargs):
238
205
    """Add a pyrex module to build.
239
206
 
240
207
    This will use Pyrex to auto-generate the .c file if it is available.
250
217
    path = module_name.replace('.', '/')
251
218
    pyrex_name = path + '.pyx'
252
219
    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))
259
220
    if have_pyrex:
260
 
        source = [pyrex_name]
 
221
        ext_modules.append(Extension(module_name, [pyrex_name], **kwargs))
261
222
    else:
262
223
        if not os.path.isfile(c_name):
263
224
            unavailable_files.append(c_name)
264
 
            return
265
225
        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')
 
226
            ext_modules.append(Extension(module_name, [c_name], **kwargs))
 
227
 
 
228
 
 
229
add_pyrex_extension('bzrlib._btree_serializer_c')
 
230
add_pyrex_extension('bzrlib._knit_load_data_c')
280
231
if sys.platform == 'win32':
281
 
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
282
 
                        libraries=['Ws2_32'])
283
 
    add_pyrex_extension('bzrlib._walkdirs_win32')
284
 
    z_lib = 'zdll'
 
232
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
 
233
                         libraries=['Ws2_32']
 
234
                       )
 
235
    # pyrex uses the macro WIN32 to detect the platform, even though it should
 
236
    # be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
 
237
    # right value.
 
238
    add_pyrex_extension('bzrlib._walkdirs_win32',
 
239
                        define_macros=[('WIN32', None)])
285
240
else:
286
 
    if have_pyrex and pyrex_version_info[:3] == (0,9,4):
 
241
    if have_pyrex and pyrex_version == '0.9.4.1':
287
242
        # Pyrex 0.9.4.1 fails to compile this extension correctly
288
243
        # The code it generates re-uses a "local" pointer and
289
244
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
290
245
        # 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'
 
246
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
294
247
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
295
248
            pyrex_version,)
296
249
        print 'install. For now, the non-compiled (python) version will'
297
250
        print 'be used instead.'
298
251
    else:
299
 
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
 
252
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
300
253
    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')
 
254
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
320
255
 
321
256
 
322
257
if unavailable_files:
327
262
 
328
263
 
329
264
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
330
 
                         gui_targets, data_files):
 
265
                         gui_targets):
331
266
    packages.append('tbzrcommands')
332
267
 
333
268
    # ModuleFinder can't handle runtime changes to __path__, but
349
284
    # Ensure tbzrlib itself is on sys.path
350
285
    sys.path.append(tbzr_root)
351
286
 
 
287
    # Ensure our COM "entry-point" is on sys.path
 
288
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
 
289
 
352
290
    packages.append("tbzrlib")
353
291
 
354
292
    # collect up our icons.
376
314
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
377
315
                       win32ui crawler.Crawler""".split())
378
316
 
 
317
    tbzr = dict(
 
318
        modules=["tbzr"],
 
319
        create_exe = False, # we only want a .dll
 
320
    )
 
321
    com_targets.append(tbzr)
 
322
 
379
323
    # tbzrcache executables - a "console" version for debugging and a
380
324
    # GUI version that is generally used.
381
325
    tbzrcache = dict(
382
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
 
326
        script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
383
327
        icon_resources = icon_resources,
384
328
        other_resources = other_resources,
385
329
    )
392
336
 
393
337
    # ditto for the tbzrcommand tool
394
338
    tbzrcommand = dict(
395
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
 
339
        script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
396
340
        icon_resources = [(0,'bzr.ico')],
397
341
    )
398
342
    console_targets.append(tbzrcommand)
400
344
    tbzrcommandw["dest_base"]="tbzrcommandw"
401
345
    gui_targets.append(tbzrcommandw)
402
346
    
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"))
 
347
    # tbzr tests
 
348
    tbzrtest = dict(
 
349
        script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
 
350
    )
 
351
    console_targets.append(tbzrtest)
 
352
 
 
353
    # A utility to see python output from the shell extension - this will
 
354
    # die when we get a c++ extension
 
355
    # any .py file from pywin32's win32 lib will do (other than
 
356
    # win32traceutil itself that is)
 
357
    import winerror
 
358
    win32_lib_dir = os.path.dirname(winerror.__file__)
 
359
    tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
 
360
                  dest_base="tbzr_tracer")
406
361
    console_targets.append(tracer)
407
362
 
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):
 
363
 
 
364
def get_qbzr_py2exe_info(includes, excludes, packages):
415
365
    # PyQt4 itself still escapes the plugin detection code for some reason...
416
366
    packages.append('PyQt4')
417
367
    excludes.append('PyQt4.elementtree.ElementTree')
418
 
    excludes.append('PyQt4.uic.port_v3')
419
368
    includes.append('sip') # extension module required for Qt.
420
369
    packages.append('pygments') # colorizer for qbzr
421
370
    packages.append('docutils') # html formatting
422
 
    includes.append('win32event')  # for qsubprocess stuff
423
371
    # but we can avoid many Qt4 Dlls.
424
372
    dll_excludes.extend(
425
373
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
427
375
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
428
376
        qscintilla2.dll""".split())
429
377
    # 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')
473
 
    packages.append('sqlite3')
 
378
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
 
379
    path = os.environ.get("PATH","")
 
380
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
381
        os.environ["PATH"] = path + os.pathsep + qt_dir
474
382
 
475
383
 
476
384
if 'bdist_wininst' in sys.argv:
554
462
                                     version = version_str,
555
463
                                     description = META_INFO['description'],
556
464
                                     author = META_INFO['author'],
557
 
                                     copyright = "(c) Canonical Ltd, 2005-2010",
 
465
                                     copyright = "(c) Canonical Ltd, 2005-2007",
558
466
                                     company_name = "Canonical Ltd.",
559
467
                                     comments = META_INFO['description'],
560
468
                                    )
573
481
    if sys.version.startswith('2.4'):
574
482
        # adding elementtree package
575
483
        additional_packages.add('elementtree')
576
 
    elif sys.version.startswith('2.6') or sys.version.startswith('2.5'):
 
484
    elif sys.version.startswith('2.5'):
577
485
        additional_packages.add('xml.etree')
578
486
    else:
579
487
        import warnings
587
495
                  ImaginaryModule cElementTree elementtree.ElementTree
588
496
                  Crypto.PublicKey._fastmath
589
497
                  medusa medusa.filesys medusa.ftp_server
590
 
                  tools
 
498
                  tools tools.doc_generate
591
499
                  resource validate""".split()
592
500
    dll_excludes = []
593
501
 
616
524
    for root, dirs, files in os.walk('bzrlib/plugins'):
617
525
        if root == 'bzrlib/plugins':
618
526
            plugins = set(dirs)
619
 
            # We ship plugins as normal files on the file-system - however,
620
 
            # the build process can cause *some* of these plugin files to end
621
 
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
622
 
            # library.zip, and then saw import errors related to that as the
623
 
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
624
 
            # plugins out of the .zip file
625
 
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
626
527
        x = []
627
528
        for i in files:
628
 
            # Throw away files we don't want packaged. Note that plugins may
629
 
            # have data files with all sorts of extensions so we need to
630
 
            # be conservative here about what we ditch.
631
 
            ext = os.path.splitext(i)[1]
632
 
            if ext.endswith('~') or ext in [".pyc", ".swp"]:
 
529
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
633
530
                continue
634
531
            if i == '__init__.py' and root == 'bzrlib/plugins':
635
532
                continue
649
546
                       'tools/win32/bzr_postinstall.py',
650
547
                       ]
651
548
    gui_targets = []
652
 
    data_files = topics_files + plugins_files
 
549
    com_targets = []
653
550
 
654
551
    if 'qbzr' in plugins:
655
 
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
656
 
 
657
 
    if 'svn' in plugins:
658
 
        get_svn_py2exe_info(includes, excludes, packages)
 
552
        get_qbzr_py2exe_info(includes, excludes, packages)
659
553
 
660
554
    if "TBZR" in os.environ:
661
555
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
662
556
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
663
557
        # can be downloaded from (username=guest, blank password):
664
 
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
665
 
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
666
 
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
667
 
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
668
 
                       'TORTOISE_OVERLAYS_MSI_X64'):
669
 
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
670
 
                   '/TortoiseOverlays')
671
 
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
672
 
                raise RuntimeError(
673
 
                    "\nPlease set %s to the location of the relevant"
674
 
                    "\nTortoiseOverlays .msi installer file."
675
 
                    " The installers can be found at"
676
 
                    "\n  %s"
677
 
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
 
558
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
 
559
        if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
 
560
                                             '<nofile>')):
 
561
            raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
 
562
                               " location of the Win32 TortoiseOverlays .msi"
 
563
                               " installer file")
678
564
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
679
 
                             gui_targets, data_files)
 
565
                             gui_targets)
680
566
    else:
681
567
        # print this warning to stderr as output is redirected, so it is seen
682
568
        # at build time.  Also to stdout so it appears in the log
686
572
 
687
573
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
688
574
    # in on Vista.
689
 
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
 
575
    dll_excludes.append("MSWSOCK.dll")
690
576
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
691
577
                               "includes": includes,
692
578
                               "excludes": excludes,
699
585
    setup(options=options_list,
700
586
          console=console_targets,
701
587
          windows=gui_targets,
 
588
          com_server=com_targets,
702
589
          zipfile='lib/library.zip',
703
 
          data_files=data_files,
 
590
          data_files=topics_files + plugins_files,
704
591
          cmdclass={'install_data': install_data_with_bytecompile},
705
592
          )
706
593
 
708
595
    # ad-hoc for easy_install
709
596
    DATA_FILES = []
710
597
    if not 'bdist_egg' in sys.argv:
711
 
        # generate and install bzr.1 only with plain install, not the
712
 
        # easy_install one
 
598
        # generate and install bzr.1 only with plain install, not easy_install one
713
599
        DATA_FILES = [('man/man1', ['bzr.1'])]
714
600
 
715
 
    if sys.platform != 'win32':
716
 
        # see https://wiki.kubuntu.org/Apport/DeveloperHowTo
717
 
        #
718
 
        # checking the paths and hardcoding the check for root is a bit gross,
719
 
        # but I don't see a cleaner way to find out the locations in a way
720
 
        # that's going to align with the hardcoded paths in apport.
721
 
        if os.geteuid() == 0:
722
 
            DATA_FILES += [
723
 
                ('/usr/share/apport/package-hooks',
724
 
                    ['apport/source_bzr.py']),
725
 
                ('/etc/apport/crashdb.conf.d/',
726
 
                    ['apport/bzr-crashdb.conf']),]
727
 
 
728
601
    # std setup
729
602
    ARGS = {'scripts': ['bzr'],
730
603
            'data_files': DATA_FILES,