/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
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
    """
147
    def run(self):
148
        build.run(self)
149
1551.3.11 by Aaron Bentley
Merge from Robert
150
        import generate_docs
151
        generate_docs.main(argv=["bzr", "man"])
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
152
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
153
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
154
########################
155
## Setup
156
########################
157
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
158
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
159
                   '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.
160
from distutils import log
2814.4.2 by Alexander Belchenko
support for win32
161
from distutils.errors import CCompilerError, DistutilsPlatformError
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
162
from distutils.extension import Extension
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
163
ext_modules = []
164
try:
165
    from Pyrex.Distutils import build_ext
166
except ImportError:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
167
    have_pyrex = False
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
168
    # 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.
169
    print
2617.1.2 by John Arbash Meinel
Try another form of comment
170
    print ("The python package 'Pyrex' is not available."
171
           " If the .c files are available,")
172
    print ("they will be built,"
173
           " 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
174
    print
1739.1.4 by Robert Collins
Fix building of C modules without pyrex installed.
175
    from distutils.command.build_ext import build_ext
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
176
else:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
177
    have_pyrex = True
3757.2.1 by John Arbash Meinel
Work around bug #276868 by blacklisting pyrex 0.9.4.1 for that extension
178
    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.
179
180
181
class build_ext_if_possible(build_ext):
182
2814.4.2 by Alexander Belchenko
support for win32
183
    def run(self):
184
        try:
185
            build_ext.run(self)
186
        except DistutilsPlatformError, e:
2814.4.4 by Alexander Belchenko
changes suggested by Aaron and Martin
187
            log.warn(str(e))
2814.4.5 by Alexander Belchenko
double quotes for extension name
188
            log.warn('Extensions cannot be built, '
189
                     'will use the Python versions instead')
2814.4.2 by Alexander Belchenko
support for win32
190
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
191
    def build_extension(self, ext):
192
        try:
193
            build_ext.build_extension(self, ext)
194
        except CCompilerError:
2814.4.5 by Alexander Belchenko
double quotes for extension name
195
            log.warn('Building of "%s" extension failed, '
196
                     'will use the Python version instead' % (ext.name,))
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
197
198
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
199
# 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.
200
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.
201
unavailable_files = []
202
2617.1.2 by John Arbash Meinel
Try another form of comment
203
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
204
def add_pyrex_extension(module_name, **kwargs):
205
    """Add a pyrex module to build.
206
207
    This will use Pyrex to auto-generate the .c file if it is available.
208
    Otherwise it will fall back on the .c file. If the .c file is not
209
    available, it will warn, and not add anything.
210
211
    You can pass any extra options to Extension through kwargs. One example is
212
    'libraries = []'.
213
214
    :param module_name: The python path to the module. This will be used to
215
        determine the .pyx and .c files to use.
216
    """
217
    path = module_name.replace('.', '/')
218
    pyrex_name = path + '.pyx'
219
    c_name = path + '.c'
220
    if have_pyrex:
3557.2.7 by Alexander Belchenko
Pass extra arguments for extensions, and supply WIN32 macro for pyrex.
221
        ext_modules.append(Extension(module_name, [pyrex_name], **kwargs))
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
222
    else:
223
        if not os.path.isfile(c_name):
224
            unavailable_files.append(c_name)
225
        else:
3557.2.7 by Alexander Belchenko
Pass extra arguments for extensions, and supply WIN32 macro for pyrex.
226
            ext_modules.append(Extension(module_name, [c_name], **kwargs))
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
227
228
3641.3.30 by John Arbash Meinel
Rename _parse_btree to _btree_serializer
229
add_pyrex_extension('bzrlib._btree_serializer_c')
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
230
add_pyrex_extension('bzrlib._knit_load_data_c')
3504.4.3 by John Arbash Meinel
Start working on an extension specifically for win32,
231
if sys.platform == 'win32':
3737.1.3 by John Arbash Meinel
Move more compatibility code into python-compat.h
232
    add_pyrex_extension('bzrlib._dirstate_helpers_c',
233
                         libraries=['Ws2_32']
234
                       )
3557.2.7 by Alexander Belchenko
Pass extra arguments for extensions, and supply WIN32 macro for pyrex.
235
    # pyrex uses the macro WIN32 to detect the platform, even though it should
236
    # be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
237
    # right value.
238
    add_pyrex_extension('bzrlib._walkdirs_win32',
3557.2.9 by John Arbash Meinel
Alexander noticed I typed macro instead of macros.
239
                        define_macros=[('WIN32', None)])
3696.3.10 by Robert Collins
Review feedback.
240
else:
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
241
    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
242
        # 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.
243
        # The code it generates re-uses a "local" pointer and
244
        # calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
245
        # 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
246
        print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
247
        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
248
            pyrex_version,)
3757.2.2 by John Arbash Meinel
Request from Martin, clearly comment the problem.
249
        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
250
        print 'be used instead.'
251
    else:
252
        add_pyrex_extension('bzrlib._dirstate_helpers_c')
3696.3.10 by Robert Collins
Review feedback.
253
    add_pyrex_extension('bzrlib._readdir_pyx')
2781.1.1 by Martin Pool
merge cpatiencediff from Lukas
254
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.
255
256
257
if unavailable_files:
258
    print 'C extension(s) not found:'
259
    print '   %s' % ('\n  '.join(unavailable_files),)
260
    print 'The python versions will be used instead.'
261
    print
262
3565.5.9 by Mark Hammond
Address John's review comments
263
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
264
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
265
                         gui_targets):
266
    packages.append('tbzrcommands')
267
268
    # ModuleFinder can't handle runtime changes to __path__, but
269
    # win32com uses them.  Hook this in so win32com.shell is found.
270
    import modulefinder
271
    import win32com
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
272
    import cPickle as pickle
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
273
    for p in win32com.__path__[1:]:
274
        modulefinder.AddPackagePath("win32com", p)
275
    for extra in ["win32com.shell"]:
276
        __import__(extra)
277
        m = sys.modules[extra]
278
        for p in m.__path__[1:]:
279
            modulefinder.AddPackagePath(extra, p)
280
281
    # TBZR points to the TBZR directory
282
    tbzr_root = os.environ["TBZR"]
283
284
    # Ensure tbzrlib itself is on sys.path
285
    sys.path.append(tbzr_root)
286
287
    # Ensure our COM "entry-point" is on sys.path
288
    sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
289
290
    packages.append("tbzrlib")
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
291
292
    # collect up our icons.
293
    cwd = os.getcwd()
294
    ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
3688.3.2 by Mark Hammond
build the list of icons without changing directory.
295
    icos = [] # list of (path_root, relative_ico_path)
296
    # First always bzr's icon and its in the root of the bzr tree.
297
    icos.append(('', 'bzr.ico'))
298
    for root, dirs, files in os.walk(ico_root):
299
        icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
300
                     for f in files if f.endswith('.ico')])
301
    # allocate an icon ID for each file and the full path to the ico
302
    icon_resources = [(rid, os.path.join(ico_dir, ico_name))
303
                      for rid, (ico_dir, ico_name) in enumerate(icos)]
304
    # create a string resource with the mapping.  Might as well save the
305
    # runtime some effort and write a pickle.
306
    # Runtime expects unicode objects with forward-slash seps.
307
    fse = sys.getfilesystemencoding()
308
    map_items = [(f.replace('\\', '/').decode(fse), rid)
309
                 for rid, (_, f) in enumerate(icos)]
310
    ico_map = dict(map_items)
311
    # Create a new resource type of 'ICON_MAP', and use ID=1
312
    other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
313
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
314
    excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
315
                       win32ui crawler.Crawler""".split())
316
317
    tbzr = dict(
318
        modules=["tbzr"],
319
        create_exe = False, # we only want a .dll
320
    )
321
    com_targets.append(tbzr)
322
323
    # tbzrcache executables - a "console" version for debugging and a
324
    # GUI version that is generally used.
325
    tbzrcache = dict(
326
        script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
3684.2.1 by Mark Hammond
include tbzr icons in windows binary distributions
327
        icon_resources = icon_resources,
328
        other_resources = other_resources,
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
329
    )
330
    console_targets.append(tbzrcache)
331
332
    # Make a windows version which is the same except for the base name.
333
    tbzrcachew = tbzrcache.copy()
334
    tbzrcachew["dest_base"]="tbzrcachew"
335
    gui_targets.append(tbzrcachew)
336
337
    # ditto for the tbzrcommand tool
338
    tbzrcommand = dict(
339
        script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
340
        icon_resources = [(0,'bzr.ico')],
341
    )
342
    console_targets.append(tbzrcommand)
343
    tbzrcommandw = tbzrcommand.copy()
344
    tbzrcommandw["dest_base"]="tbzrcommandw"
345
    gui_targets.append(tbzrcommandw)
346
    
347
    # tbzr tests
348
    tbzrtest = dict(
349
        script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
350
    )
351
    console_targets.append(tbzrtest)
352
353
    # A utility to see python output from the shell extension - this will
354
    # die when we get a c++ extension
355
    # any .py file from pywin32's win32 lib will do (other than
356
    # win32traceutil itself that is)
357
    import winerror
358
    win32_lib_dir = os.path.dirname(winerror.__file__)
359
    tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
360
                  dest_base="tbzr_tracer")
361
    console_targets.append(tracer)
362
3565.5.9 by Mark Hammond
Address John's review comments
363
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
364
def get_qbzr_py2exe_info(includes, excludes, packages):
365
    # PyQt4 itself still escapes the plugin detection code for some reason...
366
    packages.append('PyQt4')
367
    excludes.append('PyQt4.elementtree.ElementTree')
368
    includes.append('sip') # extension module required for Qt.
369
    packages.append('pygments') # colorizer for qbzr
3697.9.1 by Mark Hammond
include docutils for tbzr to use formatting bzr help topics as HTML
370
    packages.append('docutils') # html formatting
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
371
    # but we can avoid many Qt4 Dlls.
372
    dll_excludes.extend(
373
        """QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
374
        QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
375
        QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
376
        qscintilla2.dll""".split())
377
    # the qt binaries might not be on PATH...
378
    qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
379
    path = os.environ.get("PATH","")
380
    if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
381
        os.environ["PATH"] = path + os.pathsep + qt_dir
382
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
383
1860.1.2 by Alexander Belchenko
setup.py:
384
if 'bdist_wininst' in sys.argv:
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
385
    def find_docs():
386
        docs = []
387
        for root, dirs, files in os.walk('doc'):
388
            r = []
389
            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)
390
                if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
391
                    or f == 'quick-start-summary.svg'):
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
392
                    r.append(os.path.join(root, f))
393
            if r:
394
                relative = root[4:]
395
                if relative:
396
                    target = os.path.join('Doc\\Bazaar', relative)
397
                else:
398
                    target = 'Doc\\Bazaar'
399
                docs.append((target, r))
400
        return docs
401
1860.1.2 by Alexander Belchenko
setup.py:
402
    # python's distutils-based win32 installer
403
    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
404
            'ext_modules': ext_modules,
1860.1.3 by Alexander Belchenko
python-installer:
405
            # help pages
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
406
            'data_files': find_docs(),
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
407
            # 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.
408
            'cmdclass': {'build_ext': build_ext_if_possible},
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
409
           }
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
410
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
411
    ARGS.update(META_INFO)
412
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
413
    ARGS.update(PKG_DATA)
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
414
    
415
    setup(**ARGS)
416
1860.1.2 by Alexander Belchenko
setup.py:
417
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
418
    import glob
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
419
    # py2exe setup
420
    import py2exe
421
422
    # pick real bzr version
423
    import bzrlib
424
425
    version_number = []
426
    for i in bzrlib.version_info[:4]:
427
        try:
428
            i = int(i)
429
        except ValueError:
430
            i = 0
431
        version_number.append(str(i))
432
    version_str = '.'.join(version_number)
433
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
434
    # An override to install_data used only by py2exe builds, which arranges
435
    # to byte-compile any .py files in data_files (eg, our plugins)
436
    # Necessary as we can't rely on the user having the relevant permissions
437
    # to the "Program Files" directory to generate them on the fly.
438
    class install_data_with_bytecompile(install_data):
439
        def run(self):
440
            from distutils.util import byte_compile
441
442
            install_data.run(self)
443
444
            py2exe = self.distribution.get_command_obj('py2exe', False)
445
            optimize = py2exe.optimize
446
            compile_names = [f for f in self.outfiles if f.endswith('.py')]
447
            byte_compile(compile_names,
448
                         optimize=optimize,
449
                         force=self.force, prefix=self.install_dir,
450
                         dry_run=self.dry_run)
451
            if optimize:
452
                suffix = 'o'
453
            else:
454
                suffix = 'c'
455
            self.outfiles.extend([f + suffix for f in compile_names])
456
    # end of class install_data_with_bytecompile
457
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
458
    target = py2exe.build_exe.Target(script = "bzr",
459
                                     dest_base = "bzr",
460
                                     icon_resources = [(0,'bzr.ico')],
461
                                     name = META_INFO['name'],
462
                                     version = version_str,
463
                                     description = META_INFO['description'],
464
                                     author = META_INFO['author'],
2232.1.1 by mbp at sourcefrog
update global copyright to 2007
465
                                     copyright = "(c) Canonical Ltd, 2005-2007",
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
466
                                     company_name = "Canonical Ltd.",
467
                                     comments = META_INFO['description'],
468
                                    )
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
469
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
470
    packages = BZRLIB['packages']
471
    packages.remove('bzrlib')
472
    packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
473
    includes = []
474
    for i in glob.glob('bzrlib\\*.py'):
475
        module = i[:-3].replace('\\', '.')
3193.7.9 by Alexander Belchenko
Ian's review
476
        if module.endswith('__init__'):
477
            module = module[:-len('__init__')]
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
478
        includes.append(module)
479
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)
480
    additional_packages = set()
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
481
    if sys.version.startswith('2.4'):
482
        # 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)
483
        additional_packages.add('elementtree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
484
    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)
485
        additional_packages.add('xml.etree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
486
    else:
487
        import warnings
488
        warnings.warn('Unknown Python version.\n'
489
                      'Please check setup.py script for compatibility.')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
490
491
    # Although we currently can't enforce it, we consider it an error for
492
    # py2exe to report any files are "missing".  Such modules we know aren't
493
    # used should be listed here.
494
    excludes = """Tkinter psyco ElementPath r_hmac
495
                  ImaginaryModule cElementTree elementtree.ElementTree
496
                  Crypto.PublicKey._fastmath
497
                  medusa medusa.filesys medusa.ftp_server
498
                  tools tools.doc_generate
499
                  resource validate""".split()
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
500
    dll_excludes = []
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
501
2571.3.2 by Alexander Belchenko
Build pyrex/C extensions for bzr.exe
502
    # email package from std python library use lazy import,
503
    # 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)
504
    additional_packages.add('email')
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
505
    # And it uses funky mappings to conver to 'Oldname' to 'newname'.  As
506
    # a result, packages like 'email.Parser' show as missing.  Tell py2exe
507
    # to exclude them.
508
    import email
509
    for oldname in getattr(email, '_LOWERNAMES', []):
510
        excludes.append("email." + oldname)
511
    for oldname in getattr(email, '_MIMENAMES', []):
512
        excludes.append("email.MIME" + oldname)
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
513
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).
514
    # text files for help topis
3089.3.6 by Ian Clatworthy
make help topics more discoverable
515
    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
516
    topics_files = [('lib/help_topics/en', text_topics)]
517
518
    # built-in plugins
519
    plugins_files = []
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
520
    # XXX - should we consider having the concept of an 'official' build,
521
    # which hard-codes the list of plugins, gets more upset if modules are
522
    # missing, etc?
523
    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
524
    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.
525
        if root == 'bzrlib/plugins':
526
            plugins = set(dirs)
3193.7.3 by Alexander Belchenko
bzr.exe: move builtin plugins (launchpad, multiparent) out of library.zip to plugins directory
527
        x = []
528
        for i in files:
3684.3.1 by Mark Hammond
pickup l10n files from plugins.
529
            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
530
                continue
531
            if i == '__init__.py' and root == 'bzrlib/plugins':
532
                continue
533
            x.append(os.path.join(root, i))
534
        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)
535
            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
536
            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)
537
    # find modules for built-in plugins
538
    import tools.package_mf
539
    mf = tools.package_mf.CustomModuleFinder()
540
    mf.run_package('bzrlib/plugins')
541
    packs, mods = mf.get_result()
542
    additional_packages.update(packs)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
543
    includes.extend(mods)
544
545
    console_targets = [target,
546
                       'tools/win32/bzr_postinstall.py',
547
                       ]
548
    gui_targets = []
549
    com_targets = []
550
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
551
    if 'qbzr' in plugins:
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
552
        get_qbzr_py2exe_info(includes, excludes, packages)
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
553
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
554
    if "TBZR" in os.environ:
3565.5.9 by Mark Hammond
Address John's review comments
555
        # TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
556
        # TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
557
        # can be downloaded from (username=guest, blank password):
558
        # http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
559
        if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
560
                                             '<nofile>')):
561
            raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
562
                               " location of the Win32 TortoiseOverlays .msi"
563
                               " installer file")
3565.5.6 by Mark Hammond
move tbzr and qbzr py2exe config code into their own functions.
564
        get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
565
                             gui_targets)
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
566
    else:
567
        # print this warning to stderr as output is redirected, so it is seen
568
        # at build time.  Also to stdout so it appears in the log
569
        for f in (sys.stderr, sys.stdout):
570
            print >> f, \
571
                "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
572
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
573
    # MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
574
    # in on Vista.
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
575
    dll_excludes.append("MSWSOCK.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)
576
    options_list = {"py2exe": {"packages": packages + list(additional_packages),
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
577
                               "includes": includes,
578
                               "excludes": excludes,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
579
                               "dll_excludes": dll_excludes,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
580
                               "dist_dir": "win32_bzr.exe",
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
581
                               "optimize": 1,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
582
                              },
583
                   }
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
584
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
585
    setup(options=options_list,
3565.5.1 by Mark Hammond
merge setup.py changes for tbzr
586
          console=console_targets,
587
          windows=gui_targets,
588
          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).
589
          zipfile='lib/library.zip',
3193.7.9 by Alexander Belchenko
Ian's review
590
          data_files=topics_files + plugins_files,
3565.5.4 by Mark Hammond
byte-compile plugins; tweaks so qbzr and bzrsvn can be packaged.
591
          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).
592
          )
1860.1.2 by Alexander Belchenko
setup.py:
593
594
else:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
595
    # ad-hoc for easy_install
596
    DATA_FILES = []
597
    if not 'bdist_egg' in sys.argv:
598
        # generate and install bzr.1 only with plain install, not easy_install one
599
        DATA_FILES = [('man/man1', ['bzr.1'])]
600
1860.1.2 by Alexander Belchenko
setup.py:
601
    # std setup
602
    ARGS = {'scripts': ['bzr'],
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
603
            'data_files': DATA_FILES,
1739.1.3 by Robert Collins
Merge bzr.dev.
604
            'cmdclass': command_classes,
605
            'ext_modules': ext_modules,
1860.1.2 by Alexander Belchenko
setup.py:
606
           }
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
607
1860.1.2 by Alexander Belchenko
setup.py:
608
    ARGS.update(META_INFO)
609
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
610
    ARGS.update(PKG_DATA)
1860.1.2 by Alexander Belchenko
setup.py:
611
612
    setup(**ARGS)