← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to setup.py

(vila) Revise legal option names to be less drastic. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
9
9
import os
10
10
import os.path
11
11
import sys
 
12
import copy
 
13
import glob
12
14
 
13
 
if sys.version_info < (2, 4):
14
 
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.4+\n")
 
15
if sys.version_info < (2, 6):
 
16
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.6+\n")
15
17
    sys.exit(1)
16
18
 
17
19
# NOTE: The directory containing setup.py, whether run by 'python setup.py' or
37
39
    'version':      bzrlib.__version__,
38
40
    'author':       'Canonical Ltd',
39
41
    'author_email': 'bazaar@lists.canonical.com',
40
 
    'url':          'http://www.bazaar.canonical.com/',
 
42
    'url':          'http://bazaar.canonical.com/',
41
43
    'description':  'Friendly distributed version control system',
42
44
    'license':      'GNU GPL v2',
43
45
    'download_url': 'https://launchpad.net/bzr/+download',
65
67
            'package_data': {'bzrlib': ['doc/api/*.txt',
66
68
                                        'tests/test_patches_data/*',
67
69
                                        'help_topics/en/*.txt',
 
70
                                        'tests/ssl_certs/ca.crt',
68
71
                                        'tests/ssl_certs/server_without_pass.key',
69
72
                                        'tests/ssl_certs/server_with_pass.key',
70
 
                                        'tests/ssl_certs/server.crt'
 
73
                                        'tests/ssl_certs/server.crt',
71
74
                                       ]},
72
75
           }
73
 
 
 
76
I18N_FILES = []
 
77
for filepath in glob.glob("bzrlib/locale/*/LC_MESSAGES/*.mo"):
 
78
    langfile = filepath[len("bzrlib/locale/"):]
 
79
    targetpath = os.path.dirname(os.path.join("share/locale", langfile))
 
80
    I18N_FILES.append((targetpath, [filepath]))
74
81
 
75
82
def get_bzrlib_packages():
76
83
    """Recurse through the bzrlib directory, and extract the package names"""
98
105
 
99
106
from distutils import log
100
107
from distutils.core import setup
 
108
from distutils.version import LooseVersion
101
109
from distutils.command.install_scripts import install_scripts
102
110
from distutils.command.install_data import install_data
103
111
from distutils.command.build import build
125
133
                f = file(batch_path, "w")
126
134
                f.write(batch_str)
127
135
                f.close()
128
 
                print "Created:", batch_path
129
 
            except Exception, e:
130
 
                print "ERROR: Unable to create %s: %s" % (batch_path, e)
 
136
                print("Created: %s" % batch_path)
 
137
            except Exception:
 
138
                e = sys.exc_info()[1]
 
139
                print("ERROR: Unable to create %s: %s" % (batch_path, e))
131
140
 
132
141
    def _quoted_path(self, path):
133
142
        if ' ' in path:
149
158
    Generate bzr.1.
150
159
    """
151
160
 
 
161
    sub_commands = build.sub_commands + [
 
162
            ('build_mo', lambda _: True),
 
163
            ]
 
164
 
152
165
    def run(self):
153
166
        build.run(self)
154
167
 
160
173
## Setup
161
174
########################
162
175
 
 
176
from bzrlib.bzr_distutils import build_mo
 
177
 
163
178
command_classes = {'install_scripts': my_install_scripts,
164
 
                   'build': bzr_build}
 
179
                   'build': bzr_build,
 
180
                   'build_mo': build_mo,
 
181
                   }
165
182
from distutils import log
166
183
from distutils.errors import CCompilerError, DistutilsPlatformError
167
184
from distutils.extension import Extension
168
185
ext_modules = []
169
186
try:
170
187
    try:
 
188
        from Cython.Distutils import build_ext
 
189
        from Cython.Compiler.Version import version as pyrex_version
 
190
    except ImportError:
 
191
        print("No Cython, trying Pyrex...")
171
192
        from Pyrex.Distutils import build_ext
172
193
        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
177
194
except ImportError:
178
195
    have_pyrex = False
179
196
    # try to build the extension from the prior generated source.
180
 
    print
181
 
    print ("The python package 'Pyrex' is not available."
182
 
           " If the .c files are available,")
183
 
    print ("they will be built,"
184
 
           " but modifying the .pyx files will not rebuild them.")
185
 
    print
 
197
    print("")
 
198
    print("The python package 'Pyrex' is not available."
 
199
          " If the .c files are available,")
 
200
    print("they will be built,"
 
201
          " but modifying the .pyx files will not rebuild them.")
 
202
    print("")
186
203
    from distutils.command.build_ext import build_ext
187
204
else:
188
205
    have_pyrex = True
 
206
    pyrex_version_info = LooseVersion(pyrex_version)
189
207
 
190
208
 
191
209
class build_ext_if_possible(build_ext):
203
221
    def run(self):
204
222
        try:
205
223
            build_ext.run(self)
206
 
        except DistutilsPlatformError, e:
 
224
        except DistutilsPlatformError:
 
225
            e = sys.exc_info()[1]
207
226
            if not self.allow_python_fallback:
208
227
                log.warn('\n  Cannot build extensions.\n'
209
228
                         '  Use "build_ext --allow-python-fallback" to use'
280
299
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
281
300
                        libraries=['Ws2_32'])
282
301
    add_pyrex_extension('bzrlib._walkdirs_win32')
283
 
    z_lib = 'zdll'
284
302
else:
285
 
    if have_pyrex and pyrex_version.startswith('0.9.4'):
 
303
    if have_pyrex and pyrex_version_info == LooseVersion("0.9.4.1"):
286
304
        # Pyrex 0.9.4.1 fails to compile this extension correctly
287
305
        # The code it generates re-uses a "local" pointer and
288
306
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
289
307
        # which is NULL safe with PY_DECREF which is not.)
290
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/449372>
291
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/276868>
292
 
        print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
293
 
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
294
 
            pyrex_version,)
295
 
        print 'install. For now, the non-compiled (python) version will'
296
 
        print 'be used instead.'
 
308
        # <https://bugs.launchpad.net/bzr/+bug/449372>
 
309
        # <https://bugs.launchpad.net/bzr/+bug/276868>
 
310
        print('Cannot build extension "bzrlib._dirstate_helpers_pyx" using')
 
311
        print('your version of pyrex "%s". Please upgrade your pyrex'
 
312
              % (pyrex_version,))
 
313
        print('install. For now, the non-compiled (python) version will')
 
314
        print('be used instead.')
297
315
    else:
298
316
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
299
317
    add_pyrex_extension('bzrlib._readdir_pyx')
300
 
    z_lib = 'z'
301
 
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
 
318
add_pyrex_extension('bzrlib._chk_map_pyx')
302
319
ext_modules.append(Extension('bzrlib._patiencediff_c',
303
320
                             ['bzrlib/_patiencediff_c.c']))
304
 
add_pyrex_extension('bzrlib._simple_set_pyx')
305
 
ext_modules.append(Extension('bzrlib._static_tuple_c',
306
 
                             ['bzrlib/_static_tuple_c.c']))
 
321
if have_pyrex and pyrex_version_info < LooseVersion("0.9.6.3"):
 
322
    print("")
 
323
    print('Your Pyrex/Cython version %s is too old to build the simple_set' % (
 
324
        pyrex_version))
 
325
    print('and static_tuple extensions.')
 
326
    print('Please upgrade to at least Pyrex 0.9.6.3')
 
327
    print("")
 
328
    # TODO: Should this be a fatal error?
 
329
else:
 
330
    # We only need 0.9.6.3 to build _simple_set_pyx, but static_tuple depends
 
331
    # on simple_set
 
332
    add_pyrex_extension('bzrlib._simple_set_pyx')
 
333
    ext_modules.append(Extension('bzrlib._static_tuple_c',
 
334
                                 ['bzrlib/_static_tuple_c.c']))
307
335
add_pyrex_extension('bzrlib._btree_serializer_pyx')
308
336
 
309
337
 
310
338
if unavailable_files:
311
 
    print 'C extension(s) not found:'
312
 
    print '   %s' % ('\n  '.join(unavailable_files),)
313
 
    print 'The python versions will be used instead.'
314
 
    print
 
339
    print('C extension(s) not found:')
 
340
    print('   %s' % ('\n  '.join(unavailable_files),))
 
341
    print('The python versions will be used instead.')
 
342
    print("")
315
343
 
316
344
 
317
345
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
381
409
    # ditto for the tbzrcommand tool
382
410
    tbzrcommand = dict(
383
411
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
384
 
        icon_resources = [(0,'bzr.ico')],
 
412
        icon_resources = icon_resources,
 
413
        other_resources = other_resources,
385
414
    )
386
415
    console_targets.append(tbzrcommand)
387
416
    tbzrcommandw = tbzrcommand.copy()
401
430
 
402
431
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
403
432
    # PyQt4 itself still escapes the plugin detection code for some reason...
404
 
    packages.append('PyQt4')
405
 
    excludes.append('PyQt4.elementtree.ElementTree')
406
 
    excludes.append('PyQt4.uic.port_v3')
 
433
    includes.append('PyQt4.QtCore')
 
434
    includes.append('PyQt4.QtGui')
 
435
    includes.append('PyQt4.QtTest')
407
436
    includes.append('sip') # extension module required for Qt.
408
437
    packages.append('pygments') # colorizer for qbzr
409
438
    packages.append('docutils') # html formatting
410
439
    includes.append('win32event')  # for qsubprocess stuff
411
 
    # but we can avoid many Qt4 Dlls.
412
 
    dll_excludes.extend(
413
 
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
414
 
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
415
 
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
416
 
        qscintilla2.dll""".split())
417
440
    # the qt binaries might not be on PATH...
418
441
    # They seem to install to a place like C:\Python25\PyQt4\*
419
442
    # Which is not the same as C:\Python25\Lib\site-packages\PyQt4
458
481
 
459
482
def get_svn_py2exe_info(includes, excludes, packages):
460
483
    packages.append('subvertpy')
 
484
    packages.append('sqlite3')
 
485
 
 
486
 
 
487
def get_git_py2exe_info(includes, excludes, packages):
 
488
    packages.append('dulwich')
 
489
 
 
490
 
 
491
def get_fastimport_py2exe_info(includes, excludes, packages):
 
492
    # This is the python-fastimport package, not to be confused with the
 
493
    # bzr-fastimport plugin.
 
494
    packages.append('fastimport')
461
495
 
462
496
 
463
497
if 'bdist_wininst' in sys.argv:
484
518
            # help pages
485
519
            'data_files': find_docs(),
486
520
            # for building pyrex extensions
487
 
            'cmdclass': {'build_ext': build_ext_if_possible},
 
521
            'cmdclass': command_classes,
488
522
           }
489
523
 
490
524
    ARGS.update(META_INFO)
491
525
    ARGS.update(BZRLIB)
 
526
    PKG_DATA['package_data']['bzrlib'].append('locale/*/LC_MESSAGES/*.mo')
492
527
    ARGS.update(PKG_DATA)
493
 
    
 
528
 
494
529
    setup(**ARGS)
495
530
 
496
531
elif 'py2exe' in sys.argv:
497
 
    import glob
498
532
    # py2exe setup
499
533
    import py2exe
500
534
 
521
555
            install_data.run(self)
522
556
 
523
557
            py2exe = self.distribution.get_command_obj('py2exe', False)
524
 
            optimize = py2exe.optimize
 
558
            # GZ 2010-04-19: Setup has py2exe.optimize as 2, but give plugins
 
559
            #                time before living with docstring stripping
 
560
            optimize = 1
525
561
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
 
562
            # Round mtime to nearest even second so that installing on a FAT
 
563
            # filesystem bytecode internal and script timestamps will match
 
564
            for f in compile_names:
 
565
                mtime = os.stat(f).st_mtime
 
566
                remainder = mtime % 2
 
567
                if remainder:
 
568
                    mtime -= remainder
 
569
                    os.utime(f, (mtime, mtime))
526
570
            byte_compile(compile_names,
527
571
                         optimize=optimize,
528
572
                         force=self.force, prefix=self.install_dir,
529
573
                         dry_run=self.dry_run)
530
 
            if optimize:
531
 
                suffix = 'o'
532
 
            else:
533
 
                suffix = 'c'
534
 
            self.outfiles.extend([f + suffix for f in compile_names])
 
574
            self.outfiles.extend([f + 'o' for f in compile_names])
535
575
    # end of class install_data_with_bytecompile
536
576
 
537
577
    target = py2exe.build_exe.Target(script = "bzr",
541
581
                                     version = version_str,
542
582
                                     description = META_INFO['description'],
543
583
                                     author = META_INFO['author'],
544
 
                                     copyright = "(c) Canonical Ltd, 2005-2009",
 
584
                                     copyright = "(c) Canonical Ltd, 2005-2010",
545
585
                                     company_name = "Canonical Ltd.",
546
586
                                     comments = META_INFO['description'],
547
587
                                    )
 
588
    gui_target = copy.copy(target)
 
589
    gui_target.dest_base = "bzrw"
548
590
 
549
591
    packages = BZRLIB['packages']
550
592
    packages.remove('bzrlib')
560
602
    if sys.version.startswith('2.4'):
561
603
        # adding elementtree package
562
604
        additional_packages.add('elementtree')
563
 
    elif sys.version.startswith('2.5'):
 
605
    elif sys.version.startswith('2.6') or sys.version.startswith('2.5'):
564
606
        additional_packages.add('xml.etree')
565
607
    else:
566
608
        import warnings
612
654
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
613
655
        x = []
614
656
        for i in files:
615
 
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
 
657
            # Throw away files we don't want packaged. Note that plugins may
 
658
            # have data files with all sorts of extensions so we need to
 
659
            # be conservative here about what we ditch.
 
660
            ext = os.path.splitext(i)[1]
 
661
            if ext.endswith('~') or ext in [".pyc", ".swp"]:
616
662
                continue
617
663
            if i == '__init__.py' and root == 'bzrlib/plugins':
618
664
                continue
631
677
    console_targets = [target,
632
678
                       'tools/win32/bzr_postinstall.py',
633
679
                       ]
634
 
    gui_targets = []
635
 
    data_files = topics_files + plugins_files
 
680
    gui_targets = [gui_target]
 
681
    data_files = topics_files + plugins_files + I18N_FILES
636
682
 
637
683
    if 'qbzr' in plugins:
638
684
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
640
686
    if 'svn' in plugins:
641
687
        get_svn_py2exe_info(includes, excludes, packages)
642
688
 
 
689
    if 'git' in plugins:
 
690
        get_git_py2exe_info(includes, excludes, packages)
 
691
 
 
692
    if 'fastimport' in plugins:
 
693
        get_fastimport_py2exe_info(includes, excludes, packages)
 
694
 
643
695
    if "TBZR" in os.environ:
644
696
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
645
697
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
664
716
        # print this warning to stderr as output is redirected, so it is seen
665
717
        # at build time.  Also to stdout so it appears in the log
666
718
        for f in (sys.stderr, sys.stdout):
667
 
            print >> f, \
668
 
                "Skipping TBZR binaries - please set TBZR to a directory to enable"
 
719
            f.write("Skipping TBZR binaries - "
 
720
                "please set TBZR to a directory to enable\n")
669
721
 
670
722
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
671
723
    # in on Vista.
672
 
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
 
724
    dll_excludes.extend(["MSWSOCK.dll",
 
725
                         "MSVCP60.dll",
 
726
                         "MSVCP90.dll",
 
727
                         "powrprof.dll",
 
728
                         "SHFOLDER.dll"])
673
729
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
674
730
                               "includes": includes,
675
731
                               "excludes": excludes,
676
732
                               "dll_excludes": dll_excludes,
677
733
                               "dist_dir": "win32_bzr.exe",
678
 
                               "optimize": 1,
 
734
                               "optimize": 2,
 
735
                               "custom_boot_script":
 
736
                                        "tools/win32/py2exe_boot_common.py",
679
737
                              },
680
738
                   }
681
739
 
682
 
    setup(options=options_list,
683
 
          console=console_targets,
684
 
          windows=gui_targets,
685
 
          zipfile='lib/library.zip',
686
 
          data_files=data_files,
687
 
          cmdclass={'install_data': install_data_with_bytecompile},
688
 
          )
 
740
    # We want the libaray.zip to have optimize = 2, but the exe to have
 
741
    # optimize = 1, so that .py files that get compilied at run time
 
742
    # (e.g. user installed plugins) dont have their doc strings removed.
 
743
    class py2exe_no_oo_exe(py2exe.build_exe.py2exe):
 
744
        def build_executable(self, *args, **kwargs):
 
745
            self.optimize = 1
 
746
            py2exe.build_exe.py2exe.build_executable(self, *args, **kwargs)
 
747
            self.optimize = 2
 
748
 
 
749
    if __name__ == '__main__':
 
750
        command_classes['install_data'] = install_data_with_bytecompile
 
751
        command_classes['py2exe'] = py2exe_no_oo_exe
 
752
        setup(options=options_list,
 
753
              console=console_targets,
 
754
              windows=gui_targets,
 
755
              zipfile='lib/library.zip',
 
756
              data_files=data_files,
 
757
              cmdclass=command_classes,
 
758
              )
689
759
 
690
760
else:
691
761
    # ad-hoc for easy_install
695
765
        # easy_install one
696
766
        DATA_FILES = [('man/man1', ['bzr.1'])]
697
767
 
 
768
    DATA_FILES = DATA_FILES + I18N_FILES
698
769
    # std setup
699
770
    ARGS = {'scripts': ['bzr'],
700
771
            'data_files': DATA_FILES,
706
777
    ARGS.update(BZRLIB)
707
778
    ARGS.update(PKG_DATA)
708
779
 
709
 
    setup(**ARGS)
 
780
    if __name__ == '__main__':
 
781
        setup(**ARGS)