~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
262
add_pyrex_extension('bzrlib._btree_serializer_c')
3735.31.1 by John Arbash Meinel
Bring the groupcompress plugin into the brisbane-core branch.
263
add_pyrex_extension('bzrlib._groupcompress_pyx',
264
                    extra_source=['bzrlib/diff-delta.c'])
3890.2.7 by John Arbash Meinel
A Pyrex extension is about 5x faster than the fastest python code I could write.
265
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
266
add_pyrex_extension('bzrlib._knit_load_data_c')
4241.6.1 by Ian Clatworthy
chk_map code from brisbane-core
267
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=['z'])
3504.4.3 by John Arbash Meinel
Start working on an extension specifically for win32,
268
if sys.platform == 'win32':
3763.5.1 by Martin Pool
WIN32 must be defined when building all Pyrex extensions on Windows (#277481, from bialix)
269
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
3763.5.2 by Martin Pool
Set -DWIN32 for all pyrex extensions, not one by one
270
                        libraries=['Ws2_32'])
271
    add_pyrex_extension('bzrlib._walkdirs_win32')
3696.3.10 by Robert Collins
Review feedback.
272
else:
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
273
    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
274
        # 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.
275
        # The code it generates re-uses a "local" pointer and
276
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
277
        # 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
278
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
279
        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
280
            pyrex_version,)
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
281
        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
282
        print 'be used instead.'
283
    else:
284
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
3696.3.10 by Robert Collins
Review feedback.
285
    add_pyrex_extension('bzrlib._readdir_pyx')
2781.1.1 by Martin Pool
merge cpatiencediff from Lukas
286
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.
287
288
289
if unavailable_files:
290
    print 'C extension(s) not found:'
291
    print '   %s' % ('\n  '.join(unavailable_files),)
292
    print 'The python versions will be used instead.'
293
    print
294
3565.5.9 by Mark Hammond
Address John's review comments
295
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
296
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
3871.1.6 by Mark Hammond
remerge setup changes
297
                         gui_targets, data_files):
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
298
    packages.append('tbzrcommands')
299
300
    # ModuleFinder can't handle runtime changes to __path__, but
301
    # win32com uses them.  Hook this in so win32com.shell is found.
302
    import modulefinder
303
    import win32com
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
304
    import cPickle as pickle
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
305
    for p in win32com.__path__[1:]:
306
        modulefinder.AddPackagePath("win32com", p)
307
    for extra in ["win32com.shell"]:
308
        __import__(extra)
309
        m = sys.modules[extra]
310
        for p in m.__path__[1:]:
311
            modulefinder.AddPackagePath(extra, p)
312
313
    # TBZR points to the TBZR directory
314
    tbzr_root = os.environ["TBZR"]
315
316
    # Ensure tbzrlib itself is on sys.path
317
    sys.path.append(tbzr_root)
318
319
    # Ensure our COM "entry-point" is on sys.path
320
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
321
322
    packages.append("tbzrlib")
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
323
324
    # collect up our icons.
325
    cwd = os.getcwd()
326
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
3688.3.2 by Mark Hammond
build the list of icons without changing directory.
327
    icos = [] # list of (path_root, relative_ico_path)
328
    # First always bzr's icon and its in the root of the bzr tree.
329
    icos.append(('', 'bzr.ico'))
330
    for root, dirs, files in os.walk(ico_root):
331
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
332
                     for f in files if f.endswith('.ico')])
333
    # allocate an icon ID for each file and the full path to the ico
334
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
335
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
336
    # create a string resource with the mapping.  Might as well save the
337
    # runtime some effort and write a pickle.
338
    # Runtime expects unicode objects with forward-slash seps.
339
    fse = sys.getfilesystemencoding()
340
    map_items = [(f.replace('\\', '/').decode(fse), rid)
341
                 for rid, (_, f) in enumerate(icos)]
342
    ico_map = dict(map_items)
343
    # Create a new resource type of 'ICON_MAP', and use ID=1
344
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
345
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
346
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
347
                       win32ui crawler.Crawler""".split())
348
3871.1.6 by Mark Hammond
remerge setup changes
349
    # NOTE: We still create a DLL version of the Python implemented shell
350
    # extension for testing purposes - but it is *not* registered by
351
    # default - our C++ one is instead.  To discourage people thinking
352
    # 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.
353
    tbzr = dict(
354
        modules=["tbzr"],
355
        create_exe = False, # we only want a .dll
3871.1.6 by Mark Hammond
remerge setup changes
356
        dest_base = 'tbzr_old',
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
357
    )
358
    com_targets.append(tbzr)
359
360
    # tbzrcache executables - a "console" version for debugging and a
361
    # GUI version that is generally used.
362
    tbzrcache = dict(
3871.1.6 by Mark Hammond
remerge setup changes
363
        script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
364
        icon_resources = icon_resources,
365
        other_resources = other_resources,
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
366
    )
367
    console_targets.append(tbzrcache)
368
369
    # Make a windows version which is the same except for the base name.
370
    tbzrcachew = tbzrcache.copy()
371
    tbzrcachew["dest_base"]="tbzrcachew"
372
    gui_targets.append(tbzrcachew)
373
374
    # ditto for the tbzrcommand tool
375
    tbzrcommand = dict(
3871.1.6 by Mark Hammond
remerge setup changes
376
        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.
377
        icon_resources = [(0,'bzr.ico')],
378
    )
379
    console_targets.append(tbzrcommand)
380
    tbzrcommandw = tbzrcommand.copy()
381
    tbzrcommandw["dest_base"]="tbzrcommandw"
382
    gui_targets.append(tbzrcommandw)
383
    
3871.1.6 by Mark Hammond
remerge setup changes
384
    # A utility to see python output from both C++ and Python based shell
385
    # extensions
386
    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.
387
    console_targets.append(tracer)
388
3871.1.6 by Mark Hammond
remerge setup changes
389
    # The C++ implemented shell extensions.
390
    dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
391
                            "build", "dist")
392
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
393
    data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
394
3565.5.9 by Mark Hammond
Address John's review comments
395
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
396
def get_qbzr_py2exe_info(includes, excludes, packages):
397
    # PyQt4 itself still escapes the plugin detection code for some reason...
398
    packages.append('PyQt4')
399
    excludes.append('PyQt4.elementtree.ElementTree')
400
    includes.append('sip') # extension module required for Qt.
401
    packages.append('pygments') # colorizer for qbzr
3697.9.1 by Mark Hammond
include docutils for tbzr to use formatting bzr help topics as HTML
402
    packages.append('docutils') # html formatting
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
403
    # but we can avoid many Qt4 Dlls.
404
    dll_excludes.extend(
405
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
406
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
407
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
408
        qscintilla2.dll""".split())
409
    # the qt binaries might not be on PATH...
410
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
411
    path = os.environ.get("PATH","")
412
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
413
        os.environ["PATH"] = path + os.pathsep + qt_dir
414
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
415
3995.6.1 by John Arbash Meinel
add subvertpy as a necessary library.
416
def get_svn_py2exe_info(includes, excludes, packages):
417
    packages.append('subvertpy')
418
419
1860.1.2 by Alexander Belchenko
setup.py:
420
if 'bdist_wininst' in sys.argv:
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
421
    def find_docs():
422
        docs = []
423
        for root, dirs, files in os.walk('doc'):
424
            r = []
425
            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)
426
                if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
427
                    or f == 'quick-start-summary.svg'):
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
428
                    r.append(os.path.join(root, f))
429
            if r:
430
                relative = root[4:]
431
                if relative:
432
                    target = os.path.join('Doc\\Bazaar', relative)
433
                else:
434
                    target = 'Doc\\Bazaar'
435
                docs.append((target, r))
436
        return docs
437
1860.1.2 by Alexander Belchenko
setup.py:
438
    # python's distutils-based win32 installer
439
    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
440
            'ext_modules': ext_modules,
1860.1.3 by Alexander Belchenko
python-installer:
441
            # help pages
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
442
            'data_files': find_docs(),
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
443
            # 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.
444
            'cmdclass': {'build_ext': build_ext_if_possible},
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
445
           }
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
446
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
447
    ARGS.update(META_INFO)
448
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
449
    ARGS.update(PKG_DATA)
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
450
    
451
    setup(**ARGS)
452
1860.1.2 by Alexander Belchenko
setup.py:
453
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
454
    import glob
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
455
    # py2exe setup
456
    import py2exe
457
458
    # pick real bzr version
459
    import bzrlib
460
461
    version_number = []
462
    for i in bzrlib.version_info[:4]:
463
        try:
464
            i = int(i)
465
        except ValueError:
466
            i = 0
467
        version_number.append(str(i))
468
    version_str = '.'.join(version_number)
469
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
470
    # An override to install_data used only by py2exe builds, which arranges
471
    # to byte-compile any .py files in data_files (eg, our plugins)
472
    # Necessary as we can't rely on the user having the relevant permissions
473
    # to the "Program Files" directory to generate them on the fly.
474
    class install_data_with_bytecompile(install_data):
475
        def run(self):
476
            from distutils.util import byte_compile
477
478
            install_data.run(self)
479
480
            py2exe = self.distribution.get_command_obj('py2exe', False)
481
            optimize = py2exe.optimize
482
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
483
            byte_compile(compile_names,
484
                         optimize=optimize,
485
                         force=self.force, prefix=self.install_dir,
486
                         dry_run=self.dry_run)
487
            if optimize:
488
                suffix = 'o'
489
            else:
490
                suffix = 'c'
491
            self.outfiles.extend([f + suffix for f in compile_names])
492
    # end of class install_data_with_bytecompile
493
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
494
    target = py2exe.build_exe.Target(script = "bzr",
495
                                     dest_base = "bzr",
496
                                     icon_resources = [(0,'bzr.ico')],
497
                                     name = META_INFO['name'],
498
                                     version = version_str,
499
                                     description = META_INFO['description'],
500
                                     author = META_INFO['author'],
2232.1.1 by mbp at sourcefrog
update global copyright to 2007
501
                                     copyright = "(c) Canonical Ltd, 2005-2007",
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
502
                                     company_name = "Canonical Ltd.",
503
                                     comments = META_INFO['description'],
504
                                    )
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
505
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
506
    packages = BZRLIB['packages']
507
    packages.remove('bzrlib')
508
    packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
509
    includes = []
510
    for i in glob.glob('bzrlib\\*.py'):
511
        module = i[:-3].replace('\\', '.')
3193.7.9 by Alexander Belchenko
Ian's review
512
        if module.endswith('__init__'):
513
            module = module[:-len('__init__')]
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
514
        includes.append(module)
515
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)
516
    additional_packages = set()
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
517
    if sys.version.startswith('2.4'):
518
        # 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)
519
        additional_packages.add('elementtree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
520
    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)
521
        additional_packages.add('xml.etree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
522
    else:
523
        import warnings
524
        warnings.warn('Unknown Python version.\n'
525
                      'Please check setup.py script for compatibility.')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
526
527
    # Although we currently can't enforce it, we consider it an error for
528
    # py2exe to report any files are "missing".  Such modules we know aren't
529
    # used should be listed here.
530
    excludes = """Tkinter psyco ElementPath r_hmac
531
                  ImaginaryModule cElementTree elementtree.ElementTree
532
                  Crypto.PublicKey._fastmath
533
                  medusa medusa.filesys medusa.ftp_server
534
                  tools tools.doc_generate
535
                  resource validate""".split()
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
536
    dll_excludes = []
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
537
2571.3.2 by Alexander Belchenko
Build pyrex/C extensions for bzr.exe
538
    # email package from std python library use lazy import,
539
    # 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)
540
    additional_packages.add('email')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
541
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
542
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
543
    # to exclude them.
544
    import email
545
    for oldname in getattr(email, '_LOWERNAMES', []):
546
        excludes.append("email." + oldname)
547
    for oldname in getattr(email, '_MIMENAMES', []):
548
        excludes.append("email.MIME" + oldname)
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
549
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).
550
    # text files for help topis
3089.3.6 by Ian Clatworthy
make help topics more discoverable
551
    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
552
    topics_files = [('lib/help_topics/en', text_topics)]
553
554
    # built-in plugins
555
    plugins_files = []
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
556
    # XXX - should we consider having the concept of an 'official' build,
557
    # which hard-codes the list of plugins, gets more upset if modules are
558
    # missing, etc?
559
    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
560
    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.
561
        if root == 'bzrlib/plugins':
562
            plugins = set(dirs)
3871.1.7 by Mark Hammond
change comment as requested by John
563
            # We ship plugins as normal files on the file-system - however,
564
            # the build process can cause *some* of these plugin files to end
565
            # up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
566
            # library.zip, and then saw import errors related to that as the
567
            # rest of the svn plugin wasn't. So we tell py2exe to leave the
568
            # plugins out of the .zip file
3871.1.6 by Mark Hammond
remerge setup changes
569
            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
570
        x = []
571
        for i in files:
3684.3.1 by Mark Hammond
pickup l10n files from plugins.
572
            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
573
                continue
574
            if i == '__init__.py' and root == 'bzrlib/plugins':
575
                continue
576
            x.append(os.path.join(root, i))
577
        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)
578
            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
579
            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)
580
    # find modules for built-in plugins
581
    import tools.package_mf
582
    mf = tools.package_mf.CustomModuleFinder()
583
    mf.run_package('bzrlib/plugins')
584
    packs, mods = mf.get_result()
585
    additional_packages.update(packs)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
586
    includes.extend(mods)
587
588
    console_targets = [target,
589
                       'tools/win32/bzr_postinstall.py',
590
                       ]
591
    gui_targets = []
592
    com_targets = []
3871.1.6 by Mark Hammond
remerge setup changes
593
    data_files = topics_files + plugins_files
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
594
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
595
    if 'qbzr' in plugins:
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
596
        get_qbzr_py2exe_info(includes, excludes, packages)
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
597
3995.6.1 by John Arbash Meinel
add subvertpy as a necessary library.
598
    if 'svn' in plugins:
599
        get_svn_py2exe_info(includes, excludes, packages)
600
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
601
    if "TBZR" in os.environ:
3565.5.9 by Mark Hammond
Address John's review comments
602
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
603
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
604
        # can be downloaded from (username=guest, blank password):
605
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
3871.1.6 by Mark Hammond
remerge setup changes
606
        # Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
607
        for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
608
                       'TORTOISE_OVERLAYS_MSI_X64'):
609
            if not os.path.isfile(os.environ.get(needed, '<nofile>')):
610
                raise RuntimeError("Please set %s to the"
611
                                   " location of the relevant TortoiseOverlays"
612
                                   " .msi installer file" % needed)
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
613
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
3871.1.6 by Mark Hammond
remerge setup changes
614
                             gui_targets, data_files)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
615
    else:
616
        # print this warning to stderr as output is redirected, so it is seen
617
        # at build time.  Also to stdout so it appears in the log
618
        for f in (sys.stderr, sys.stdout):
619
            print >> f, \
620
                "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
621
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
622
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
623
    # in on Vista.
3995.3.9 by John Arbash Meinel
Local modification to exclude certain system DLLs
624
    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)
625
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
626
                               "includes": includes,
627
                               "excludes": excludes,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
628
                               "dll_excludes": dll_excludes,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
629
                               "dist_dir": "win32_bzr.exe",
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
630
                               "optimize": 1,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
631
                              },
632
                   }
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
633
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
634
    setup(options=options_list,
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
635
          console=console_targets,
636
          windows=gui_targets,
637
          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).
638
          zipfile='lib/library.zip',
3871.1.6 by Mark Hammond
remerge setup changes
639
          data_files=data_files,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
640
          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).
641
          )
1860.1.2 by Alexander Belchenko
setup.py:
642
643
else:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
644
    # ad-hoc for easy_install
645
    DATA_FILES = []
646
    if not 'bdist_egg' in sys.argv:
647
        # generate and install bzr.1 only with plain install, not easy_install one
648
        DATA_FILES = [('man/man1', ['bzr.1'])]
649
1860.1.2 by Alexander Belchenko
setup.py:
650
    # std setup
651
    ARGS = {'scripts': ['bzr'],
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
652
            'data_files': DATA_FILES,
1739.1.3 by Robert Collins
Merge bzr.dev.
653
            'cmdclass': command_classes,
654
            'ext_modules': ext_modules,
1860.1.2 by Alexander Belchenko
setup.py:
655
           }
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
656
1860.1.2 by Alexander Belchenko
setup.py:
657
    ARGS.update(META_INFO)
658
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
659
    ARGS.update(PKG_DATA)
1860.1.2 by Alexander Belchenko
setup.py:
660
661
    setup(**ARGS)