← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: Vincent Ladeuil
  • Date: 2009-06-22 12:52:39 UTC
  • mto: (4471.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4472.
  • Revision ID: v.ladeuil+lp@free.fr-20090622125239-kabo9smxt9c3vnir
Use a consistent scheme for naming pyrex source files.

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 "build_ext --allow-python-fallback" to use'
 
201
                         ' slower 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  Cannot build extension "%s".\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,))
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, extra_source=[]):
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
 
246
        # should be using something like _WIN32 or MS_WINDOWS, oh well, we can
 
247
        # give it the right value.
 
248
        define_macros.append(('WIN32', None))
218
249
    if have_pyrex:
219
 
        ext_modules.append(Extension(module_name, [pyrex_name]))
 
250
        source = [pyrex_name]
220
251
    else:
221
252
        if not os.path.isfile(c_name):
222
253
            unavailable_files.append(c_name)
 
254
            return
223
255
        else:
224
 
            ext_modules.append(Extension(module_name, [c_name]))
225
 
 
226
 
 
227
 
add_pyrex_extension('bzrlib._dirstate_helpers_c')
228
 
add_pyrex_extension('bzrlib._knit_load_data_c')
229
 
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
 
256
            source = [c_name]
 
257
    source.extend(extra_source)
 
258
    ext_modules.append(Extension(module_name, source,
 
259
        define_macros=define_macros, libraries=libraries))
 
260
 
 
261
 
 
262
add_pyrex_extension('bzrlib._bencode_pyx')
 
263
add_pyrex_extension('bzrlib._btree_serializer_pyx')
 
264
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
 
265
add_pyrex_extension('bzrlib._groupcompress_pyx',
 
266
                    extra_source=['bzrlib/diff-delta.c'])
 
267
add_pyrex_extension('bzrlib._knit_load_data_pyx')
 
268
add_pyrex_extension('bzrlib._known_graph_pyx')
 
269
add_pyrex_extension('bzrlib._rio_pyx')
 
270
if sys.platform == 'win32':
 
271
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
 
272
                        libraries=['Ws2_32'])
 
273
    add_pyrex_extension('bzrlib._walkdirs_win32')
 
274
    z_lib = 'zdll'
 
275
else:
 
276
    if have_pyrex and pyrex_version == '0.9.4.1':
 
277
        # Pyrex 0.9.4.1 fails to compile this extension correctly
 
278
        # The code it generates re-uses a "local" pointer and
 
279
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
 
280
        # which is NULL safe with PY_DECREF which is not.)
 
281
        print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
 
282
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
 
283
            pyrex_version,)
 
284
        print 'install. For now, the non-compiled (python) version will'
 
285
        print 'be used instead.'
 
286
    else:
 
287
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
 
288
    add_pyrex_extension('bzrlib._readdir_pyx')
 
289
    z_lib = 'z'
 
290
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
 
291
ext_modules.append(Extension('bzrlib._patiencediff_c',
 
292
                             ['bzrlib/_patiencediff_c.c']))
230
293
 
231
294
 
232
295
if unavailable_files:
236
299
    print
237
300
 
238
301
 
 
302
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
 
303
                         gui_targets, data_files):
 
304
    packages.append('tbzrcommands')
 
305
 
 
306
    # ModuleFinder can't handle runtime changes to __path__, but
 
307
    # win32com uses them.  Hook this in so win32com.shell is found.
 
308
    import modulefinder
 
309
    import win32com
 
310
    import cPickle as pickle
 
311
    for p in win32com.__path__[1:]:
 
312
        modulefinder.AddPackagePath("win32com", p)
 
313
    for extra in ["win32com.shell"]:
 
314
        __import__(extra)
 
315
        m = sys.modules[extra]
 
316
        for p in m.__path__[1:]:
 
317
            modulefinder.AddPackagePath(extra, p)
 
318
 
 
319
    # TBZR points to the TBZR directory
 
320
    tbzr_root = os.environ["TBZR"]
 
321
 
 
322
    # Ensure tbzrlib itself is on sys.path
 
323
    sys.path.append(tbzr_root)
 
324
 
 
325
    # Ensure our COM "entry-point" is on sys.path
 
326
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
 
327
 
 
328
    packages.append("tbzrlib")
 
329
 
 
330
    # collect up our icons.
 
331
    cwd = os.getcwd()
 
332
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
 
333
    icos = [] # list of (path_root, relative_ico_path)
 
334
    # First always bzr's icon and its in the root of the bzr tree.
 
335
    icos.append(('', 'bzr.ico'))
 
336
    for root, dirs, files in os.walk(ico_root):
 
337
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
 
338
                     for f in files if f.endswith('.ico')])
 
339
    # allocate an icon ID for each file and the full path to the ico
 
340
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
 
341
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
 
342
    # create a string resource with the mapping.  Might as well save the
 
343
    # runtime some effort and write a pickle.
 
344
    # Runtime expects unicode objects with forward-slash seps.
 
345
    fse = sys.getfilesystemencoding()
 
346
    map_items = [(f.replace('\\', '/').decode(fse), rid)
 
347
                 for rid, (_, f) in enumerate(icos)]
 
348
    ico_map = dict(map_items)
 
349
    # Create a new resource type of 'ICON_MAP', and use ID=1
 
350
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
 
351
 
 
352
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
 
353
                       win32ui crawler.Crawler""".split())
 
354
 
 
355
    # NOTE: We still create a DLL version of the Python implemented shell
 
356
    # extension for testing purposes - but it is *not* registered by
 
357
    # default - our C++ one is instead.  To discourage people thinking
 
358
    # this DLL is still necessary, its called 'tbzr_old.dll'
 
359
    tbzr = dict(
 
360
        modules=["tbzr"],
 
361
        create_exe = False, # we only want a .dll
 
362
        dest_base = 'tbzr_old',
 
363
    )
 
364
    com_targets.append(tbzr)
 
365
 
 
366
    # tbzrcache executables - a "console" version for debugging and a
 
367
    # GUI version that is generally used.
 
368
    tbzrcache = dict(
 
369
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
 
370
        icon_resources = icon_resources,
 
371
        other_resources = other_resources,
 
372
    )
 
373
    console_targets.append(tbzrcache)
 
374
 
 
375
    # Make a windows version which is the same except for the base name.
 
376
    tbzrcachew = tbzrcache.copy()
 
377
    tbzrcachew["dest_base"]="tbzrcachew"
 
378
    gui_targets.append(tbzrcachew)
 
379
 
 
380
    # ditto for the tbzrcommand tool
 
381
    tbzrcommand = dict(
 
382
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
 
383
        icon_resources = [(0,'bzr.ico')],
 
384
    )
 
385
    console_targets.append(tbzrcommand)
 
386
    tbzrcommandw = tbzrcommand.copy()
 
387
    tbzrcommandw["dest_base"]="tbzrcommandw"
 
388
    gui_targets.append(tbzrcommandw)
 
389
    
 
390
    # A utility to see python output from both C++ and Python based shell
 
391
    # extensions
 
392
    tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
 
393
    console_targets.append(tracer)
 
394
 
 
395
    # The C++ implemented shell extensions.
 
396
    dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
 
397
                            "build", "dist")
 
398
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
 
399
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
 
400
 
 
401
 
 
402
def get_qbzr_py2exe_info(includes, excludes, packages):
 
403
    # PyQt4 itself still escapes the plugin detection code for some reason...
 
404
    packages.append('PyQt4')
 
405
    excludes.append('PyQt4.elementtree.ElementTree')
 
406
    includes.append('sip') # extension module required for Qt.
 
407
    packages.append('pygments') # colorizer for qbzr
 
408
    packages.append('docutils') # html formatting
 
409
    # but we can avoid many Qt4 Dlls.
 
410
    dll_excludes.extend(
 
411
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
 
412
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
 
413
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
 
414
        qscintilla2.dll""".split())
 
415
    # the qt binaries might not be on PATH...
 
416
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
 
417
    path = os.environ.get("PATH","")
 
418
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
419
        os.environ["PATH"] = path + os.pathsep + qt_dir
 
420
 
 
421
 
 
422
def get_svn_py2exe_info(includes, excludes, packages):
 
423
    packages.append('subvertpy')
 
424
 
 
425
 
239
426
if 'bdist_wininst' in sys.argv:
240
427
    def find_docs():
241
428
        docs = []
286
473
        version_number.append(str(i))
287
474
    version_str = '.'.join(version_number)
288
475
 
 
476
    # An override to install_data used only by py2exe builds, which arranges
 
477
    # to byte-compile any .py files in data_files (eg, our plugins)
 
478
    # Necessary as we can't rely on the user having the relevant permissions
 
479
    # to the "Program Files" directory to generate them on the fly.
 
480
    class install_data_with_bytecompile(install_data):
 
481
        def run(self):
 
482
            from distutils.util import byte_compile
 
483
 
 
484
            install_data.run(self)
 
485
 
 
486
            py2exe = self.distribution.get_command_obj('py2exe', False)
 
487
            optimize = py2exe.optimize
 
488
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
 
489
            byte_compile(compile_names,
 
490
                         optimize=optimize,
 
491
                         force=self.force, prefix=self.install_dir,
 
492
                         dry_run=self.dry_run)
 
493
            if optimize:
 
494
                suffix = 'o'
 
495
            else:
 
496
                suffix = 'c'
 
497
            self.outfiles.extend([f + suffix for f in compile_names])
 
498
    # end of class install_data_with_bytecompile
 
499
 
289
500
    target = py2exe.build_exe.Target(script = "bzr",
290
501
                                     dest_base = "bzr",
291
502
                                     icon_resources = [(0,'bzr.ico')],
318
529
        import warnings
319
530
        warnings.warn('Unknown Python version.\n'
320
531
                      'Please check setup.py script for compatibility.')
 
532
 
 
533
    # Although we currently can't enforce it, we consider it an error for
 
534
    # py2exe to report any files are "missing".  Such modules we know aren't
 
535
    # used should be listed here.
 
536
    excludes = """Tkinter psyco ElementPath r_hmac
 
537
                  ImaginaryModule cElementTree elementtree.ElementTree
 
538
                  Crypto.PublicKey._fastmath
 
539
                  medusa medusa.filesys medusa.ftp_server
 
540
                  tools tools.doc_generate
 
541
                  resource validate""".split()
 
542
    dll_excludes = []
 
543
 
321
544
    # email package from std python library use lazy import,
322
545
    # so we need to explicitly add all package
323
546
    additional_packages.add('email')
 
547
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
 
548
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
 
549
    # to exclude them.
 
550
    import email
 
551
    for oldname in getattr(email, '_LOWERNAMES', []):
 
552
        excludes.append("email." + oldname)
 
553
    for oldname in getattr(email, '_MIMENAMES', []):
 
554
        excludes.append("email.MIME" + oldname)
324
555
 
325
556
    # text files for help topis
326
557
    text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
328
559
 
329
560
    # built-in plugins
330
561
    plugins_files = []
 
562
    # XXX - should we consider having the concept of an 'official' build,
 
563
    # which hard-codes the list of plugins, gets more upset if modules are
 
564
    # missing, etc?
 
565
    plugins = None # will be a set after plugin sniffing...
331
566
    for root, dirs, files in os.walk('bzrlib/plugins'):
 
567
        if root == 'bzrlib/plugins':
 
568
            plugins = set(dirs)
 
569
            # We ship plugins as normal files on the file-system - however,
 
570
            # the build process can cause *some* of these plugin files to end
 
571
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
 
572
            # library.zip, and then saw import errors related to that as the
 
573
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
 
574
            # plugins out of the .zip file
 
575
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
332
576
        x = []
333
577
        for i in files:
334
 
            if not i.endswith('.py'):
 
578
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
335
579
                continue
336
580
            if i == '__init__.py' and root == 'bzrlib/plugins':
337
581
                continue
345
589
    mf.run_package('bzrlib/plugins')
346
590
    packs, mods = mf.get_result()
347
591
    additional_packages.update(packs)
348
 
 
 
592
    includes.extend(mods)
 
593
 
 
594
    console_targets = [target,
 
595
                       'tools/win32/bzr_postinstall.py',
 
596
                       ]
 
597
    gui_targets = []
 
598
    com_targets = []
 
599
    data_files = topics_files + plugins_files
 
600
 
 
601
    if 'qbzr' in plugins:
 
602
        get_qbzr_py2exe_info(includes, excludes, packages)
 
603
 
 
604
    if 'svn' in plugins:
 
605
        get_svn_py2exe_info(includes, excludes, packages)
 
606
 
 
607
    if "TBZR" in os.environ:
 
608
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
 
609
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
 
610
        # can be downloaded from (username=guest, blank password):
 
611
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
 
612
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
 
613
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
 
614
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
 
615
                       'TORTOISE_OVERLAYS_MSI_X64'):
 
616
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
 
617
                   '/TortoiseOverlays')
 
618
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
 
619
                raise RuntimeError(
 
620
                    "\nPlease set %s to the location of the relevant"
 
621
                    "\nTortoiseOverlays .msi installer file."
 
622
                    " The installers can be found at"
 
623
                    "\n  %s"
 
624
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
 
625
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
 
626
                             gui_targets, data_files)
 
627
    else:
 
628
        # print this warning to stderr as output is redirected, so it is seen
 
629
        # at build time.  Also to stdout so it appears in the log
 
630
        for f in (sys.stderr, sys.stdout):
 
631
            print >> f, \
 
632
                "Skipping TBZR binaries - please set TBZR to a directory to enable"
 
633
 
 
634
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
 
635
    # in on Vista.
 
636
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
349
637
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
350
 
                               "includes": includes + mods,
351
 
                               "excludes": ["Tkinter", "medusa", "tools"],
 
638
                               "includes": includes,
 
639
                               "excludes": excludes,
 
640
                               "dll_excludes": dll_excludes,
352
641
                               "dist_dir": "win32_bzr.exe",
 
642
                               "optimize": 1,
353
643
                              },
354
644
                   }
 
645
 
355
646
    setup(options=options_list,
356
 
          console=[target,
357
 
                   'tools/win32/bzr_postinstall.py',
358
 
                  ],
 
647
          console=console_targets,
 
648
          windows=gui_targets,
 
649
          com_server=com_targets,
359
650
          zipfile='lib/library.zip',
360
 
          data_files=topics_files + plugins_files,
 
651
          data_files=data_files,
 
652
          cmdclass={'install_data': install_data_with_bytecompile},
361
653
          )
362
654
 
363
655
else:
364
656
    # ad-hoc for easy_install
365
657
    DATA_FILES = []
366
658
    if not 'bdist_egg' in sys.argv:
367
 
        # generate and install bzr.1 only with plain install, not easy_install one
 
659
        # generate and install bzr.1 only with plain install, not the
 
660
        # easy_install one
368
661
        DATA_FILES = [('man/man1', ['bzr.1'])]
369
662
 
370
663
    # std setup