~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#! /usr/bin/env python
2
2
 
3
 
# This is an installation script for bzr.  Run it with
4
 
# './setup.py install', or
5
 
# './setup.py --help' for more options
6
 
 
 
3
"""Installation script for bzr.
 
4
Run it with
 
5
 './setup.py install', or
 
6
 './setup.py --help' for more options
 
7
"""
 
8
 
 
9
import os
 
10
import os.path
 
11
import sys
 
12
import copy
 
13
 
 
14
if sys.version_info < (2, 6):
 
15
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.6+\n")
 
16
    sys.exit(1)
 
17
 
 
18
# NOTE: The directory containing setup.py, whether run by 'python setup.py' or
 
19
# './setup.py' or the equivalent with another path, should always be at the
 
20
# start of the path, so this should find the right one...
 
21
import bzrlib
 
22
 
 
23
def get_long_description():
 
24
    dirname = os.path.dirname(__file__)
 
25
    readme = os.path.join(dirname, 'README')
 
26
    f = open(readme, 'rb')
 
27
    try:
 
28
        return f.read()
 
29
    finally:
 
30
        f.close()
 
31
 
 
32
 
 
33
##
 
34
# META INFORMATION FOR SETUP
 
35
# see http://docs.python.org/dist/meta-data.html
 
36
META_INFO = {
 
37
    'name':         'bzr',
 
38
    'version':      bzrlib.__version__,
 
39
    'author':       'Canonical Ltd',
 
40
    'author_email': 'bazaar@lists.canonical.com',
 
41
    'url':          'http://bazaar.canonical.com/',
 
42
    'description':  'Friendly distributed version control system',
 
43
    'license':      'GNU GPL v2',
 
44
    'download_url': 'https://launchpad.net/bzr/+download',
 
45
    'long_description': get_long_description(),
 
46
    'classifiers': [
 
47
        'Development Status :: 6 - Mature',
 
48
        'Environment :: Console',
 
49
        'Intended Audience :: Developers',
 
50
        'Intended Audience :: System Administrators',
 
51
        'License :: OSI Approved :: GNU General Public License (GPL)',
 
52
        'Operating System :: Microsoft :: Windows',
 
53
        'Operating System :: OS Independent',
 
54
        'Operating System :: POSIX',
 
55
        'Programming Language :: Python',
 
56
        'Programming Language :: C',
 
57
        'Topic :: Software Development :: Version Control',
 
58
        ],
 
59
    }
 
60
 
 
61
# The list of packages is automatically generated later. Add other things
 
62
# that are part of BZRLIB here.
 
63
BZRLIB = {}
 
64
 
 
65
PKG_DATA = {# install files from selftest suite
 
66
            'package_data': {'bzrlib': ['doc/api/*.txt',
 
67
                                        'tests/test_patches_data/*',
 
68
                                        'help_topics/en/*.txt',
 
69
                                        'tests/ssl_certs/ca.crt',
 
70
                                        'tests/ssl_certs/server_without_pass.key',
 
71
                                        'tests/ssl_certs/server_with_pass.key',
 
72
                                        'tests/ssl_certs/server.crt'
 
73
                                       ]},
 
74
           }
 
75
 
 
76
 
 
77
def get_bzrlib_packages():
 
78
    """Recurse through the bzrlib directory, and extract the package names"""
 
79
 
 
80
    packages = []
 
81
    base_path = os.path.dirname(os.path.abspath(bzrlib.__file__))
 
82
    for root, dirs, files in os.walk(base_path):
 
83
        if '__init__.py' in files:
 
84
            assert root.startswith(base_path)
 
85
            # Get just the path below bzrlib
 
86
            package_path = root[len(base_path):]
 
87
            # Remove leading and trailing slashes
 
88
            package_path = package_path.strip('\\/')
 
89
            if not package_path:
 
90
                package_name = 'bzrlib'
 
91
            else:
 
92
                package_name = ('bzrlib.' +
 
93
                            package_path.replace('/', '.').replace('\\', '.'))
 
94
            packages.append(package_name)
 
95
    return sorted(packages)
 
96
 
 
97
 
 
98
BZRLIB['packages'] = get_bzrlib_packages()
 
99
 
 
100
 
 
101
from distutils import log
7
102
from distutils.core import setup
8
 
 
9
 
setup(name='bzr',
10
 
      version='0.0.0',
11
 
      author='Martin Pool',
12
 
      author_email='mbp@sourcefrog.net',
13
 
      url='http://www.bazaar-ng.org/',
14
 
      description='Friendly distributed version control system',
15
 
      license='GNU GPL v2',
16
 
      packages=['bzrlib'],
17
 
      scripts=['bzr'])
 
103
from distutils.command.install_scripts import install_scripts
 
104
from distutils.command.install_data import install_data
 
105
from distutils.command.build import build
 
106
 
 
107
###############################
 
108
# Overridden distutils actions
 
109
###############################
 
110
 
 
111
class my_install_scripts(install_scripts):
 
112
    """ Customized install_scripts distutils action.
 
113
    Create bzr.bat for win32.
 
114
    """
 
115
    def run(self):
 
116
        install_scripts.run(self)   # standard action
 
117
 
 
118
        if sys.platform == "win32":
 
119
            try:
 
120
                scripts_dir = os.path.join(sys.prefix, 'Scripts')
 
121
                script_path = self._quoted_path(os.path.join(scripts_dir,
 
122
                                                             "bzr"))
 
123
                python_exe = self._quoted_path(sys.executable)
 
124
                args = self._win_batch_args()
 
125
                batch_str = "@%s %s %s" % (python_exe, script_path, args)
 
126
                batch_path = os.path.join(self.install_dir, "bzr.bat")
 
127
                f = file(batch_path, "w")
 
128
                f.write(batch_str)
 
129
                f.close()
 
130
                print("Created: %s" % batch_path)
 
131
            except Exception:
 
132
                e = sys.exc_info()[1]
 
133
                print("ERROR: Unable to create %s: %s" % (batch_path, e))
 
134
 
 
135
    def _quoted_path(self, path):
 
136
        if ' ' in path:
 
137
            return '"' + path + '"'
 
138
        else:
 
139
            return path
 
140
 
 
141
    def _win_batch_args(self):
 
142
        from bzrlib.win32utils import winver
 
143
        if winver == 'Windows NT':
 
144
            return '%*'
 
145
        else:
 
146
            return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
 
147
#/class my_install_scripts
 
148
 
 
149
 
 
150
class bzr_build(build):
 
151
    """Customized build distutils action.
 
152
    Generate bzr.1.
 
153
    """
 
154
 
 
155
    def run(self):
 
156
        build.run(self)
 
157
 
 
158
        from tools import generate_docs
 
159
        generate_docs.main(argv=["bzr", "man"])
 
160
 
 
161
 
 
162
########################
 
163
## Setup
 
164
########################
 
165
 
 
166
command_classes = {'install_scripts': my_install_scripts,
 
167
                   'build': bzr_build}
 
168
from distutils import log
 
169
from distutils.errors import CCompilerError, DistutilsPlatformError
 
170
from distutils.extension import Extension
 
171
ext_modules = []
 
172
try:
 
173
    try:
 
174
        from Pyrex.Distutils import build_ext
 
175
        from Pyrex.Compiler.Version import version as pyrex_version
 
176
    except ImportError:
 
177
        print("No Pyrex, trying Cython...")
 
178
        from Cython.Distutils import build_ext
 
179
        from Cython.Compiler.Version import version as pyrex_version
 
180
except ImportError:
 
181
    have_pyrex = False
 
182
    # try to build the extension from the prior generated source.
 
183
    print("")
 
184
    print("The python package 'Pyrex' is not available."
 
185
          " If the .c files are available,")
 
186
    print("they will be built,"
 
187
          " but modifying the .pyx files will not rebuild them.")
 
188
    print("")
 
189
    from distutils.command.build_ext import build_ext
 
190
else:
 
191
    have_pyrex = True
 
192
    pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
 
193
 
 
194
 
 
195
class build_ext_if_possible(build_ext):
 
196
 
 
197
    user_options = build_ext.user_options + [
 
198
        ('allow-python-fallback', None,
 
199
         "When an extension cannot be built, allow falling"
 
200
         " back to the pure-python implementation.")
 
201
        ]
 
202
 
 
203
    def initialize_options(self):
 
204
        build_ext.initialize_options(self)
 
205
        self.allow_python_fallback = False
 
206
 
 
207
    def run(self):
 
208
        try:
 
209
            build_ext.run(self)
 
210
        except DistutilsPlatformError:
 
211
            e = sys.exc_info()[1]
 
212
            if not self.allow_python_fallback:
 
213
                log.warn('\n  Cannot build extensions.\n'
 
214
                         '  Use "build_ext --allow-python-fallback" to use'
 
215
                         ' slower python implementations instead.\n')
 
216
                raise
 
217
            log.warn(str(e))
 
218
            log.warn('\n  Extensions cannot be built.\n'
 
219
                     '  Using the slower Python implementations instead.\n')
 
220
 
 
221
    def build_extension(self, ext):
 
222
        try:
 
223
            build_ext.build_extension(self, ext)
 
224
        except CCompilerError:
 
225
            if not self.allow_python_fallback:
 
226
                log.warn('\n  Cannot build extension "%s".\n'
 
227
                         '  Use "build_ext --allow-python-fallback" to use'
 
228
                         ' slower python implementations instead.\n'
 
229
                         % (ext.name,))
 
230
                raise
 
231
            log.warn('\n  Building of "%s" extension failed.\n'
 
232
                     '  Using the slower Python implementation instead.'
 
233
                     % (ext.name,))
 
234
 
 
235
 
 
236
# Override the build_ext if we have Pyrex available
 
237
command_classes['build_ext'] = build_ext_if_possible
 
238
unavailable_files = []
 
239
 
 
240
 
 
241
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
 
242
    """Add a pyrex module to build.
 
243
 
 
244
    This will use Pyrex to auto-generate the .c file if it is available.
 
245
    Otherwise it will fall back on the .c file. If the .c file is not
 
246
    available, it will warn, and not add anything.
 
247
 
 
248
    You can pass any extra options to Extension through kwargs. One example is
 
249
    'libraries = []'.
 
250
 
 
251
    :param module_name: The python path to the module. This will be used to
 
252
        determine the .pyx and .c files to use.
 
253
    """
 
254
    path = module_name.replace('.', '/')
 
255
    pyrex_name = path + '.pyx'
 
256
    c_name = path + '.c'
 
257
    define_macros = []
 
258
    if sys.platform == 'win32':
 
259
        # pyrex uses the macro WIN32 to detect the platform, even though it
 
260
        # should be using something like _WIN32 or MS_WINDOWS, oh well, we can
 
261
        # give it the right value.
 
262
        define_macros.append(('WIN32', None))
 
263
    if have_pyrex:
 
264
        source = [pyrex_name]
 
265
    else:
 
266
        if not os.path.isfile(c_name):
 
267
            unavailable_files.append(c_name)
 
268
            return
 
269
        else:
 
270
            source = [c_name]
 
271
    source.extend(extra_source)
 
272
    ext_modules.append(Extension(module_name, source,
 
273
        define_macros=define_macros, libraries=libraries))
 
274
 
 
275
 
 
276
add_pyrex_extension('bzrlib._annotator_pyx')
 
277
add_pyrex_extension('bzrlib._bencode_pyx')
 
278
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
 
279
add_pyrex_extension('bzrlib._groupcompress_pyx',
 
280
                    extra_source=['bzrlib/diff-delta.c'])
 
281
add_pyrex_extension('bzrlib._knit_load_data_pyx')
 
282
add_pyrex_extension('bzrlib._known_graph_pyx')
 
283
add_pyrex_extension('bzrlib._rio_pyx')
 
284
if sys.platform == 'win32':
 
285
    add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
 
286
                        libraries=['Ws2_32'])
 
287
    add_pyrex_extension('bzrlib._walkdirs_win32')
 
288
else:
 
289
    if have_pyrex and pyrex_version_info[:3] == (0,9,4):
 
290
        # Pyrex 0.9.4.1 fails to compile this extension correctly
 
291
        # The code it generates re-uses a "local" pointer and
 
292
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
 
293
        # which is NULL safe with PY_DECREF which is not.)
 
294
        # <https://bugs.launchpad.net/bzr/+bug/449372>
 
295
        # <https://bugs.launchpad.net/bzr/+bug/276868>
 
296
        print('Cannot build extension "bzrlib._dirstate_helpers_pyx" using')
 
297
        print('your version of pyrex "%s". Please upgrade your pyrex'
 
298
              % (pyrex_version,))
 
299
        print('install. For now, the non-compiled (python) version will')
 
300
        print('be used instead.')
 
301
    else:
 
302
        add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
 
303
    add_pyrex_extension('bzrlib._readdir_pyx')
 
304
add_pyrex_extension('bzrlib._chk_map_pyx')
 
305
ext_modules.append(Extension('bzrlib._patiencediff_c',
 
306
                             ['bzrlib/_patiencediff_c.c']))
 
307
if have_pyrex and pyrex_version_info < (0, 9, 6, 3):
 
308
    print("")
 
309
    print('Your Pyrex/Cython version %s is too old to build the simple_set' % (
 
310
        pyrex_version))
 
311
    print('and static_tuple extensions.')
 
312
    print('Please upgrade to at least Pyrex 0.9.6.3')
 
313
    print("")
 
314
    # TODO: Should this be a fatal error?
 
315
else:
 
316
    # We only need 0.9.6.3 to build _simple_set_pyx, but static_tuple depends
 
317
    # on simple_set
 
318
    add_pyrex_extension('bzrlib._simple_set_pyx')
 
319
    ext_modules.append(Extension('bzrlib._static_tuple_c',
 
320
                                 ['bzrlib/_static_tuple_c.c']))
 
321
add_pyrex_extension('bzrlib._btree_serializer_pyx')
 
322
 
 
323
 
 
324
if unavailable_files:
 
325
    print('C extension(s) not found:')
 
326
    print('   %s' % ('\n  '.join(unavailable_files),))
 
327
    print('The python versions will be used instead.')
 
328
    print("")
 
329
 
 
330
 
 
331
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
 
332
                         gui_targets, data_files):
 
333
    packages.append('tbzrcommands')
 
334
 
 
335
    # ModuleFinder can't handle runtime changes to __path__, but
 
336
    # win32com uses them.  Hook this in so win32com.shell is found.
 
337
    import modulefinder
 
338
    import win32com
 
339
    import cPickle as pickle
 
340
    for p in win32com.__path__[1:]:
 
341
        modulefinder.AddPackagePath("win32com", p)
 
342
    for extra in ["win32com.shell"]:
 
343
        __import__(extra)
 
344
        m = sys.modules[extra]
 
345
        for p in m.__path__[1:]:
 
346
            modulefinder.AddPackagePath(extra, p)
 
347
 
 
348
    # TBZR points to the TBZR directory
 
349
    tbzr_root = os.environ["TBZR"]
 
350
 
 
351
    # Ensure tbzrlib itself is on sys.path
 
352
    sys.path.append(tbzr_root)
 
353
 
 
354
    packages.append("tbzrlib")
 
355
 
 
356
    # collect up our icons.
 
357
    cwd = os.getcwd()
 
358
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
 
359
    icos = [] # list of (path_root, relative_ico_path)
 
360
    # First always bzr's icon and its in the root of the bzr tree.
 
361
    icos.append(('', 'bzr.ico'))
 
362
    for root, dirs, files in os.walk(ico_root):
 
363
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
 
364
                     for f in files if f.endswith('.ico')])
 
365
    # allocate an icon ID for each file and the full path to the ico
 
366
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
 
367
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
 
368
    # create a string resource with the mapping.  Might as well save the
 
369
    # runtime some effort and write a pickle.
 
370
    # Runtime expects unicode objects with forward-slash seps.
 
371
    fse = sys.getfilesystemencoding()
 
372
    map_items = [(f.replace('\\', '/').decode(fse), rid)
 
373
                 for rid, (_, f) in enumerate(icos)]
 
374
    ico_map = dict(map_items)
 
375
    # Create a new resource type of 'ICON_MAP', and use ID=1
 
376
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
 
377
 
 
378
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
 
379
                       win32ui crawler.Crawler""".split())
 
380
 
 
381
    # tbzrcache executables - a "console" version for debugging and a
 
382
    # GUI version that is generally used.
 
383
    tbzrcache = dict(
 
384
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
 
385
        icon_resources = icon_resources,
 
386
        other_resources = other_resources,
 
387
    )
 
388
    console_targets.append(tbzrcache)
 
389
 
 
390
    # Make a windows version which is the same except for the base name.
 
391
    tbzrcachew = tbzrcache.copy()
 
392
    tbzrcachew["dest_base"]="tbzrcachew"
 
393
    gui_targets.append(tbzrcachew)
 
394
 
 
395
    # ditto for the tbzrcommand tool
 
396
    tbzrcommand = dict(
 
397
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
 
398
        icon_resources = icon_resources,
 
399
        other_resources = other_resources,
 
400
    )
 
401
    console_targets.append(tbzrcommand)
 
402
    tbzrcommandw = tbzrcommand.copy()
 
403
    tbzrcommandw["dest_base"]="tbzrcommandw"
 
404
    gui_targets.append(tbzrcommandw)
 
405
    
 
406
    # A utility to see python output from both C++ and Python based shell
 
407
    # extensions
 
408
    tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
 
409
    console_targets.append(tracer)
 
410
 
 
411
    # The C++ implemented shell extensions.
 
412
    dist_dir = os.path.join(tbzr_root, "shellext", "build")
 
413
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
 
414
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
 
415
 
 
416
 
 
417
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
 
418
    # PyQt4 itself still escapes the plugin detection code for some reason...
 
419
    includes.append('PyQt4.QtCore')
 
420
    includes.append('PyQt4.QtGui')
 
421
    includes.append('sip') # extension module required for Qt.
 
422
    packages.append('pygments') # colorizer for qbzr
 
423
    packages.append('docutils') # html formatting
 
424
    includes.append('win32event')  # for qsubprocess stuff
 
425
    # the qt binaries might not be on PATH...
 
426
    # They seem to install to a place like C:\Python25\PyQt4\*
 
427
    # Which is not the same as C:\Python25\Lib\site-packages\PyQt4
 
428
    pyqt_dir = os.path.join(sys.prefix, "PyQt4")
 
429
    pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
 
430
    if os.path.isdir(pyqt_bin_dir):
 
431
        path = os.environ.get("PATH", "")
 
432
        if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
 
433
            os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
 
434
    # also add all imageformat plugins to distribution
 
435
    # We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
 
436
    base_dirs_to_check = []
 
437
    if os.path.isdir(pyqt_dir):
 
438
        base_dirs_to_check.append(pyqt_dir)
 
439
    try:
 
440
        import PyQt4
 
441
    except ImportError:
 
442
        pass
 
443
    else:
 
444
        pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
 
445
        if pyqt4_base_dir != pyqt_dir:
 
446
            base_dirs_to_check.append(pyqt4_base_dir)
 
447
    if not base_dirs_to_check:
 
448
        log.warn("Can't find PyQt4 installation -> not including imageformat"
 
449
                 " plugins")
 
450
    else:
 
451
        files = []
 
452
        for base_dir in base_dirs_to_check:
 
453
            plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
 
454
            if os.path.isdir(plug_dir):
 
455
                for fname in os.listdir(plug_dir):
 
456
                    # Include plugin dlls, but not debugging dlls
 
457
                    fullpath = os.path.join(plug_dir, fname)
 
458
                    if fname.endswith('.dll') and not fname.endswith('d4.dll'):
 
459
                        files.append(fullpath)
 
460
        if files:
 
461
            data_files.append(('imageformats', files))
 
462
        else:
 
463
            log.warn('PyQt4 was found, but we could not find any imageformat'
 
464
                     ' plugins. Are you sure your configuration is correct?')
 
465
 
 
466
 
 
467
def get_svn_py2exe_info(includes, excludes, packages):
 
468
    packages.append('subvertpy')
 
469
    packages.append('sqlite3')
 
470
 
 
471
 
 
472
if 'bdist_wininst' in sys.argv:
 
473
    def find_docs():
 
474
        docs = []
 
475
        for root, dirs, files in os.walk('doc'):
 
476
            r = []
 
477
            for f in files:
 
478
                if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
 
479
                    or f == 'quick-start-summary.svg'):
 
480
                    r.append(os.path.join(root, f))
 
481
            if r:
 
482
                relative = root[4:]
 
483
                if relative:
 
484
                    target = os.path.join('Doc\\Bazaar', relative)
 
485
                else:
 
486
                    target = 'Doc\\Bazaar'
 
487
                docs.append((target, r))
 
488
        return docs
 
489
 
 
490
    # python's distutils-based win32 installer
 
491
    ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
 
492
            'ext_modules': ext_modules,
 
493
            # help pages
 
494
            'data_files': find_docs(),
 
495
            # for building pyrex extensions
 
496
            'cmdclass': {'build_ext': build_ext_if_possible},
 
497
           }
 
498
 
 
499
    ARGS.update(META_INFO)
 
500
    ARGS.update(BZRLIB)
 
501
    ARGS.update(PKG_DATA)
 
502
    
 
503
    setup(**ARGS)
 
504
 
 
505
elif 'py2exe' in sys.argv:
 
506
    import glob
 
507
    # py2exe setup
 
508
    import py2exe
 
509
 
 
510
    # pick real bzr version
 
511
    import bzrlib
 
512
 
 
513
    version_number = []
 
514
    for i in bzrlib.version_info[:4]:
 
515
        try:
 
516
            i = int(i)
 
517
        except ValueError:
 
518
            i = 0
 
519
        version_number.append(str(i))
 
520
    version_str = '.'.join(version_number)
 
521
 
 
522
    # An override to install_data used only by py2exe builds, which arranges
 
523
    # to byte-compile any .py files in data_files (eg, our plugins)
 
524
    # Necessary as we can't rely on the user having the relevant permissions
 
525
    # to the "Program Files" directory to generate them on the fly.
 
526
    class install_data_with_bytecompile(install_data):
 
527
        def run(self):
 
528
            from distutils.util import byte_compile
 
529
 
 
530
            install_data.run(self)
 
531
 
 
532
            py2exe = self.distribution.get_command_obj('py2exe', False)
 
533
            # GZ 2010-04-19: Setup has py2exe.optimize as 2, but give plugins
 
534
            #                time before living with docstring stripping
 
535
            optimize = 1
 
536
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
 
537
            # Round mtime to nearest even second so that installing on a FAT
 
538
            # filesystem bytecode internal and script timestamps will match
 
539
            for f in compile_names:
 
540
                mtime = os.stat(f).st_mtime
 
541
                remainder = mtime % 2
 
542
                if remainder:
 
543
                    mtime -= remainder
 
544
                    os.utime(f, (mtime, mtime))
 
545
            byte_compile(compile_names,
 
546
                         optimize=optimize,
 
547
                         force=self.force, prefix=self.install_dir,
 
548
                         dry_run=self.dry_run)
 
549
            self.outfiles.extend([f + 'o' for f in compile_names])
 
550
    # end of class install_data_with_bytecompile
 
551
 
 
552
    target = py2exe.build_exe.Target(script = "bzr",
 
553
                                     dest_base = "bzr",
 
554
                                     icon_resources = [(0,'bzr.ico')],
 
555
                                     name = META_INFO['name'],
 
556
                                     version = version_str,
 
557
                                     description = META_INFO['description'],
 
558
                                     author = META_INFO['author'],
 
559
                                     copyright = "(c) Canonical Ltd, 2005-2010",
 
560
                                     company_name = "Canonical Ltd.",
 
561
                                     comments = META_INFO['description'],
 
562
                                    )
 
563
    gui_target = copy.copy(target)
 
564
    gui_target.dest_base = "bzrw"
 
565
 
 
566
    packages = BZRLIB['packages']
 
567
    packages.remove('bzrlib')
 
568
    packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
 
569
    includes = []
 
570
    for i in glob.glob('bzrlib\\*.py'):
 
571
        module = i[:-3].replace('\\', '.')
 
572
        if module.endswith('__init__'):
 
573
            module = module[:-len('__init__')]
 
574
        includes.append(module)
 
575
 
 
576
    additional_packages = set()
 
577
    if sys.version.startswith('2.4'):
 
578
        # adding elementtree package
 
579
        additional_packages.add('elementtree')
 
580
    elif sys.version.startswith('2.6') or sys.version.startswith('2.5'):
 
581
        additional_packages.add('xml.etree')
 
582
    else:
 
583
        import warnings
 
584
        warnings.warn('Unknown Python version.\n'
 
585
                      'Please check setup.py script for compatibility.')
 
586
 
 
587
    # Although we currently can't enforce it, we consider it an error for
 
588
    # py2exe to report any files are "missing".  Such modules we know aren't
 
589
    # used should be listed here.
 
590
    excludes = """Tkinter psyco ElementPath r_hmac
 
591
                  ImaginaryModule cElementTree elementtree.ElementTree
 
592
                  Crypto.PublicKey._fastmath
 
593
                  medusa medusa.filesys medusa.ftp_server
 
594
                  tools
 
595
                  resource validate""".split()
 
596
    dll_excludes = []
 
597
 
 
598
    # email package from std python library use lazy import,
 
599
    # so we need to explicitly add all package
 
600
    additional_packages.add('email')
 
601
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
 
602
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
 
603
    # to exclude them.
 
604
    import email
 
605
    for oldname in getattr(email, '_LOWERNAMES', []):
 
606
        excludes.append("email." + oldname)
 
607
    for oldname in getattr(email, '_MIMENAMES', []):
 
608
        excludes.append("email.MIME" + oldname)
 
609
 
 
610
    # text files for help topis
 
611
    text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
 
612
    topics_files = [('lib/help_topics/en', text_topics)]
 
613
 
 
614
    # built-in plugins
 
615
    plugins_files = []
 
616
    # XXX - should we consider having the concept of an 'official' build,
 
617
    # which hard-codes the list of plugins, gets more upset if modules are
 
618
    # missing, etc?
 
619
    plugins = None # will be a set after plugin sniffing...
 
620
    for root, dirs, files in os.walk('bzrlib/plugins'):
 
621
        if root == 'bzrlib/plugins':
 
622
            plugins = set(dirs)
 
623
            # We ship plugins as normal files on the file-system - however,
 
624
            # the build process can cause *some* of these plugin files to end
 
625
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
 
626
            # library.zip, and then saw import errors related to that as the
 
627
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
 
628
            # plugins out of the .zip file
 
629
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
 
630
        x = []
 
631
        for i in files:
 
632
            # Throw away files we don't want packaged. Note that plugins may
 
633
            # have data files with all sorts of extensions so we need to
 
634
            # be conservative here about what we ditch.
 
635
            ext = os.path.splitext(i)[1]
 
636
            if ext.endswith('~') or ext in [".pyc", ".swp"]:
 
637
                continue
 
638
            if i == '__init__.py' and root == 'bzrlib/plugins':
 
639
                continue
 
640
            x.append(os.path.join(root, i))
 
641
        if x:
 
642
            target_dir = root[len('bzrlib/'):]  # install to 'plugins/...'
 
643
            plugins_files.append((target_dir, x))
 
644
    # find modules for built-in plugins
 
645
    import tools.package_mf
 
646
    mf = tools.package_mf.CustomModuleFinder()
 
647
    mf.run_package('bzrlib/plugins')
 
648
    packs, mods = mf.get_result()
 
649
    additional_packages.update(packs)
 
650
    includes.extend(mods)
 
651
 
 
652
    console_targets = [target,
 
653
                       'tools/win32/bzr_postinstall.py',
 
654
                       ]
 
655
    gui_targets = [gui_target]
 
656
    data_files = topics_files + plugins_files
 
657
 
 
658
    if 'qbzr' in plugins:
 
659
        get_qbzr_py2exe_info(includes, excludes, packages, data_files)
 
660
 
 
661
    if 'svn' in plugins:
 
662
        get_svn_py2exe_info(includes, excludes, packages)
 
663
 
 
664
    if "TBZR" in os.environ:
 
665
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
 
666
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
 
667
        # can be downloaded from (username=guest, blank password):
 
668
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
 
669
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
 
670
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
 
671
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
 
672
                       'TORTOISE_OVERLAYS_MSI_X64'):
 
673
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
 
674
                   '/TortoiseOverlays')
 
675
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
 
676
                raise RuntimeError(
 
677
                    "\nPlease set %s to the location of the relevant"
 
678
                    "\nTortoiseOverlays .msi installer file."
 
679
                    " The installers can be found at"
 
680
                    "\n  %s"
 
681
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
 
682
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
 
683
                             gui_targets, data_files)
 
684
    else:
 
685
        # print this warning to stderr as output is redirected, so it is seen
 
686
        # at build time.  Also to stdout so it appears in the log
 
687
        for f in (sys.stderr, sys.stdout):
 
688
            f.write("Skipping TBZR binaries - "
 
689
                "please set TBZR to a directory to enable\n")
 
690
 
 
691
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
 
692
    # in on Vista.
 
693
    dll_excludes.extend(["MSWSOCK.dll",
 
694
                         "MSVCP60.dll",
 
695
                         "MSVCP90.dll",
 
696
                         "powrprof.dll",
 
697
                         "SHFOLDER.dll"])
 
698
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
 
699
                               "includes": includes,
 
700
                               "excludes": excludes,
 
701
                               "dll_excludes": dll_excludes,
 
702
                               "dist_dir": "win32_bzr.exe",
 
703
                               "optimize": 2,
 
704
                               "custom_boot_script":
 
705
                                        "tools/win32/py2exe_boot_common.py",
 
706
                              },
 
707
                   }
 
708
 
 
709
    # We want the libaray.zip to have optimize = 2, but the exe to have
 
710
    # optimize = 1, so that .py files that get compilied at run time
 
711
    # (e.g. user installed plugins) dont have their doc strings removed.
 
712
    class py2exe_no_oo_exe(py2exe.build_exe.py2exe):
 
713
        def build_executable(self, *args, **kwargs):
 
714
            self.optimize = 1
 
715
            py2exe.build_exe.py2exe.build_executable(self, *args, **kwargs)
 
716
            self.optimize = 2
 
717
 
 
718
    if __name__ == '__main__':
 
719
        setup(options=options_list,
 
720
              console=console_targets,
 
721
              windows=gui_targets,
 
722
              zipfile='lib/library.zip',
 
723
              data_files=data_files,
 
724
              cmdclass={'install_data': install_data_with_bytecompile,
 
725
                        'py2exe': py2exe_no_oo_exe},
 
726
              )
 
727
 
 
728
else:
 
729
    # ad-hoc for easy_install
 
730
    DATA_FILES = []
 
731
    if not 'bdist_egg' in sys.argv:
 
732
        # generate and install bzr.1 only with plain install, not the
 
733
        # easy_install one
 
734
        DATA_FILES = [('man/man1', ['bzr.1'])]
 
735
 
 
736
    # std setup
 
737
    ARGS = {'scripts': ['bzr'],
 
738
            'data_files': DATA_FILES,
 
739
            'cmdclass': command_classes,
 
740
            'ext_modules': ext_modules,
 
741
           }
 
742
 
 
743
    ARGS.update(META_INFO)
 
744
    ARGS.update(BZRLIB)
 
745
    ARGS.update(PKG_DATA)
 
746
 
 
747
    if __name__ == '__main__':
 
748
        setup(**ARGS)