← 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-07-11 21:41:24 UTC
  • mto: This revision was merged to the branch mainline in revision 3543.
  • Revision ID: john@arbash-meinel.com-20080711214124-qi09irlj7pd5cuzg
Shortcut the case when one revision is in the ancestry of the other.

At the cost of a heads() check, when one parent supersedes, we don't have to extract
the text for the other. Changes merge time from 3m37s => 3m21s. Using a
CachingParentsProvider would drop the time down to 3m11s.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
95
95
 
96
96
from distutils.core import setup
97
97
from distutils.command.install_scripts import install_scripts
98
 
from distutils.command.install_data import install_data
99
98
from distutils.command.build import build
100
99
 
101
100
###############################
144
143
    """Customized build distutils action.
145
144
    Generate bzr.1.
146
145
    """
147
 
 
148
146
    def run(self):
149
147
        build.run(self)
150
148
 
176
174
    from distutils.command.build_ext import build_ext
177
175
else:
178
176
    have_pyrex = True
179
 
    from Pyrex.Compiler.Version import version as pyrex_version
180
177
 
181
178
 
182
179
class build_ext_if_possible(build_ext):
183
180
 
184
 
    user_options = build_ext.user_options + [
185
 
        ('allow-python-fallback', None,
186
 
         "When an extension cannot be built, allow falling"
187
 
         " back to the pure-python implementation.")
188
 
        ]
189
 
 
190
 
    def initialize_options(self):
191
 
        build_ext.initialize_options(self)
192
 
        self.allow_python_fallback = False
193
 
 
194
181
    def run(self):
195
182
        try:
196
183
            build_ext.run(self)
197
184
        except DistutilsPlatformError, e:
198
 
            if not self.allow_python_fallback:
199
 
                log.warn('\n  Cannot build extensions.\n'
200
 
                         '  Use "build_ext --allow-python-fallback" to use'
201
 
                         ' slower python implementations instead.\n')
202
 
                raise
203
185
            log.warn(str(e))
204
 
            log.warn('\n  Extensions cannot be built.\n'
205
 
                     '  Using the slower Python implementations instead.\n')
 
186
            log.warn('Extensions cannot be built, '
 
187
                     'will use the Python versions instead')
206
188
 
207
189
    def build_extension(self, ext):
208
190
        try:
209
191
            build_ext.build_extension(self, ext)
210
192
        except CCompilerError:
211
 
            if not self.allow_python_fallback:
212
 
                log.warn('\n  Cannot build extensions.\n'
213
 
                         '  Use "build_ext --allow-python-fallback" to use'
214
 
                         ' slower python implementations instead.\n'
215
 
                         % (ext.name,))
216
 
                raise
217
 
            log.warn('\n  Building of "%s" extension failed.\n'
218
 
                     '  Using the slower Python implementation instead.'
219
 
                     % (ext.name,))
 
193
            log.warn('Building of "%s" extension failed, '
 
194
                     'will use the Python version instead' % (ext.name,))
220
195
 
221
196
 
222
197
# Override the build_ext if we have Pyrex available
224
199
unavailable_files = []
225
200
 
226
201
 
227
 
def add_pyrex_extension(module_name, libraries=None):
 
202
def add_pyrex_extension(module_name, **kwargs):
228
203
    """Add a pyrex module to build.
229
204
 
230
205
    This will use Pyrex to auto-generate the .c file if it is available.
240
215
    path = module_name.replace('.', '/')
241
216
    pyrex_name = path + '.pyx'
242
217
    c_name = path + '.c'
243
 
    define_macros = []
244
 
    if sys.platform == 'win32':
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.
248
 
        define_macros.append(('WIN32', None))
249
218
    if have_pyrex:
250
 
        ext_modules.append(Extension(module_name, [pyrex_name],
251
 
            define_macros=define_macros, libraries=libraries))
 
219
        ext_modules.append(Extension(module_name, [pyrex_name]))
252
220
    else:
253
221
        if not os.path.isfile(c_name):
254
222
            unavailable_files.append(c_name)
255
223
        else:
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._chunks_to_lines_pyx')
 
224
            ext_modules.append(Extension(module_name, [c_name]))
 
225
 
 
226
 
 
227
add_pyrex_extension('bzrlib._dirstate_helpers_c')
262
228
add_pyrex_extension('bzrlib._knit_load_data_c')
263
 
if sys.platform == 'win32':
264
 
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
265
 
                        libraries=['Ws2_32'])
266
 
    add_pyrex_extension('bzrlib._walkdirs_win32')
267
 
else:
268
 
    if have_pyrex and pyrex_version == '0.9.4.1':
269
 
        # Pyrex 0.9.4.1 fails to compile this extension correctly
270
 
        # The code it generates re-uses a "local" pointer and
271
 
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
272
 
        # which is NULL safe with PY_DECREF which is not.)
273
 
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
274
 
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
275
 
            pyrex_version,)
276
 
        print 'install. For now, the non-compiled (python) version will'
277
 
        print 'be used instead.'
278
 
    else:
279
 
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
280
 
    add_pyrex_extension('bzrlib._readdir_pyx')
281
229
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
282
230
 
283
231
 
288
236
    print
289
237
 
290
238
 
291
 
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
292
 
                         gui_targets, data_files):
293
 
    packages.append('tbzrcommands')
294
 
 
295
 
    # ModuleFinder can't handle runtime changes to __path__, but
296
 
    # win32com uses them.  Hook this in so win32com.shell is found.
297
 
    import modulefinder
298
 
    import win32com
299
 
    import cPickle as pickle
300
 
    for p in win32com.__path__[1:]:
301
 
        modulefinder.AddPackagePath("win32com", p)
302
 
    for extra in ["win32com.shell"]:
303
 
        __import__(extra)
304
 
        m = sys.modules[extra]
305
 
        for p in m.__path__[1:]:
306
 
            modulefinder.AddPackagePath(extra, p)
307
 
 
308
 
    # TBZR points to the TBZR directory
309
 
    tbzr_root = os.environ["TBZR"]
310
 
 
311
 
    # Ensure tbzrlib itself is on sys.path
312
 
    sys.path.append(tbzr_root)
313
 
 
314
 
    # Ensure our COM "entry-point" is on sys.path
315
 
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
316
 
 
317
 
    packages.append("tbzrlib")
318
 
 
319
 
    # collect up our icons.
320
 
    cwd = os.getcwd()
321
 
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
322
 
    icos = [] # list of (path_root, relative_ico_path)
323
 
    # First always bzr's icon and its in the root of the bzr tree.
324
 
    icos.append(('', 'bzr.ico'))
325
 
    for root, dirs, files in os.walk(ico_root):
326
 
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
327
 
                     for f in files if f.endswith('.ico')])
328
 
    # allocate an icon ID for each file and the full path to the ico
329
 
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
330
 
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
331
 
    # create a string resource with the mapping.  Might as well save the
332
 
    # runtime some effort and write a pickle.
333
 
    # Runtime expects unicode objects with forward-slash seps.
334
 
    fse = sys.getfilesystemencoding()
335
 
    map_items = [(f.replace('\\', '/').decode(fse), rid)
336
 
                 for rid, (_, f) in enumerate(icos)]
337
 
    ico_map = dict(map_items)
338
 
    # Create a new resource type of 'ICON_MAP', and use ID=1
339
 
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
340
 
 
341
 
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
342
 
                       win32ui crawler.Crawler""".split())
343
 
 
344
 
    # NOTE: We still create a DLL version of the Python implemented shell
345
 
    # extension for testing purposes - but it is *not* registered by
346
 
    # default - our C++ one is instead.  To discourage people thinking
347
 
    # this DLL is still necessary, its called 'tbzr_old.dll'
348
 
    tbzr = dict(
349
 
        modules=["tbzr"],
350
 
        create_exe = False, # we only want a .dll
351
 
        dest_base = 'tbzr_old',
352
 
    )
353
 
    com_targets.append(tbzr)
354
 
 
355
 
    # tbzrcache executables - a "console" version for debugging and a
356
 
    # GUI version that is generally used.
357
 
    tbzrcache = dict(
358
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
359
 
        icon_resources = icon_resources,
360
 
        other_resources = other_resources,
361
 
    )
362
 
    console_targets.append(tbzrcache)
363
 
 
364
 
    # Make a windows version which is the same except for the base name.
365
 
    tbzrcachew = tbzrcache.copy()
366
 
    tbzrcachew["dest_base"]="tbzrcachew"
367
 
    gui_targets.append(tbzrcachew)
368
 
 
369
 
    # ditto for the tbzrcommand tool
370
 
    tbzrcommand = dict(
371
 
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
372
 
        icon_resources = [(0,'bzr.ico')],
373
 
    )
374
 
    console_targets.append(tbzrcommand)
375
 
    tbzrcommandw = tbzrcommand.copy()
376
 
    tbzrcommandw["dest_base"]="tbzrcommandw"
377
 
    gui_targets.append(tbzrcommandw)
378
 
    
379
 
    # A utility to see python output from both C++ and Python based shell
380
 
    # extensions
381
 
    tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
382
 
    console_targets.append(tracer)
383
 
 
384
 
    # The C++ implemented shell extensions.
385
 
    dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
386
 
                            "build", "dist")
387
 
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
388
 
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
389
 
 
390
 
 
391
 
def get_qbzr_py2exe_info(includes, excludes, packages):
392
 
    # PyQt4 itself still escapes the plugin detection code for some reason...
393
 
    packages.append('PyQt4')
394
 
    excludes.append('PyQt4.elementtree.ElementTree')
395
 
    includes.append('sip') # extension module required for Qt.
396
 
    packages.append('pygments') # colorizer for qbzr
397
 
    packages.append('docutils') # html formatting
398
 
    # but we can avoid many Qt4 Dlls.
399
 
    dll_excludes.extend(
400
 
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
401
 
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
402
 
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
403
 
        qscintilla2.dll""".split())
404
 
    # the qt binaries might not be on PATH...
405
 
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
406
 
    path = os.environ.get("PATH","")
407
 
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
408
 
        os.environ["PATH"] = path + os.pathsep + qt_dir
409
 
 
410
 
 
411
 
def get_svn_py2exe_info(includes, excludes, packages):
412
 
    packages.append('subvertpy')
413
 
 
414
 
 
415
239
if 'bdist_wininst' in sys.argv:
416
240
    def find_docs():
417
241
        docs = []
462
286
        version_number.append(str(i))
463
287
    version_str = '.'.join(version_number)
464
288
 
465
 
    # An override to install_data used only by py2exe builds, which arranges
466
 
    # to byte-compile any .py files in data_files (eg, our plugins)
467
 
    # Necessary as we can't rely on the user having the relevant permissions
468
 
    # to the "Program Files" directory to generate them on the fly.
469
 
    class install_data_with_bytecompile(install_data):
470
 
        def run(self):
471
 
            from distutils.util import byte_compile
472
 
 
473
 
            install_data.run(self)
474
 
 
475
 
            py2exe = self.distribution.get_command_obj('py2exe', False)
476
 
            optimize = py2exe.optimize
477
 
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
478
 
            byte_compile(compile_names,
479
 
                         optimize=optimize,
480
 
                         force=self.force, prefix=self.install_dir,
481
 
                         dry_run=self.dry_run)
482
 
            if optimize:
483
 
                suffix = 'o'
484
 
            else:
485
 
                suffix = 'c'
486
 
            self.outfiles.extend([f + suffix for f in compile_names])
487
 
    # end of class install_data_with_bytecompile
488
 
 
489
289
    target = py2exe.build_exe.Target(script = "bzr",
490
290
                                     dest_base = "bzr",
491
291
                                     icon_resources = [(0,'bzr.ico')],
518
318
        import warnings
519
319
        warnings.warn('Unknown Python version.\n'
520
320
                      'Please check setup.py script for compatibility.')
521
 
 
522
 
    # Although we currently can't enforce it, we consider it an error for
523
 
    # py2exe to report any files are "missing".  Such modules we know aren't
524
 
    # used should be listed here.
525
 
    excludes = """Tkinter psyco ElementPath r_hmac
526
 
                  ImaginaryModule cElementTree elementtree.ElementTree
527
 
                  Crypto.PublicKey._fastmath
528
 
                  medusa medusa.filesys medusa.ftp_server
529
 
                  tools tools.doc_generate
530
 
                  resource validate""".split()
531
 
    dll_excludes = []
532
 
 
533
321
    # email package from std python library use lazy import,
534
322
    # so we need to explicitly add all package
535
323
    additional_packages.add('email')
536
 
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
537
 
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
538
 
    # to exclude them.
539
 
    import email
540
 
    for oldname in getattr(email, '_LOWERNAMES', []):
541
 
        excludes.append("email." + oldname)
542
 
    for oldname in getattr(email, '_MIMENAMES', []):
543
 
        excludes.append("email.MIME" + oldname)
544
324
 
545
325
    # text files for help topis
546
326
    text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
548
328
 
549
329
    # built-in plugins
550
330
    plugins_files = []
551
 
    # XXX - should we consider having the concept of an 'official' build,
552
 
    # which hard-codes the list of plugins, gets more upset if modules are
553
 
    # missing, etc?
554
 
    plugins = None # will be a set after plugin sniffing...
555
331
    for root, dirs, files in os.walk('bzrlib/plugins'):
556
 
        if root == 'bzrlib/plugins':
557
 
            plugins = set(dirs)
558
 
            # We ship plugins as normal files on the file-system - however,
559
 
            # the build process can cause *some* of these plugin files to end
560
 
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
561
 
            # library.zip, and then saw import errors related to that as the
562
 
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
563
 
            # plugins out of the .zip file
564
 
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
565
332
        x = []
566
333
        for i in files:
567
 
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
 
334
            if not i.endswith('.py'):
568
335
                continue
569
336
            if i == '__init__.py' and root == 'bzrlib/plugins':
570
337
                continue
578
345
    mf.run_package('bzrlib/plugins')
579
346
    packs, mods = mf.get_result()
580
347
    additional_packages.update(packs)
581
 
    includes.extend(mods)
582
 
 
583
 
    console_targets = [target,
584
 
                       'tools/win32/bzr_postinstall.py',
585
 
                       ]
586
 
    gui_targets = []
587
 
    com_targets = []
588
 
    data_files = topics_files + plugins_files
589
 
 
590
 
    if 'qbzr' in plugins:
591
 
        get_qbzr_py2exe_info(includes, excludes, packages)
592
 
 
593
 
    if 'svn' in plugins:
594
 
        get_svn_py2exe_info(includes, excludes, packages)
595
 
 
596
 
    if "TBZR" in os.environ:
597
 
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
598
 
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
599
 
        # can be downloaded from (username=guest, blank password):
600
 
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
601
 
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
602
 
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
603
 
                       'TORTOISE_OVERLAYS_MSI_X64'):
604
 
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
605
 
                raise RuntimeError("Please set %s to the"
606
 
                                   " location of the relevant TortoiseOverlays"
607
 
                                   " .msi installer file" % needed)
608
 
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
609
 
                             gui_targets, data_files)
610
 
    else:
611
 
        # print this warning to stderr as output is redirected, so it is seen
612
 
        # at build time.  Also to stdout so it appears in the log
613
 
        for f in (sys.stderr, sys.stdout):
614
 
            print >> f, \
615
 
                "Skipping TBZR binaries - please set TBZR to a directory to enable"
616
 
 
617
 
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
618
 
    # in on Vista.
619
 
    dll_excludes.append("MSWSOCK.dll")
 
348
 
620
349
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
621
 
                               "includes": includes,
622
 
                               "excludes": excludes,
623
 
                               "dll_excludes": dll_excludes,
 
350
                               "includes": includes + mods,
 
351
                               "excludes": ["Tkinter", "medusa", "tools"],
624
352
                               "dist_dir": "win32_bzr.exe",
625
 
                               "optimize": 1,
626
353
                              },
627
354
                   }
628
 
 
629
355
    setup(options=options_list,
630
 
          console=console_targets,
631
 
          windows=gui_targets,
632
 
          com_server=com_targets,
 
356
          console=[target,
 
357
                   'tools/win32/bzr_postinstall.py',
 
358
                  ],
633
359
          zipfile='lib/library.zip',
634
 
          data_files=data_files,
635
 
          cmdclass={'install_data': install_data_with_bytecompile},
 
360
          data_files=topics_files + plugins_files,
636
361
          )
637
362
 
638
363
else: