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
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")
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',
68
'tests/ssl_certs/server_without_pass.key',
69
'tests/ssl_certs/server_with_pass.key',
70
'tests/ssl_certs/server.crt'
75
def get_bzrlib_packages():
76
"""Recurse through the bzrlib directory, and extract the package names"""
79
base_path = os.path.dirname(os.path.abspath(bzrlib.__file__))
80
for root, dirs, files in os.walk(base_path):
81
if '__init__.py' in files:
82
assert root.startswith(base_path)
83
# Get just the path below bzrlib
84
package_path = root[len(base_path):]
85
# Remove leading and trailing slashes
86
package_path = package_path.strip('\\/')
88
package_name = 'bzrlib'
90
package_name = ('bzrlib.' +
91
package_path.replace('/', '.').replace('\\', '.'))
92
packages.append(package_name)
93
return sorted(packages)
96
BZRLIB['packages'] = get_bzrlib_packages()
99
from distutils import log
7
100
from distutils.core import setup
12
author_email='mbp@sourcefrog.net',
13
url='http://www.bazaar-ng.org/',
14
description='Friendly distributed version control system',
101
from distutils.command.install_scripts import install_scripts
102
from distutils.command.install_data import install_data
103
from distutils.command.build import build
105
###############################
106
# Overridden distutils actions
107
###############################
109
class my_install_scripts(install_scripts):
110
""" Customized install_scripts distutils action.
111
Create bzr.bat for win32.
114
install_scripts.run(self) # standard action
116
if sys.platform == "win32":
118
scripts_dir = os.path.join(sys.prefix, 'Scripts')
119
script_path = self._quoted_path(os.path.join(scripts_dir,
121
python_exe = self._quoted_path(sys.executable)
122
args = self._win_batch_args()
123
batch_str = "@%s %s %s" % (python_exe, script_path, args)
124
batch_path = os.path.join(self.install_dir, "bzr.bat")
125
f = file(batch_path, "w")
128
print "Created:", batch_path
130
print "ERROR: Unable to create %s: %s" % (batch_path, e)
132
def _quoted_path(self, path):
134
return '"' + path + '"'
138
def _win_batch_args(self):
139
from bzrlib.win32utils import winver
140
if winver == 'Windows NT':
143
return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
144
#/class my_install_scripts
147
class bzr_build(build):
148
"""Customized build distutils action.
155
from tools import generate_docs
156
generate_docs.main(argv=["bzr", "man"])
159
########################
161
########################
163
command_classes = {'install_scripts': my_install_scripts,
165
from distutils import log
166
from distutils.errors import CCompilerError, DistutilsPlatformError
167
from distutils.extension import Extension
170
from Pyrex.Distutils import build_ext
173
# try to build the extension from the prior generated source.
175
print ("The python package 'Pyrex' is not available."
176
" If the .c files are available,")
177
print ("they will be built,"
178
" but modifying the .pyx files will not rebuild them.")
180
from distutils.command.build_ext import build_ext
183
from Pyrex.Compiler.Version import version as pyrex_version
186
class build_ext_if_possible(build_ext):
188
user_options = build_ext.user_options + [
189
('allow-python-fallback', None,
190
"When an extension cannot be built, allow falling"
191
" back to the pure-python implementation.")
194
def initialize_options(self):
195
build_ext.initialize_options(self)
196
self.allow_python_fallback = False
201
except DistutilsPlatformError, e:
202
if not self.allow_python_fallback:
203
log.warn('\n Cannot build extensions.\n'
204
' Use "build_ext --allow-python-fallback" to use'
205
' slower python implementations instead.\n')
208
log.warn('\n Extensions cannot be built.\n'
209
' Using the slower Python implementations instead.\n')
211
def build_extension(self, ext):
213
build_ext.build_extension(self, ext)
214
except CCompilerError:
215
if not self.allow_python_fallback:
216
log.warn('\n Cannot build extension "%s".\n'
217
' Use "build_ext --allow-python-fallback" to use'
218
' slower python implementations instead.\n'
221
log.warn('\n Building of "%s" extension failed.\n'
222
' Using the slower Python implementation instead.'
226
# Override the build_ext if we have Pyrex available
227
command_classes['build_ext'] = build_ext_if_possible
228
unavailable_files = []
231
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
232
"""Add a pyrex module to build.
234
This will use Pyrex to auto-generate the .c file if it is available.
235
Otherwise it will fall back on the .c file. If the .c file is not
236
available, it will warn, and not add anything.
238
You can pass any extra options to Extension through kwargs. One example is
241
:param module_name: The python path to the module. This will be used to
242
determine the .pyx and .c files to use.
244
path = module_name.replace('.', '/')
245
pyrex_name = path + '.pyx'
248
if sys.platform == 'win32':
249
# pyrex uses the macro WIN32 to detect the platform, even though it
250
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
251
# give it the right value.
252
define_macros.append(('WIN32', None))
254
source = [pyrex_name]
256
if not os.path.isfile(c_name):
257
unavailable_files.append(c_name)
261
source.extend(extra_source)
262
ext_modules.append(Extension(module_name, source,
263
define_macros=define_macros, libraries=libraries))
266
add_pyrex_extension('bzrlib._annotator_pyx')
267
add_pyrex_extension('bzrlib._bencode_pyx')
268
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
269
add_pyrex_extension('bzrlib._groupcompress_pyx',
270
extra_source=['bzrlib/diff-delta.c'])
271
add_pyrex_extension('bzrlib._knit_load_data_pyx')
272
add_pyrex_extension('bzrlib._known_graph_pyx')
273
add_pyrex_extension('bzrlib._rio_pyx')
274
if sys.platform == 'win32':
275
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
276
libraries=['Ws2_32'])
277
add_pyrex_extension('bzrlib._walkdirs_win32')
280
if have_pyrex and pyrex_version == '0.9.4.1':
281
# Pyrex 0.9.4.1 fails to compile this extension correctly
282
# The code it generates re-uses a "local" pointer and
283
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
284
# which is NULL safe with PY_DECREF which is not.)
285
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
286
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
288
print 'install. For now, the non-compiled (python) version will'
289
print 'be used instead.'
291
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
292
add_pyrex_extension('bzrlib._readdir_pyx')
294
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
295
ext_modules.append(Extension('bzrlib._patiencediff_c',
296
['bzrlib/_patiencediff_c.c']))
297
add_pyrex_extension('bzrlib._simple_set_pyx')
298
ext_modules.append(Extension('bzrlib._static_tuple_c',
299
['bzrlib/_static_tuple_c.c']))
300
add_pyrex_extension('bzrlib._btree_serializer_pyx')
303
if unavailable_files:
304
print 'C extension(s) not found:'
305
print ' %s' % ('\n '.join(unavailable_files),)
306
print 'The python versions will be used instead.'
310
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
311
gui_targets, data_files):
312
packages.append('tbzrcommands')
314
# ModuleFinder can't handle runtime changes to __path__, but
315
# win32com uses them. Hook this in so win32com.shell is found.
318
import cPickle as pickle
319
for p in win32com.__path__[1:]:
320
modulefinder.AddPackagePath("win32com", p)
321
for extra in ["win32com.shell"]:
323
m = sys.modules[extra]
324
for p in m.__path__[1:]:
325
modulefinder.AddPackagePath(extra, p)
327
# TBZR points to the TBZR directory
328
tbzr_root = os.environ["TBZR"]
330
# Ensure tbzrlib itself is on sys.path
331
sys.path.append(tbzr_root)
333
# Ensure our COM "entry-point" is on sys.path
334
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
336
packages.append("tbzrlib")
338
# collect up our icons.
340
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
341
icos = [] # list of (path_root, relative_ico_path)
342
# First always bzr's icon and its in the root of the bzr tree.
343
icos.append(('', 'bzr.ico'))
344
for root, dirs, files in os.walk(ico_root):
345
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
346
for f in files if f.endswith('.ico')])
347
# allocate an icon ID for each file and the full path to the ico
348
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
349
for rid, (ico_dir, ico_name) in enumerate(icos)]
350
# create a string resource with the mapping. Might as well save the
351
# runtime some effort and write a pickle.
352
# Runtime expects unicode objects with forward-slash seps.
353
fse = sys.getfilesystemencoding()
354
map_items = [(f.replace('\\', '/').decode(fse), rid)
355
for rid, (_, f) in enumerate(icos)]
356
ico_map = dict(map_items)
357
# Create a new resource type of 'ICON_MAP', and use ID=1
358
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
360
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
361
win32ui crawler.Crawler""".split())
363
# NOTE: We still create a DLL version of the Python implemented shell
364
# extension for testing purposes - but it is *not* registered by
365
# default - our C++ one is instead. To discourage people thinking
366
# this DLL is still necessary, its called 'tbzr_old.dll'
369
create_exe = False, # we only want a .dll
370
dest_base = 'tbzr_old',
372
com_targets.append(tbzr)
374
# tbzrcache executables - a "console" version for debugging and a
375
# GUI version that is generally used.
377
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
378
icon_resources = icon_resources,
379
other_resources = other_resources,
381
console_targets.append(tbzrcache)
383
# Make a windows version which is the same except for the base name.
384
tbzrcachew = tbzrcache.copy()
385
tbzrcachew["dest_base"]="tbzrcachew"
386
gui_targets.append(tbzrcachew)
388
# ditto for the tbzrcommand tool
390
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
391
icon_resources = [(0,'bzr.ico')],
393
console_targets.append(tbzrcommand)
394
tbzrcommandw = tbzrcommand.copy()
395
tbzrcommandw["dest_base"]="tbzrcommandw"
396
gui_targets.append(tbzrcommandw)
398
# A utility to see python output from both C++ and Python based shell
400
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
401
console_targets.append(tracer)
403
# The C++ implemented shell extensions.
404
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
406
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
407
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
410
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
411
# PyQt4 itself still escapes the plugin detection code for some reason...
412
packages.append('PyQt4')
413
excludes.append('PyQt4.elementtree.ElementTree')
414
includes.append('sip') # extension module required for Qt.
415
packages.append('pygments') # colorizer for qbzr
416
packages.append('docutils') # html formatting
417
includes.append('win32event') # for qsubprocess stuff
418
# but we can avoid many Qt4 Dlls.
420
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
421
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
422
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
423
qscintilla2.dll""".split())
424
# the qt binaries might not be on PATH...
425
# They seem to install to a place like C:\Python25\PyQt4\*
426
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
427
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
428
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
429
if os.path.isdir(pyqt_bin_dir):
430
path = os.environ.get("PATH", "")
431
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
432
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
433
# also add all imageformat plugins to distribution
434
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
435
base_dirs_to_check = []
436
if os.path.isdir(pyqt_dir):
437
base_dirs_to_check.append(pyqt_dir)
443
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
444
if pyqt4_base_dir != pyqt_dir:
445
base_dirs_to_check.append(pyqt4_base_dir)
446
if not base_dirs_to_check:
447
log.warn("Can't find PyQt4 installation -> not including imageformat"
451
for base_dir in base_dirs_to_check:
452
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
453
if os.path.isdir(plug_dir):
454
for fname in os.listdir(plug_dir):
455
# Include plugin dlls, but not debugging dlls
456
fullpath = os.path.join(plug_dir, fname)
457
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
458
files.append(fullpath)
460
data_files.append(('imageformats', files))
462
log.warn('PyQt4 was found, but we could not find any imageformat'
463
' plugins. Are you sure your configuration is correct?')
466
def get_svn_py2exe_info(includes, excludes, packages):
467
packages.append('subvertpy')
470
if 'bdist_wininst' in sys.argv:
473
for root, dirs, files in os.walk('doc'):
476
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
477
or f == 'quick-start-summary.svg'):
478
r.append(os.path.join(root, f))
482
target = os.path.join('Doc\\Bazaar', relative)
484
target = 'Doc\\Bazaar'
485
docs.append((target, r))
488
# python's distutils-based win32 installer
489
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
490
'ext_modules': ext_modules,
492
'data_files': find_docs(),
493
# for building pyrex extensions
494
'cmdclass': {'build_ext': build_ext_if_possible},
497
ARGS.update(META_INFO)
499
ARGS.update(PKG_DATA)
503
elif 'py2exe' in sys.argv:
508
# pick real bzr version
512
for i in bzrlib.version_info[:4]:
517
version_number.append(str(i))
518
version_str = '.'.join(version_number)
520
# An override to install_data used only by py2exe builds, which arranges
521
# to byte-compile any .py files in data_files (eg, our plugins)
522
# Necessary as we can't rely on the user having the relevant permissions
523
# to the "Program Files" directory to generate them on the fly.
524
class install_data_with_bytecompile(install_data):
526
from distutils.util import byte_compile
528
install_data.run(self)
530
py2exe = self.distribution.get_command_obj('py2exe', False)
531
optimize = py2exe.optimize
532
compile_names = [f for f in self.outfiles if f.endswith('.py')]
533
byte_compile(compile_names,
535
force=self.force, prefix=self.install_dir,
536
dry_run=self.dry_run)
541
self.outfiles.extend([f + suffix for f in compile_names])
542
# end of class install_data_with_bytecompile
544
target = py2exe.build_exe.Target(script = "bzr",
546
icon_resources = [(0,'bzr.ico')],
547
name = META_INFO['name'],
548
version = version_str,
549
description = META_INFO['description'],
550
author = META_INFO['author'],
551
copyright = "(c) Canonical Ltd, 2005-2009",
552
company_name = "Canonical Ltd.",
553
comments = META_INFO['description'],
556
packages = BZRLIB['packages']
557
packages.remove('bzrlib')
558
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
560
for i in glob.glob('bzrlib\\*.py'):
561
module = i[:-3].replace('\\', '.')
562
if module.endswith('__init__'):
563
module = module[:-len('__init__')]
564
includes.append(module)
566
additional_packages = set()
567
if sys.version.startswith('2.4'):
568
# adding elementtree package
569
additional_packages.add('elementtree')
570
elif sys.version.startswith('2.5'):
571
additional_packages.add('xml.etree')
574
warnings.warn('Unknown Python version.\n'
575
'Please check setup.py script for compatibility.')
577
# Although we currently can't enforce it, we consider it an error for
578
# py2exe to report any files are "missing". Such modules we know aren't
579
# used should be listed here.
580
excludes = """Tkinter psyco ElementPath r_hmac
581
ImaginaryModule cElementTree elementtree.ElementTree
582
Crypto.PublicKey._fastmath
583
medusa medusa.filesys medusa.ftp_server
585
resource validate""".split()
588
# email package from std python library use lazy import,
589
# so we need to explicitly add all package
590
additional_packages.add('email')
591
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
592
# a result, packages like 'email.Parser' show as missing. Tell py2exe
595
for oldname in getattr(email, '_LOWERNAMES', []):
596
excludes.append("email." + oldname)
597
for oldname in getattr(email, '_MIMENAMES', []):
598
excludes.append("email.MIME" + oldname)
600
# text files for help topis
601
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
602
topics_files = [('lib/help_topics/en', text_topics)]
606
# XXX - should we consider having the concept of an 'official' build,
607
# which hard-codes the list of plugins, gets more upset if modules are
609
plugins = None # will be a set after plugin sniffing...
610
for root, dirs, files in os.walk('bzrlib/plugins'):
611
if root == 'bzrlib/plugins':
613
# We ship plugins as normal files on the file-system - however,
614
# the build process can cause *some* of these plugin files to end
615
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
616
# library.zip, and then saw import errors related to that as the
617
# rest of the svn plugin wasn't. So we tell py2exe to leave the
618
# plugins out of the .zip file
619
excludes.extend(["bzrlib.plugins." + d for d in dirs])
622
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
624
if i == '__init__.py' and root == 'bzrlib/plugins':
626
x.append(os.path.join(root, i))
628
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
629
plugins_files.append((target_dir, x))
630
# find modules for built-in plugins
631
import tools.package_mf
632
mf = tools.package_mf.CustomModuleFinder()
633
mf.run_package('bzrlib/plugins')
634
packs, mods = mf.get_result()
635
additional_packages.update(packs)
636
includes.extend(mods)
638
console_targets = [target,
639
'tools/win32/bzr_postinstall.py',
643
data_files = topics_files + plugins_files
645
if 'qbzr' in plugins:
646
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
649
get_svn_py2exe_info(includes, excludes, packages)
651
if "TBZR" in os.environ:
652
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
653
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
654
# can be downloaded from (username=guest, blank password):
655
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
656
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
657
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
658
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
659
'TORTOISE_OVERLAYS_MSI_X64'):
660
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
662
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
664
"\nPlease set %s to the location of the relevant"
665
"\nTortoiseOverlays .msi installer file."
666
" The installers can be found at"
668
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
669
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
670
gui_targets, data_files)
672
# print this warning to stderr as output is redirected, so it is seen
673
# at build time. Also to stdout so it appears in the log
674
for f in (sys.stderr, sys.stdout):
676
"Skipping TBZR binaries - please set TBZR to a directory to enable"
678
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
680
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
681
options_list = {"py2exe": {"packages": packages + list(additional_packages),
682
"includes": includes,
683
"excludes": excludes,
684
"dll_excludes": dll_excludes,
685
"dist_dir": "win32_bzr.exe",
690
setup(options=options_list,
691
console=console_targets,
693
com_server=com_targets,
694
zipfile='lib/library.zip',
695
data_files=data_files,
696
cmdclass={'install_data': install_data_with_bytecompile},
700
# ad-hoc for easy_install
702
if not 'bdist_egg' in sys.argv:
703
# generate and install bzr.1 only with plain install, not the
705
DATA_FILES = [('man/man1', ['bzr.1'])]
708
ARGS = {'scripts': ['bzr'],
709
'data_files': DATA_FILES,
710
'cmdclass': command_classes,
711
'ext_modules': ext_modules,
714
ARGS.update(META_INFO)
716
ARGS.update(PKG_DATA)
added
removed
setup.py
