1
1
#! /usr/bin/env python
3
# This is an installation script for bzr. Run it with
4
# './setup.py install', or
5
# './setup.py --help' for more options
7
# Reinvocation stolen from bzr, we need python2.4 by virtue of bzr_man
8
# including bzrlib.help
13
version_info = sys.version_info
14
except AttributeError:
15
version_info = 1, 5 # 1.5 or older
17
REINVOKE = "__BZR_REINVOKE"
19
KNOWN_PYTHONS = ('python2.4',)
21
if version_info < NEED_VERS:
22
if not os.environ.has_key(REINVOKE):
23
# mutating os.environ doesn't work in old Pythons
24
os.putenv(REINVOKE, "1")
25
for python in KNOWN_PYTHONS:
27
os.execvp(python, [python] + sys.argv)
30
print >>sys.stderr, "bzr: error: cannot find a suitable python interpreter"
31
print >>sys.stderr, " (need %d.%d or later)" % NEED_VERS
3
"""Installation script for bzr.
5
'./setup.py install', or
6
'./setup.py --help' for more options
13
if sys.version_info < (2, 4):
14
sys.stderr.write("[ERROR] Not a supported Python version. Need 2.4+\n")
33
if hasattr(os, "unsetenv"):
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...
22
def get_long_description():
23
dirname = os.path.dirname(__file__)
24
readme = os.path.join(dirname, 'README')
25
f = open(readme, 'rb')
33
# META INFORMATION FOR SETUP
34
# see http://docs.python.org/dist/meta-data.html
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',
44
'long_description': get_long_description(),
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',
60
# The list of packages is automatically generated later. Add other things
61
# that are part of BZRLIB here.
64
PKG_DATA = {# install files from selftest suite
65
'package_data': {'bzrlib': ['doc/api/*.txt',
66
'tests/test_patches_data/*',
67
'help_topics/en/*.txt',
72
def get_bzrlib_packages():
73
"""Recurse through the bzrlib directory, and extract the package names"""
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('\\/')
85
package_name = 'bzrlib'
87
package_name = ('bzrlib.' +
88
package_path.replace('/', '.').replace('\\', '.'))
89
packages.append(package_name)
90
return sorted(packages)
93
BZRLIB['packages'] = get_bzrlib_packages()
37
96
from distutils.core import setup
38
97
from distutils.command.install_scripts import install_scripts
98
from distutils.command.install_data import install_data
39
99
from distutils.command.build import build
41
101
###############################
65
125
except Exception, e:
66
126
print "ERROR: Unable to create %s: %s" % (batch_path, e)
128
def _quoted_path(self, path):
130
return '"' + path + '"'
134
def _win_batch_args(self):
135
from bzrlib.win32utils import winver
136
if winver == 'Windows NT':
139
return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
140
#/class my_install_scripts
69
143
class bzr_build(build):
70
144
"""Customized build distutils action.
152
generate_docs.main(argv=["bzr", "man"])
79
155
########################
81
157
########################
86
author_email='mbp@sourcefrog.net',
87
url='http://www.bazaar-ng.org/',
88
description='Friendly distributed version control system',
96
'bzrlib.util.elementtree',
97
'bzrlib.util.effbot.org',
98
'bzrlib.util.configobj',
101
cmdclass={'install_scripts': my_install_scripts, 'build': bzr_build},
102
data_files=[('man/man1', ['bzr.1'])],
159
command_classes = {'install_scripts': my_install_scripts,
161
from distutils import log
162
from distutils.errors import CCompilerError, DistutilsPlatformError
163
from distutils.extension import Extension
166
from Pyrex.Distutils import build_ext
169
# try to build the extension from the prior generated source.
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.")
176
from distutils.command.build_ext import build_ext
179
from Pyrex.Compiler.Version import version as pyrex_version
182
class build_ext_if_possible(build_ext):
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.")
190
def initialize_options(self):
191
build_ext.initialize_options(self)
192
self.allow_python_fallback = False
197
except DistutilsPlatformError, e:
198
if not self.allow_python_fallback:
199
log.warn('\n Cannot build extensions.\n'
200
' Use "build_ext --allow-python-fallback" to use'
201
' slower python implementations instead.\n')
204
log.warn('\n Extensions cannot be built.\n'
205
' Using the slower Python implementations instead.\n')
207
def build_extension(self, ext):
209
build_ext.build_extension(self, ext)
210
except CCompilerError:
211
if not self.allow_python_fallback:
212
log.warn('\n Cannot build extension "%s".\n'
213
' Use "build_ext --allow-python-fallback" to use'
214
' slower python implementations instead.\n'
217
log.warn('\n Building of "%s" extension failed.\n'
218
' Using the slower Python implementation instead.'
222
# Override the build_ext if we have Pyrex available
223
command_classes['build_ext'] = build_ext_if_possible
224
unavailable_files = []
227
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
228
"""Add a pyrex module to build.
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.
234
You can pass any extra options to Extension through kwargs. One example is
237
:param module_name: The python path to the module. This will be used to
238
determine the .pyx and .c files to use.
240
path = module_name.replace('.', '/')
241
pyrex_name = path + '.pyx'
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
248
define_macros.append(('WIN32', None))
250
source = [pyrex_name]
252
if not os.path.isfile(c_name):
253
unavailable_files.append(c_name)
257
source.extend(extra_source)
258
ext_modules.append(Extension(module_name, source,
259
define_macros=define_macros, libraries=libraries))
262
add_pyrex_extension('bzrlib._bencode_pyx')
263
add_pyrex_extension('bzrlib._btree_serializer_c')
264
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=['z'])
265
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
266
add_pyrex_extension('bzrlib._groupcompress_pyx',
267
extra_source=['bzrlib/diff-delta.c'])
268
add_pyrex_extension('bzrlib._knit_load_data_c')
269
add_pyrex_extension('bzrlib._rio_pyx')
270
if sys.platform == 'win32':
271
add_pyrex_extension('bzrlib._dirstate_helpers_c',
272
libraries=['Ws2_32'])
273
add_pyrex_extension('bzrlib._walkdirs_win32')
275
if have_pyrex and pyrex_version == '0.9.4.1':
276
# Pyrex 0.9.4.1 fails to compile this extension correctly
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.)
280
print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
281
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
283
print 'install. For now, the non-compiled (python) version will'
284
print 'be used instead.'
286
add_pyrex_extension('bzrlib._dirstate_helpers_c')
287
add_pyrex_extension('bzrlib._readdir_pyx')
288
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
291
if unavailable_files:
292
print 'C extension(s) not found:'
293
print ' %s' % ('\n '.join(unavailable_files),)
294
print 'The python versions will be used instead.'
298
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
299
gui_targets, data_files):
300
packages.append('tbzrcommands')
302
# ModuleFinder can't handle runtime changes to __path__, but
303
# win32com uses them. Hook this in so win32com.shell is found.
306
import cPickle as pickle
307
for p in win32com.__path__[1:]:
308
modulefinder.AddPackagePath("win32com", p)
309
for extra in ["win32com.shell"]:
311
m = sys.modules[extra]
312
for p in m.__path__[1:]:
313
modulefinder.AddPackagePath(extra, p)
315
# TBZR points to the TBZR directory
316
tbzr_root = os.environ["TBZR"]
318
# Ensure tbzrlib itself is on sys.path
319
sys.path.append(tbzr_root)
321
# Ensure our COM "entry-point" is on sys.path
322
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
324
packages.append("tbzrlib")
326
# collect up our icons.
328
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
329
icos = [] # list of (path_root, relative_ico_path)
330
# First always bzr's icon and its in the root of the bzr tree.
331
icos.append(('', 'bzr.ico'))
332
for root, dirs, files in os.walk(ico_root):
333
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
334
for f in files if f.endswith('.ico')])
335
# allocate an icon ID for each file and the full path to the ico
336
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
337
for rid, (ico_dir, ico_name) in enumerate(icos)]
338
# create a string resource with the mapping. Might as well save the
339
# runtime some effort and write a pickle.
340
# Runtime expects unicode objects with forward-slash seps.
341
fse = sys.getfilesystemencoding()
342
map_items = [(f.replace('\\', '/').decode(fse), rid)
343
for rid, (_, f) in enumerate(icos)]
344
ico_map = dict(map_items)
345
# Create a new resource type of 'ICON_MAP', and use ID=1
346
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
348
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
349
win32ui crawler.Crawler""".split())
351
# NOTE: We still create a DLL version of the Python implemented shell
352
# extension for testing purposes - but it is *not* registered by
353
# default - our C++ one is instead. To discourage people thinking
354
# this DLL is still necessary, its called 'tbzr_old.dll'
357
create_exe = False, # we only want a .dll
358
dest_base = 'tbzr_old',
360
com_targets.append(tbzr)
362
# tbzrcache executables - a "console" version for debugging and a
363
# GUI version that is generally used.
365
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
366
icon_resources = icon_resources,
367
other_resources = other_resources,
369
console_targets.append(tbzrcache)
371
# Make a windows version which is the same except for the base name.
372
tbzrcachew = tbzrcache.copy()
373
tbzrcachew["dest_base"]="tbzrcachew"
374
gui_targets.append(tbzrcachew)
376
# ditto for the tbzrcommand tool
378
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
379
icon_resources = [(0,'bzr.ico')],
381
console_targets.append(tbzrcommand)
382
tbzrcommandw = tbzrcommand.copy()
383
tbzrcommandw["dest_base"]="tbzrcommandw"
384
gui_targets.append(tbzrcommandw)
386
# A utility to see python output from both C++ and Python based shell
388
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
389
console_targets.append(tracer)
391
# The C++ implemented shell extensions.
392
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
394
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
395
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
398
def get_qbzr_py2exe_info(includes, excludes, packages):
399
# PyQt4 itself still escapes the plugin detection code for some reason...
400
packages.append('PyQt4')
401
excludes.append('PyQt4.elementtree.ElementTree')
402
includes.append('sip') # extension module required for Qt.
403
packages.append('pygments') # colorizer for qbzr
404
packages.append('docutils') # html formatting
405
# but we can avoid many Qt4 Dlls.
407
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
408
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
409
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
410
qscintilla2.dll""".split())
411
# the qt binaries might not be on PATH...
412
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
413
path = os.environ.get("PATH","")
414
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
415
os.environ["PATH"] = path + os.pathsep + qt_dir
418
def get_svn_py2exe_info(includes, excludes, packages):
419
packages.append('subvertpy')
422
if 'bdist_wininst' in sys.argv:
425
for root, dirs, files in os.walk('doc'):
428
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
429
or f == 'quick-start-summary.svg'):
430
r.append(os.path.join(root, f))
434
target = os.path.join('Doc\\Bazaar', relative)
436
target = 'Doc\\Bazaar'
437
docs.append((target, r))
440
# python's distutils-based win32 installer
441
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
442
'ext_modules': ext_modules,
444
'data_files': find_docs(),
445
# for building pyrex extensions
446
'cmdclass': {'build_ext': build_ext_if_possible},
449
ARGS.update(META_INFO)
451
ARGS.update(PKG_DATA)
455
elif 'py2exe' in sys.argv:
460
# pick real bzr version
464
for i in bzrlib.version_info[:4]:
469
version_number.append(str(i))
470
version_str = '.'.join(version_number)
472
# An override to install_data used only by py2exe builds, which arranges
473
# to byte-compile any .py files in data_files (eg, our plugins)
474
# Necessary as we can't rely on the user having the relevant permissions
475
# to the "Program Files" directory to generate them on the fly.
476
class install_data_with_bytecompile(install_data):
478
from distutils.util import byte_compile
480
install_data.run(self)
482
py2exe = self.distribution.get_command_obj('py2exe', False)
483
optimize = py2exe.optimize
484
compile_names = [f for f in self.outfiles if f.endswith('.py')]
485
byte_compile(compile_names,
487
force=self.force, prefix=self.install_dir,
488
dry_run=self.dry_run)
493
self.outfiles.extend([f + suffix for f in compile_names])
494
# end of class install_data_with_bytecompile
496
target = py2exe.build_exe.Target(script = "bzr",
498
icon_resources = [(0,'bzr.ico')],
499
name = META_INFO['name'],
500
version = version_str,
501
description = META_INFO['description'],
502
author = META_INFO['author'],
503
copyright = "(c) Canonical Ltd, 2005-2007",
504
company_name = "Canonical Ltd.",
505
comments = META_INFO['description'],
508
packages = BZRLIB['packages']
509
packages.remove('bzrlib')
510
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
512
for i in glob.glob('bzrlib\\*.py'):
513
module = i[:-3].replace('\\', '.')
514
if module.endswith('__init__'):
515
module = module[:-len('__init__')]
516
includes.append(module)
518
additional_packages = set()
519
if sys.version.startswith('2.4'):
520
# adding elementtree package
521
additional_packages.add('elementtree')
522
elif sys.version.startswith('2.5'):
523
additional_packages.add('xml.etree')
526
warnings.warn('Unknown Python version.\n'
527
'Please check setup.py script for compatibility.')
529
# Although we currently can't enforce it, we consider it an error for
530
# py2exe to report any files are "missing". Such modules we know aren't
531
# used should be listed here.
532
excludes = """Tkinter psyco ElementPath r_hmac
533
ImaginaryModule cElementTree elementtree.ElementTree
534
Crypto.PublicKey._fastmath
535
medusa medusa.filesys medusa.ftp_server
536
tools tools.doc_generate
537
resource validate""".split()
540
# email package from std python library use lazy import,
541
# so we need to explicitly add all package
542
additional_packages.add('email')
543
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
544
# a result, packages like 'email.Parser' show as missing. Tell py2exe
547
for oldname in getattr(email, '_LOWERNAMES', []):
548
excludes.append("email." + oldname)
549
for oldname in getattr(email, '_MIMENAMES', []):
550
excludes.append("email.MIME" + oldname)
552
# text files for help topis
553
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
554
topics_files = [('lib/help_topics/en', text_topics)]
558
# XXX - should we consider having the concept of an 'official' build,
559
# which hard-codes the list of plugins, gets more upset if modules are
561
plugins = None # will be a set after plugin sniffing...
562
for root, dirs, files in os.walk('bzrlib/plugins'):
563
if root == 'bzrlib/plugins':
565
# We ship plugins as normal files on the file-system - however,
566
# the build process can cause *some* of these plugin files to end
567
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
568
# library.zip, and then saw import errors related to that as the
569
# rest of the svn plugin wasn't. So we tell py2exe to leave the
570
# plugins out of the .zip file
571
excludes.extend(["bzrlib.plugins." + d for d in dirs])
574
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
576
if i == '__init__.py' and root == 'bzrlib/plugins':
578
x.append(os.path.join(root, i))
580
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
581
plugins_files.append((target_dir, x))
582
# find modules for built-in plugins
583
import tools.package_mf
584
mf = tools.package_mf.CustomModuleFinder()
585
mf.run_package('bzrlib/plugins')
586
packs, mods = mf.get_result()
587
additional_packages.update(packs)
588
includes.extend(mods)
590
console_targets = [target,
591
'tools/win32/bzr_postinstall.py',
595
data_files = topics_files + plugins_files
597
if 'qbzr' in plugins:
598
get_qbzr_py2exe_info(includes, excludes, packages)
601
get_svn_py2exe_info(includes, excludes, packages)
603
if "TBZR" in os.environ:
604
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
605
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
606
# can be downloaded from (username=guest, blank password):
607
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
608
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
609
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
610
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
611
'TORTOISE_OVERLAYS_MSI_X64'):
612
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
614
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
616
"\nPlease set %s to the location of the relevant"
617
"\nTortoiseOverlays .msi installer file."
618
" The installers can be found at"
620
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
621
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
622
gui_targets, data_files)
624
# print this warning to stderr as output is redirected, so it is seen
625
# at build time. Also to stdout so it appears in the log
626
for f in (sys.stderr, sys.stdout):
628
"Skipping TBZR binaries - please set TBZR to a directory to enable"
630
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
632
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
633
options_list = {"py2exe": {"packages": packages + list(additional_packages),
634
"includes": includes,
635
"excludes": excludes,
636
"dll_excludes": dll_excludes,
637
"dist_dir": "win32_bzr.exe",
642
setup(options=options_list,
643
console=console_targets,
645
com_server=com_targets,
646
zipfile='lib/library.zip',
647
data_files=data_files,
648
cmdclass={'install_data': install_data_with_bytecompile},
652
# ad-hoc for easy_install
654
if not 'bdist_egg' in sys.argv:
655
# generate and install bzr.1 only with plain install, not easy_install one
656
DATA_FILES = [('man/man1', ['bzr.1'])]
659
ARGS = {'scripts': ['bzr'],
660
'data_files': DATA_FILES,
661
'cmdclass': command_classes,
662
'ext_modules': ext_modules,
665
ARGS.update(META_INFO)
667
ARGS.update(PKG_DATA)