← 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-10-30 00:55:00 UTC
  • mto: (3815.2.5 prepare-1.9)
  • mto: This revision was merged to the branch mainline in revision 3811.
  • Revision ID: john@arbash-meinel.com-20081030005500-r5cej1cxflqhs3io
Switch so that we are using a simple timestamp as the first action.

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