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': 'https://launchpad.net/bzr/+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._btree_serializer_pyx')
269
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
270
add_pyrex_extension('bzrlib._groupcompress_pyx',
271
extra_source=['bzrlib/diff-delta.c'])
272
add_pyrex_extension('bzrlib._knit_load_data_pyx')
273
add_pyrex_extension('bzrlib._known_graph_pyx')
274
add_pyrex_extension('bzrlib._rio_pyx')
275
if sys.platform == 'win32':
276
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
277
libraries=['Ws2_32'])
278
add_pyrex_extension('bzrlib._walkdirs_win32')
281
if have_pyrex and pyrex_version.startswith('0.9.4'):
282
# Pyrex 0.9.4.1 fails to compile this extension correctly
283
# The code it generates re-uses a "local" pointer and
284
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
285
# which is NULL safe with PY_DECREF which is not.)
286
# <https://bugs.edge.launchpad.net/bzr/+bug/449372>
287
# <https://bugs.edge.launchpad.net/bzr/+bug/276868>
288
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
289
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
291
print 'install. For now, the non-compiled (python) version will'
292
print 'be used instead.'
294
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
295
add_pyrex_extension('bzrlib._readdir_pyx')
297
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
298
ext_modules.append(Extension('bzrlib._patiencediff_c',
299
['bzrlib/_patiencediff_c.c']))
302
if unavailable_files:
303
print 'C extension(s) not found:'
304
print ' %s' % ('\n '.join(unavailable_files),)
305
print 'The python versions will be used instead.'
309
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
310
gui_targets, data_files):
311
packages.append('tbzrcommands')
313
# ModuleFinder can't handle runtime changes to __path__, but
314
# win32com uses them. Hook this in so win32com.shell is found.
317
import cPickle as pickle
318
for p in win32com.__path__[1:]:
319
modulefinder.AddPackagePath("win32com", p)
320
for extra in ["win32com.shell"]:
322
m = sys.modules[extra]
323
for p in m.__path__[1:]:
324
modulefinder.AddPackagePath(extra, p)
326
# TBZR points to the TBZR directory
327
tbzr_root = os.environ["TBZR"]
329
# Ensure tbzrlib itself is on sys.path
330
sys.path.append(tbzr_root)
332
packages.append("tbzrlib")
334
# collect up our icons.
336
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
337
icos = [] # list of (path_root, relative_ico_path)
338
# First always bzr's icon and its in the root of the bzr tree.
339
icos.append(('', 'bzr.ico'))
340
for root, dirs, files in os.walk(ico_root):
341
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
342
for f in files if f.endswith('.ico')])
343
# allocate an icon ID for each file and the full path to the ico
344
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
345
for rid, (ico_dir, ico_name) in enumerate(icos)]
346
# create a string resource with the mapping. Might as well save the
347
# runtime some effort and write a pickle.
348
# Runtime expects unicode objects with forward-slash seps.
349
fse = sys.getfilesystemencoding()
350
map_items = [(f.replace('\\', '/').decode(fse), rid)
351
for rid, (_, f) in enumerate(icos)]
352
ico_map = dict(map_items)
353
# Create a new resource type of 'ICON_MAP', and use ID=1
354
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
356
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
357
win32ui crawler.Crawler""".split())
359
# tbzrcache executables - a "console" version for debugging and a
360
# GUI version that is generally used.
362
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
363
icon_resources = icon_resources,
364
other_resources = other_resources,
366
console_targets.append(tbzrcache)
368
# Make a windows version which is the same except for the base name.
369
tbzrcachew = tbzrcache.copy()
370
tbzrcachew["dest_base"]="tbzrcachew"
371
gui_targets.append(tbzrcachew)
373
# ditto for the tbzrcommand tool
375
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
376
icon_resources = [(0,'bzr.ico')],
378
console_targets.append(tbzrcommand)
379
tbzrcommandw = tbzrcommand.copy()
380
tbzrcommandw["dest_base"]="tbzrcommandw"
381
gui_targets.append(tbzrcommandw)
383
# A utility to see python output from both C++ and Python based shell
385
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
386
console_targets.append(tracer)
388
# The C++ implemented shell extensions.
389
dist_dir = os.path.join(tbzr_root, "shellext", "build")
390
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
391
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
394
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
395
# PyQt4 itself still escapes the plugin detection code for some reason...
396
packages.append('PyQt4')
397
excludes.append('PyQt4.elementtree.ElementTree')
398
includes.append('sip') # extension module required for Qt.
399
packages.append('pygments') # colorizer for qbzr
400
packages.append('docutils') # html formatting
401
includes.append('win32event') # for qsubprocess stuff
402
# but we can avoid many Qt4 Dlls.
404
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
405
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
406
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
407
qscintilla2.dll""".split())
408
# the qt binaries might not be on PATH...
409
# They seem to install to a place like C:\Python25\PyQt4\*
410
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
411
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
412
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
413
if os.path.isdir(pyqt_bin_dir):
414
path = os.environ.get("PATH", "")
415
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
416
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
417
# also add all imageformat plugins to distribution
418
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
419
base_dirs_to_check = []
420
if os.path.isdir(pyqt_dir):
421
base_dirs_to_check.append(pyqt_dir)
427
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
428
if pyqt4_base_dir != pyqt_dir:
429
base_dirs_to_check.append(pyqt4_base_dir)
430
if not base_dirs_to_check:
431
log.warn("Can't find PyQt4 installation -> not including imageformat"
435
for base_dir in base_dirs_to_check:
436
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
437
if os.path.isdir(plug_dir):
438
for fname in os.listdir(plug_dir):
439
# Include plugin dlls, but not debugging dlls
440
fullpath = os.path.join(plug_dir, fname)
441
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
442
files.append(fullpath)
444
data_files.append(('imageformats', files))
446
log.warn('PyQt4 was found, but we could not find any imageformat'
447
' plugins. Are you sure your configuration is correct?')
450
def get_svn_py2exe_info(includes, excludes, packages):
451
packages.append('subvertpy')
454
if 'bdist_wininst' in sys.argv:
457
for root, dirs, files in os.walk('doc'):
460
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
461
or f == 'quick-start-summary.svg'):
462
r.append(os.path.join(root, f))
466
target = os.path.join('Doc\\Bazaar', relative)
468
target = 'Doc\\Bazaar'
469
docs.append((target, r))
472
# python's distutils-based win32 installer
473
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
474
'ext_modules': ext_modules,
476
'data_files': find_docs(),
477
# for building pyrex extensions
478
'cmdclass': {'build_ext': build_ext_if_possible},
481
ARGS.update(META_INFO)
483
ARGS.update(PKG_DATA)
487
elif 'py2exe' in sys.argv:
492
# pick real bzr version
496
for i in bzrlib.version_info[:4]:
501
version_number.append(str(i))
502
version_str = '.'.join(version_number)
504
# An override to install_data used only by py2exe builds, which arranges
505
# to byte-compile any .py files in data_files (eg, our plugins)
506
# Necessary as we can't rely on the user having the relevant permissions
507
# to the "Program Files" directory to generate them on the fly.
508
class install_data_with_bytecompile(install_data):
510
from distutils.util import byte_compile
512
install_data.run(self)
514
py2exe = self.distribution.get_command_obj('py2exe', False)
515
optimize = py2exe.optimize
516
compile_names = [f for f in self.outfiles if f.endswith('.py')]
517
byte_compile(compile_names,
519
force=self.force, prefix=self.install_dir,
520
dry_run=self.dry_run)
525
self.outfiles.extend([f + suffix for f in compile_names])
526
# end of class install_data_with_bytecompile
528
target = py2exe.build_exe.Target(script = "bzr",
530
icon_resources = [(0,'bzr.ico')],
531
name = META_INFO['name'],
532
version = version_str,
533
description = META_INFO['description'],
534
author = META_INFO['author'],
535
copyright = "(c) Canonical Ltd, 2005-2009",
536
company_name = "Canonical Ltd.",
537
comments = META_INFO['description'],
540
packages = BZRLIB['packages']
541
packages.remove('bzrlib')
542
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
544
for i in glob.glob('bzrlib\\*.py'):
545
module = i[:-3].replace('\\', '.')
546
if module.endswith('__init__'):
547
module = module[:-len('__init__')]
548
includes.append(module)
550
additional_packages = set()
551
if sys.version.startswith('2.4'):
552
# adding elementtree package
553
additional_packages.add('elementtree')
554
elif sys.version.startswith('2.5'):
555
additional_packages.add('xml.etree')
558
warnings.warn('Unknown Python version.\n'
559
'Please check setup.py script for compatibility.')
561
# Although we currently can't enforce it, we consider it an error for
562
# py2exe to report any files are "missing". Such modules we know aren't
563
# used should be listed here.
564
excludes = """Tkinter psyco ElementPath r_hmac
565
ImaginaryModule cElementTree elementtree.ElementTree
566
Crypto.PublicKey._fastmath
567
medusa medusa.filesys medusa.ftp_server
569
resource validate""".split()
572
# email package from std python library use lazy import,
573
# so we need to explicitly add all package
574
additional_packages.add('email')
575
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
576
# a result, packages like 'email.Parser' show as missing. Tell py2exe
579
for oldname in getattr(email, '_LOWERNAMES', []):
580
excludes.append("email." + oldname)
581
for oldname in getattr(email, '_MIMENAMES', []):
582
excludes.append("email.MIME" + oldname)
584
# text files for help topis
585
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
586
topics_files = [('lib/help_topics/en', text_topics)]
590
# XXX - should we consider having the concept of an 'official' build,
591
# which hard-codes the list of plugins, gets more upset if modules are
593
plugins = None # will be a set after plugin sniffing...
594
for root, dirs, files in os.walk('bzrlib/plugins'):
595
if root == 'bzrlib/plugins':
597
# We ship plugins as normal files on the file-system - however,
598
# the build process can cause *some* of these plugin files to end
599
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
600
# library.zip, and then saw import errors related to that as the
601
# rest of the svn plugin wasn't. So we tell py2exe to leave the
602
# plugins out of the .zip file
603
excludes.extend(["bzrlib.plugins." + d for d in dirs])
606
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
608
if i == '__init__.py' and root == 'bzrlib/plugins':
610
x.append(os.path.join(root, i))
612
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
613
plugins_files.append((target_dir, x))
614
# find modules for built-in plugins
615
import tools.package_mf
616
mf = tools.package_mf.CustomModuleFinder()
617
mf.run_package('bzrlib/plugins')
618
packs, mods = mf.get_result()
619
additional_packages.update(packs)
620
includes.extend(mods)
622
console_targets = [target,
623
'tools/win32/bzr_postinstall.py',
626
data_files = topics_files + plugins_files
628
if 'qbzr' in plugins:
629
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
632
get_svn_py2exe_info(includes, excludes, packages)
634
if "TBZR" in os.environ:
635
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
636
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
637
# can be downloaded from (username=guest, blank password):
638
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
639
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
640
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
641
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
642
'TORTOISE_OVERLAYS_MSI_X64'):
643
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
645
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
647
"\nPlease set %s to the location of the relevant"
648
"\nTortoiseOverlays .msi installer file."
649
" The installers can be found at"
651
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
652
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
653
gui_targets, data_files)
655
# print this warning to stderr as output is redirected, so it is seen
656
# at build time. Also to stdout so it appears in the log
657
for f in (sys.stderr, sys.stdout):
659
"Skipping TBZR binaries - please set TBZR to a directory to enable"
661
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
663
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
664
options_list = {"py2exe": {"packages": packages + list(additional_packages),
665
"includes": includes,
666
"excludes": excludes,
667
"dll_excludes": dll_excludes,
668
"dist_dir": "win32_bzr.exe",
673
setup(options=options_list,
674
console=console_targets,
676
zipfile='lib/library.zip',
677
data_files=data_files,
678
cmdclass={'install_data': install_data_with_bytecompile},
682
# ad-hoc for easy_install
684
if not 'bdist_egg' in sys.argv:
685
# generate and install bzr.1 only with plain install, not the
687
DATA_FILES = [('man/man1', ['bzr.1'])]
690
ARGS = {'scripts': ['bzr'],
691
'data_files': DATA_FILES,
692
'cmdclass': command_classes,
693
'ext_modules': ext_modules,
696
ARGS.update(META_INFO)
698
ARGS.update(PKG_DATA)
added
removed
setup.py
