~bzr-pqm/bzr/bzr.dev

45 by Martin Pool
- add setup.py and install instructions
1
#! /usr/bin/env python
2
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
3
"""Installation script for bzr.
4
Run it with
5
 './setup.py install', or
6
 './setup.py --help' for more options
7
"""
8
1930.3.1 by John Arbash Meinel
Change setup.py to auto-generate the list of packages to install
9
import os
3185.1.7 by Martin Pool
Always take README text from the right directory (thanks jam)
10
import os.path
1930.3.1 by John Arbash Meinel
Change setup.py to auto-generate the list of packages to install
11
import sys
12
3260.1.2 by Alexander Belchenko
use sys.version_info
13
if sys.version_info < (2, 4):
3260.1.1 by Alexander Belchenko
setup.py script explicitly checks for Python version. (#200569)
14
    sys.stderr.write("[ERROR] Not a supported Python version. Need 2.4+\n")
15
    sys.exit(1)
16
3185.1.7 by Martin Pool
Always take README text from the right directory (thanks jam)
17
# NOTE: The directory containing setup.py, whether run by 'python setup.py' or
18
# './setup.py' or the equivalent with another path, should always be at the
19
# start of the path, so this should find the right one...
1861.2.21 by Alexander Belchenko
setup.py: automatically grab version info from bzrlib
20
import bzrlib
21
3185.1.7 by Martin Pool
Always take README text from the right directory (thanks jam)
22
def get_long_description():
23
    dirname = os.path.dirname(__file__)
24
    readme = os.path.join(dirname, 'README')
25
    f = open(readme, 'rb')
26
    try:
27
        return f.read()
28
    finally:
29
        f.close()
30
31
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
32
##
33
# META INFORMATION FOR SETUP
3185.1.2 by Martin Pool
Add more metadata to setup.py (#183391)
34
# see http://docs.python.org/dist/meta-data.html
35
META_INFO = {
36
    'name':         'bzr',
37
    'version':      bzrlib.__version__,
38
    'author':       'Canonical Ltd',
39
    'author_email': 'bazaar@lists.canonical.com',
40
    'url':          'http://www.bazaar-vcs.org/',
41
    'description':  'Friendly distributed version control system',
42
    'license':      'GNU GPL v2',
43
    'download_url': 'http://bazaar-vcs.org/Download',
3185.1.7 by Martin Pool
Always take README text from the right directory (thanks jam)
44
    'long_description': get_long_description(),
3185.1.2 by Martin Pool
Add more metadata to setup.py (#183391)
45
    'classifiers': [
46
        'Development Status :: 6 - Mature',
47
        'Environment :: Console',
48
        'Intended Audience :: Developers',
49
        'Intended Audience :: System Administrators',
50
        'License :: OSI Approved :: GNU General Public License (GPL)',
51
        'Operating System :: Microsoft :: Windows',
52
        'Operating System :: OS Independent',
53
        'Operating System :: POSIX',
54
        'Programming Language :: Python',
55
        'Programming Language :: C',
56
        'Topic :: Software Development :: Version Control',
57
        ],
58
    }
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
59
1930.3.3 by John Arbash Meinel
Fix a stupid error in code declaration order
60
# The list of packages is automatically generated later. Add other things
61
# that are part of BZRLIB here.
62
BZRLIB = {}
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
63
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
64
PKG_DATA = {# install files from selftest suite
65
            'package_data': {'bzrlib': ['doc/api/*.txt',
66
                                        'tests/test_patches_data/*',
3089.3.6 by Ian Clatworthy
make help topics more discoverable
67
                                        'help_topics/en/*.txt',
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
68
                                       ]},
69
           }
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
70
1185.29.5 by Wouter van Heyst
Add reinvocation code to ensure setup.py is run by python2.4
71
1930.3.1 by John Arbash Meinel
Change setup.py to auto-generate the list of packages to install
72
def get_bzrlib_packages():
73
    """Recurse through the bzrlib directory, and extract the package names"""
74
75
    packages = []
76
    base_path = os.path.dirname(os.path.abspath(bzrlib.__file__))
77
    for root, dirs, files in os.walk(base_path):
78
        if '__init__.py' in files:
79
            assert root.startswith(base_path)
80
            # Get just the path below bzrlib
81
            package_path = root[len(base_path):]
82
            # Remove leading and trailing slashes
83
            package_path = package_path.strip('\\/')
84
            if not package_path:
85
                package_name = 'bzrlib'
86
            else:
87
                package_name = ('bzrlib.' +
88
                            package_path.replace('/', '.').replace('\\', '.'))
89
            packages.append(package_name)
90
    return sorted(packages)
91
92
1930.3.3 by John Arbash Meinel
Fix a stupid error in code declaration order
93
BZRLIB['packages'] = get_bzrlib_packages()
94
95
45 by Martin Pool
- add setup.py and install instructions
96
from distutils.core import setup
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
97
from distutils.command.install_scripts import install_scripts
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
98
from distutils.command.install_data import install_data
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
99
from distutils.command.build import build
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
100
101
###############################
102
# Overridden distutils actions
103
###############################
104
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
105
class my_install_scripts(install_scripts):
106
    """ Customized install_scripts distutils action.
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
107
    Create bzr.bat for win32.
108
    """
109
    def run(self):
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
110
        install_scripts.run(self)   # standard action
111
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
112
        if sys.platform == "win32":
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
113
            try:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
114
                scripts_dir = os.path.join(sys.prefix, 'Scripts')
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
115
                script_path = self._quoted_path(os.path.join(scripts_dir,
116
                                                             "bzr"))
117
                python_exe = self._quoted_path(sys.executable)
118
                args = self._win_batch_args()
119
                batch_str = "@%s %s %s" % (python_exe, script_path, args)
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
120
                batch_path = os.path.join(self.install_dir, "bzr.bat")
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
121
                f = file(batch_path, "w")
122
                f.write(batch_str)
123
                f.close()
124
                print "Created:", batch_path
125
            except Exception, e:
126
                print "ERROR: Unable to create %s: %s" % (batch_path, e)
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
127
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
128
    def _quoted_path(self, path):
129
        if ' ' in path:
130
            return '"' + path + '"'
131
        else:
132
            return path
133
134
    def _win_batch_args(self):
2245.4.4 by Alexander Belchenko
setup.py: fix plain 'python setup.py install' for win98
135
        from bzrlib.win32utils import winver
136
        if winver == 'Windows NT':
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
137
            return '%*'
138
        else:
139
            return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
140
#/class my_install_scripts
141
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
142
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
143
class bzr_build(build):
144
    """Customized build distutils action.
145
    Generate bzr.1.
146
    """
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
147
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
148
    def run(self):
149
        build.run(self)
150
1551.3.11 by Aaron Bentley
Merge from Robert
151
        import generate_docs
152
        generate_docs.main(argv=["bzr", "man"])
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
153
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
154
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
155
########################
156
## Setup
157
########################
158
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
159
command_classes = {'install_scripts': my_install_scripts,
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
160
                   'build': bzr_build}
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
161
from distutils import log
2814.4.2 by Alexander Belchenko
support for win32
162
from distutils.errors import CCompilerError, DistutilsPlatformError
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
163
from distutils.extension import Extension
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
164
ext_modules = []
165
try:
166
    from Pyrex.Distutils import build_ext
167
except ImportError:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
168
    have_pyrex = False
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
169
    # try to build the extension from the prior generated source.
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
170
    print
2617.1.2 by John Arbash Meinel
Try another form of comment
171
    print ("The python package 'Pyrex' is not available."
172
           " If the .c files are available,")
173
    print ("they will be built,"
174
           " but modifying the .pyx files will not rebuild them.")
2617.1.3 by John Arbash Meinel
Add another blank line to make it show up better
175
    print
1739.1.4 by Robert Collins
Fix building of C modules without pyrex installed.
176
    from distutils.command.build_ext import build_ext
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
177
else:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
178
    have_pyrex = True
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
179
    from Pyrex.Compiler.Version import version as pyrex_version
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
180
181
182
class build_ext_if_possible(build_ext):
183
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
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
2814.4.2 by Alexander Belchenko
support for win32
194
    def run(self):
195
        try:
196
            build_ext.run(self)
197
        except DistutilsPlatformError, e:
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
198
            if not self.allow_python_fallback:
199
                log.warn('\n  Cannot build extensions.\n'
3928.4.1 by John Arbash Meinel
Change the warning from setup.py to make it a bit more obvious how to install
200
                         '  Use "build_ext --allow-python-fallback" to use'
201
                         ' slower python implementations instead.\n')
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
202
                raise
2814.4.4 by Alexander Belchenko
changes suggested by Aaron and Martin
203
            log.warn(str(e))
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
204
            log.warn('\n  Extensions cannot be built.\n'
205
                     '  Using the slower Python implementations instead.\n')
2814.4.2 by Alexander Belchenko
support for win32
206
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
207
    def build_extension(self, ext):
208
        try:
209
            build_ext.build_extension(self, ext)
210
        except CCompilerError:
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
211
            if not self.allow_python_fallback:
4086.2.1 by John Arbash Meinel
Fix a small bug in setup.py when an extension fails to build
212
                log.warn('\n  Cannot build extension "%s".\n'
3928.4.1 by John Arbash Meinel
Change the warning from setup.py to make it a bit more obvious how to install
213
                         '  Use "build_ext --allow-python-fallback" to use'
3928.4.3 by John Arbash Meinel
fix typo in setup.py
214
                         ' slower python implementations instead.\n'
3759.1.1 by John Arbash Meinel
Default to requiring extensions.
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,))
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
220
221
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
222
# Override the build_ext if we have Pyrex available
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
223
command_classes['build_ext'] = build_ext_if_possible
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
224
unavailable_files = []
225
2617.1.2 by John Arbash Meinel
Try another form of comment
226
4241.6.1 by Ian Clatworthy
chk_map code from brisbane-core
227
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
228
    """Add a pyrex module to build.
229
230
    This will use Pyrex to auto-generate the .c file if it is available.
231
    Otherwise it will fall back on the .c file. If the .c file is not
232
    available, it will warn, and not add anything.
233
234
    You can pass any extra options to Extension through kwargs. One example is
235
    'libraries = []'.
236
237
    :param module_name: The python path to the module. This will be used to
238
        determine the .pyx and .c files to use.
239
    """
240
    path = module_name.replace('.', '/')
241
    pyrex_name = path + '.pyx'
242
    c_name = path + '.c'
3763.5.3 by Martin Pool
Review feedback on add_pyrex_extension
243
    define_macros = []
3763.5.2 by Martin Pool
Set -DWIN32 for all pyrex extensions, not one by one
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))
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
249
    if have_pyrex:
4241.6.1 by Ian Clatworthy
chk_map code from brisbane-core
250
        source = [pyrex_name]
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
251
    else:
252
        if not os.path.isfile(c_name):
253
            unavailable_files.append(c_name)
4241.6.1 by Ian Clatworthy
chk_map code from brisbane-core
254
            return
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
255
        else:
4241.6.1 by Ian Clatworthy
chk_map code from brisbane-core
256
            source = [c_name]
257
    source.extend(extra_source)
258
    ext_modules.append(Extension(module_name, source,
259
        define_macros=define_macros, libraries=libraries))
3763.5.2 by Martin Pool
Set -DWIN32 for all pyrex extensions, not one by one
260
261
4398.5.4 by John Arbash Meinel
A bit of code restructuring.
262
add_pyrex_extension('bzrlib._bencode_pyx')
3763.5.2 by Martin Pool
Set -DWIN32 for all pyrex extensions, not one by one
263
add_pyrex_extension('bzrlib._btree_serializer_c')
4398.5.4 by John Arbash Meinel
A bit of code restructuring.
264
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
3735.31.1 by John Arbash Meinel
Bring the groupcompress plugin into the brisbane-core branch.
265
add_pyrex_extension('bzrlib._groupcompress_pyx',
266
                    extra_source=['bzrlib/diff-delta.c'])
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
267
add_pyrex_extension('bzrlib._knit_load_data_c')
4354.3.2 by Jelmer Vernooij
Provide custom implementation of _read_stanza_utf8 in Pyrex.
268
add_pyrex_extension('bzrlib._rio_pyx')
3504.4.3 by John Arbash Meinel
Start working on an extension specifically for win32,
269
if sys.platform == 'win32':
3763.5.1 by Martin Pool
WIN32 must be defined when building all Pyrex extensions on Windows (#277481, from bialix)
270
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
3763.5.2 by Martin Pool
Set -DWIN32 for all pyrex extensions, not one by one
271
                        libraries=['Ws2_32'])
272
    add_pyrex_extension('bzrlib._walkdirs_win32')
4360.8.1 by Alexander Belchenko
using zdll on Windows to build _chk_map_pyx extension
273
    z_lib = 'zdll'
3696.3.10 by Robert Collins
Review feedback.
274
else:
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
275
    if have_pyrex and pyrex_version == '0.9.4.1':
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
276
        # Pyrex 0.9.4.1 fails to compile this extension correctly
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
277
        # The code it generates re-uses a "local" pointer and
278
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
279
        # which is NULL safe with PY_DECREF which is not.)
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
280
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
281
        print 'your version of pyrex "%s". Please upgrade your pyrex' % (
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
282
            pyrex_version,)
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
283
        print 'install. For now, the non-compiled (python) version will'
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
284
        print 'be used instead.'
285
    else:
286
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
3696.3.10 by Robert Collins
Review feedback.
287
    add_pyrex_extension('bzrlib._readdir_pyx')
4360.8.1 by Alexander Belchenko
using zdll on Windows to build _chk_map_pyx extension
288
    z_lib = 'z'
289
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
2781.1.1 by Martin Pool
merge cpatiencediff from Lukas
290
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
291
292
293
if unavailable_files:
294
    print 'C extension(s) not found:'
295
    print '   %s' % ('\n  '.join(unavailable_files),)
296
    print 'The python versions will be used instead.'
297
    print
298
3565.5.9 by Mark Hammond
Address John's review comments
299
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
300
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
3871.1.6 by Mark Hammond
remerge setup changes
301
                         gui_targets, data_files):
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
302
    packages.append('tbzrcommands')
303
304
    # ModuleFinder can't handle runtime changes to __path__, but
305
    # win32com uses them.  Hook this in so win32com.shell is found.
306
    import modulefinder
307
    import win32com
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
308
    import cPickle as pickle
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
309
    for p in win32com.__path__[1:]:
310
        modulefinder.AddPackagePath("win32com", p)
311
    for extra in ["win32com.shell"]:
312
        __import__(extra)
313
        m = sys.modules[extra]
314
        for p in m.__path__[1:]:
315
            modulefinder.AddPackagePath(extra, p)
316
317
    # TBZR points to the TBZR directory
318
    tbzr_root = os.environ["TBZR"]
319
320
    # Ensure tbzrlib itself is on sys.path
321
    sys.path.append(tbzr_root)
322
323
    # Ensure our COM "entry-point" is on sys.path
324
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
325
326
    packages.append("tbzrlib")
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
327
328
    # collect up our icons.
329
    cwd = os.getcwd()
330
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
3688.3.2 by Mark Hammond
build the list of icons without changing directory.
331
    icos = [] # list of (path_root, relative_ico_path)
332
    # First always bzr's icon and its in the root of the bzr tree.
333
    icos.append(('', 'bzr.ico'))
334
    for root, dirs, files in os.walk(ico_root):
335
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
336
                     for f in files if f.endswith('.ico')])
337
    # allocate an icon ID for each file and the full path to the ico
338
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
339
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
340
    # create a string resource with the mapping.  Might as well save the
341
    # runtime some effort and write a pickle.
342
    # Runtime expects unicode objects with forward-slash seps.
343
    fse = sys.getfilesystemencoding()
344
    map_items = [(f.replace('\\', '/').decode(fse), rid)
345
                 for rid, (_, f) in enumerate(icos)]
346
    ico_map = dict(map_items)
347
    # Create a new resource type of 'ICON_MAP', and use ID=1
348
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
349
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
350
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
351
                       win32ui crawler.Crawler""".split())
352
3871.1.6 by Mark Hammond
remerge setup changes
353
    # NOTE: We still create a DLL version of the Python implemented shell
354
    # extension for testing purposes - but it is *not* registered by
355
    # default - our C++ one is instead.  To discourage people thinking
356
    # this DLL is still necessary, its called 'tbzr_old.dll'
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
357
    tbzr = dict(
358
        modules=["tbzr"],
359
        create_exe = False, # we only want a .dll
3871.1.6 by Mark Hammond
remerge setup changes
360
        dest_base = 'tbzr_old',
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
361
    )
362
    com_targets.append(tbzr)
363
364
    # tbzrcache executables - a "console" version for debugging and a
365
    # GUI version that is generally used.
366
    tbzrcache = dict(
3871.1.6 by Mark Hammond
remerge setup changes
367
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
368
        icon_resources = icon_resources,
369
        other_resources = other_resources,
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
370
    )
371
    console_targets.append(tbzrcache)
372
373
    # Make a windows version which is the same except for the base name.
374
    tbzrcachew = tbzrcache.copy()
375
    tbzrcachew["dest_base"]="tbzrcachew"
376
    gui_targets.append(tbzrcachew)
377
378
    # ditto for the tbzrcommand tool
379
    tbzrcommand = dict(
3871.1.6 by Mark Hammond
remerge setup changes
380
        script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
381
        icon_resources = [(0,'bzr.ico')],
382
    )
383
    console_targets.append(tbzrcommand)
384
    tbzrcommandw = tbzrcommand.copy()
385
    tbzrcommandw["dest_base"]="tbzrcommandw"
386
    gui_targets.append(tbzrcommandw)
387
    
3871.1.6 by Mark Hammond
remerge setup changes
388
    # A utility to see python output from both C++ and Python based shell
389
    # extensions
390
    tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
391
    console_targets.append(tracer)
392
3871.1.6 by Mark Hammond
remerge setup changes
393
    # The C++ implemented shell extensions.
394
    dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
395
                            "build", "dist")
396
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
397
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
398
3565.5.9 by Mark Hammond
Address John's review comments
399
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
400
def get_qbzr_py2exe_info(includes, excludes, packages):
401
    # PyQt4 itself still escapes the plugin detection code for some reason...
402
    packages.append('PyQt4')
403
    excludes.append('PyQt4.elementtree.ElementTree')
404
    includes.append('sip') # extension module required for Qt.
405
    packages.append('pygments') # colorizer for qbzr
3697.9.1 by Mark Hammond
include docutils for tbzr to use formatting bzr help topics as HTML
406
    packages.append('docutils') # html formatting
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
407
    # but we can avoid many Qt4 Dlls.
408
    dll_excludes.extend(
409
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
410
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
411
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
412
        qscintilla2.dll""".split())
413
    # the qt binaries might not be on PATH...
414
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
415
    path = os.environ.get("PATH","")
416
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
417
        os.environ["PATH"] = path + os.pathsep + qt_dir
418
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
419
3995.6.1 by John Arbash Meinel
add subvertpy as a necessary library.
420
def get_svn_py2exe_info(includes, excludes, packages):
421
    packages.append('subvertpy')
422
423
1860.1.2 by Alexander Belchenko
setup.py:
424
if 'bdist_wininst' in sys.argv:
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
425
    def find_docs():
426
        docs = []
427
        for root, dirs, files in os.walk('doc'):
428
            r = []
429
            for f in files:
3224.2.1 by Alexander Belchenko
(bialix) Include quick-start-summary.svg file to python-based installer for Windows (bug #192924)
430
                if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
431
                    or f == 'quick-start-summary.svg'):
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
432
                    r.append(os.path.join(root, f))
433
            if r:
434
                relative = root[4:]
435
                if relative:
436
                    target = os.path.join('Doc\\Bazaar', relative)
437
                else:
438
                    target = 'Doc\\Bazaar'
439
                docs.append((target, r))
440
        return docs
441
1860.1.2 by Alexander Belchenko
setup.py:
442
    # python's distutils-based win32 installer
443
    ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
444
            'ext_modules': ext_modules,
1860.1.3 by Alexander Belchenko
python-installer:
445
            # help pages
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
446
            'data_files': find_docs(),
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
447
            # for building pyrex extensions
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
448
            'cmdclass': {'build_ext': build_ext_if_possible},
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
449
           }
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
450
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
451
    ARGS.update(META_INFO)
452
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
453
    ARGS.update(PKG_DATA)
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
454
    
455
    setup(**ARGS)
456
1860.1.2 by Alexander Belchenko
setup.py:
457
elif 'py2exe' in sys.argv:
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
458
    import glob
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
459
    # py2exe setup
460
    import py2exe
461
462
    # pick real bzr version
463
    import bzrlib
464
465
    version_number = []
466
    for i in bzrlib.version_info[:4]:
467
        try:
468
            i = int(i)
469
        except ValueError:
470
            i = 0
471
        version_number.append(str(i))
472
    version_str = '.'.join(version_number)
473
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
474
    # An override to install_data used only by py2exe builds, which arranges
475
    # to byte-compile any .py files in data_files (eg, our plugins)
476
    # Necessary as we can't rely on the user having the relevant permissions
477
    # to the "Program Files" directory to generate them on the fly.
478
    class install_data_with_bytecompile(install_data):
479
        def run(self):
480
            from distutils.util import byte_compile
481
482
            install_data.run(self)
483
484
            py2exe = self.distribution.get_command_obj('py2exe', False)
485
            optimize = py2exe.optimize
486
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
487
            byte_compile(compile_names,
488
                         optimize=optimize,
489
                         force=self.force, prefix=self.install_dir,
490
                         dry_run=self.dry_run)
491
            if optimize:
492
                suffix = 'o'
493
            else:
494
                suffix = 'c'
495
            self.outfiles.extend([f + suffix for f in compile_names])
496
    # end of class install_data_with_bytecompile
497
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
498
    target = py2exe.build_exe.Target(script = "bzr",
499
                                     dest_base = "bzr",
500
                                     icon_resources = [(0,'bzr.ico')],
501
                                     name = META_INFO['name'],
502
                                     version = version_str,
503
                                     description = META_INFO['description'],
504
                                     author = META_INFO['author'],
2232.1.1 by mbp at sourcefrog
update global copyright to 2007
505
                                     copyright = "(c) Canonical Ltd, 2005-2007",
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
506
                                     company_name = "Canonical Ltd.",
507
                                     comments = META_INFO['description'],
508
                                    )
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
509
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
510
    packages = BZRLIB['packages']
511
    packages.remove('bzrlib')
512
    packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
513
    includes = []
514
    for i in glob.glob('bzrlib\\*.py'):
515
        module = i[:-3].replace('\\', '.')
3193.7.9 by Alexander Belchenko
Ian's review
516
        if module.endswith('__init__'):
517
            module = module[:-len('__init__')]
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
518
        includes.append(module)
519
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
520
    additional_packages = set()
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
521
    if sys.version.startswith('2.4'):
522
        # adding elementtree package
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
523
        additional_packages.add('elementtree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
524
    elif sys.version.startswith('2.5'):
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
525
        additional_packages.add('xml.etree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
526
    else:
527
        import warnings
528
        warnings.warn('Unknown Python version.\n'
529
                      'Please check setup.py script for compatibility.')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
530
531
    # Although we currently can't enforce it, we consider it an error for
532
    # py2exe to report any files are "missing".  Such modules we know aren't
533
    # used should be listed here.
534
    excludes = """Tkinter psyco ElementPath r_hmac
535
                  ImaginaryModule cElementTree elementtree.ElementTree
536
                  Crypto.PublicKey._fastmath
537
                  medusa medusa.filesys medusa.ftp_server
538
                  tools tools.doc_generate
539
                  resource validate""".split()
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
540
    dll_excludes = []
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
541
2571.3.2 by Alexander Belchenko
Build pyrex/C extensions for bzr.exe
542
    # email package from std python library use lazy import,
543
    # so we need to explicitly add all package
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
544
    additional_packages.add('email')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
545
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
546
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
547
    # to exclude them.
548
    import email
549
    for oldname in getattr(email, '_LOWERNAMES', []):
550
        excludes.append("email." + oldname)
551
    for oldname in getattr(email, '_MIMENAMES', []):
552
        excludes.append("email.MIME" + oldname)
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
553
3087.2.4 by Alexander Belchenko
Help topics can now be loaded from files (based on Ian's patch, adapted to proper support various windows installers).
554
    # text files for help topis
3089.3.6 by Ian Clatworthy
make help topics more discoverable
555
    text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
556
    topics_files = [('lib/help_topics/en', text_topics)]
557
558
    # built-in plugins
559
    plugins_files = []
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
560
    # XXX - should we consider having the concept of an 'official' build,
561
    # which hard-codes the list of plugins, gets more upset if modules are
562
    # missing, etc?
563
    plugins = None # will be a set after plugin sniffing...
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
564
    for root, dirs, files in os.walk('bzrlib/plugins'):
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
565
        if root == 'bzrlib/plugins':
566
            plugins = set(dirs)
3871.1.7 by Mark Hammond
change comment as requested by John
567
            # We ship plugins as normal files on the file-system - however,
568
            # the build process can cause *some* of these plugin files to end
569
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
570
            # library.zip, and then saw import errors related to that as the
571
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
572
            # plugins out of the .zip file
3871.1.6 by Mark Hammond
remerge setup changes
573
            excludes.extend(["bzrlib.plugins." + d for d in dirs])
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
574
        x = []
575
        for i in files:
3684.3.1 by Mark Hammond
pickup l10n files from plugins.
576
            if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
577
                continue
578
            if i == '__init__.py' and root == 'bzrlib/plugins':
579
                continue
580
            x.append(os.path.join(root, i))
581
        if x:
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
582
            target_dir = root[len('bzrlib/'):]  # install to 'plugins/...'
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
583
            plugins_files.append((target_dir, x))
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
584
    # find modules for built-in plugins
585
    import tools.package_mf
586
    mf = tools.package_mf.CustomModuleFinder()
587
    mf.run_package('bzrlib/plugins')
588
    packs, mods = mf.get_result()
589
    additional_packages.update(packs)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
590
    includes.extend(mods)
591
592
    console_targets = [target,
593
                       'tools/win32/bzr_postinstall.py',
594
                       ]
595
    gui_targets = []
596
    com_targets = []
3871.1.6 by Mark Hammond
remerge setup changes
597
    data_files = topics_files + plugins_files
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
598
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
599
    if 'qbzr' in plugins:
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
600
        get_qbzr_py2exe_info(includes, excludes, packages)
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
601
3995.6.1 by John Arbash Meinel
add subvertpy as a necessary library.
602
    if 'svn' in plugins:
603
        get_svn_py2exe_info(includes, excludes, packages)
604
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
605
    if "TBZR" in os.environ:
3565.5.9 by Mark Hammond
Address John's review comments
606
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
607
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
608
        # can be downloaded from (username=guest, blank password):
4343.2.1 by John Arbash Meinel
Give a better error message when we cannot find the TortoiseOverlays files.
609
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
610
        # look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
3871.1.6 by Mark Hammond
remerge setup changes
611
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
612
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
613
                       'TORTOISE_OVERLAYS_MSI_X64'):
4343.2.1 by John Arbash Meinel
Give a better error message when we cannot find the TortoiseOverlays files.
614
            url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
615
                   '/TortoiseOverlays')
3871.1.6 by Mark Hammond
remerge setup changes
616
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
4343.2.1 by John Arbash Meinel
Give a better error message when we cannot find the TortoiseOverlays files.
617
                raise RuntimeError(
618
                    "\nPlease set %s to the location of the relevant"
619
                    "\nTortoiseOverlays .msi installer file."
620
                    " The installers can be found at"
621
                    "\n  %s"
622
                    "\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
623
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
3871.1.6 by Mark Hammond
remerge setup changes
624
                             gui_targets, data_files)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
625
    else:
626
        # print this warning to stderr as output is redirected, so it is seen
627
        # at build time.  Also to stdout so it appears in the log
628
        for f in (sys.stderr, sys.stdout):
629
            print >> f, \
630
                "Skipping TBZR binaries - please set TBZR to a directory to enable"
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
631
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
632
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
633
    # in on Vista.
3995.3.9 by John Arbash Meinel
Local modification to exclude certain system DLLs
634
    dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
3193.7.7 by Alexander Belchenko
custom module finder to find additional dependencies for built-in plugins (to bundle additional packages and modules into bzr.exe's library.zip)
635
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
636
                               "includes": includes,
637
                               "excludes": excludes,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
638
                               "dll_excludes": dll_excludes,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
639
                               "dist_dir": "win32_bzr.exe",
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
640
                               "optimize": 1,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
641
                              },
642
                   }
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
643
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
644
    setup(options=options_list,
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
645
          console=console_targets,
646
          windows=gui_targets,
647
          com_server=com_targets,
3087.2.4 by Alexander Belchenko
Help topics can now be loaded from files (based on Ian's patch, adapted to proper support various windows installers).
648
          zipfile='lib/library.zip',
3871.1.6 by Mark Hammond
remerge setup changes
649
          data_files=data_files,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
650
          cmdclass={'install_data': install_data_with_bytecompile},
3087.2.4 by Alexander Belchenko
Help topics can now be loaded from files (based on Ian's patch, adapted to proper support various windows installers).
651
          )
1860.1.2 by Alexander Belchenko
setup.py:
652
653
else:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
654
    # ad-hoc for easy_install
655
    DATA_FILES = []
656
    if not 'bdist_egg' in sys.argv:
657
        # generate and install bzr.1 only with plain install, not easy_install one
658
        DATA_FILES = [('man/man1', ['bzr.1'])]
659
1860.1.2 by Alexander Belchenko
setup.py:
660
    # std setup
661
    ARGS = {'scripts': ['bzr'],
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
662
            'data_files': DATA_FILES,
1739.1.3 by Robert Collins
Merge bzr.dev.
663
            'cmdclass': command_classes,
664
            'ext_modules': ext_modules,
1860.1.2 by Alexander Belchenko
setup.py:
665
           }
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
666
1860.1.2 by Alexander Belchenko
setup.py:
667
    ARGS.update(META_INFO)
668
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
669
    ARGS.update(PKG_DATA)
1860.1.2 by Alexander Belchenko
setup.py:
670
671
    setup(**ARGS)