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
171
from Pyrex.Distutils import build_ext
172
from Pyrex.Compiler.Version import version as pyrex_version
174
print "No Pyrex, trying Cython..."
175
from Cython.Distutils import build_ext
176
from Cython.Compiler.Version import version as pyrex_version
179
# try to build the extension from the prior generated source.
181
print ("The python package 'Pyrex' is not available."
182
" If the .c files are available,")
183
print ("they will be built,"
184
" but modifying the .pyx files will not rebuild them.")
186
from distutils.command.build_ext import build_ext
191
class build_ext_if_possible(build_ext):
193
user_options = build_ext.user_options + [
194
('allow-python-fallback', None,
195
"When an extension cannot be built, allow falling"
196
" back to the pure-python implementation.")
199
def initialize_options(self):
200
build_ext.initialize_options(self)
201
self.allow_python_fallback = False
206
except DistutilsPlatformError, e:
207
if not self.allow_python_fallback:
208
log.warn('\n Cannot build extensions.\n'
209
' Use "build_ext --allow-python-fallback" to use'
210
' slower python implementations instead.\n')
213
log.warn('\n Extensions cannot be built.\n'
214
' Using the slower Python implementations instead.\n')
216
def build_extension(self, ext):
218
build_ext.build_extension(self, ext)
219
except CCompilerError:
220
if not self.allow_python_fallback:
221
log.warn('\n Cannot build extension "%s".\n'
222
' Use "build_ext --allow-python-fallback" to use'
223
' slower python implementations instead.\n'
226
log.warn('\n Building of "%s" extension failed.\n'
227
' Using the slower Python implementation instead.'
231
# Override the build_ext if we have Pyrex available
232
command_classes['build_ext'] = build_ext_if_possible
233
unavailable_files = []
236
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
237
"""Add a pyrex module to build.
239
This will use Pyrex to auto-generate the .c file if it is available.
240
Otherwise it will fall back on the .c file. If the .c file is not
241
available, it will warn, and not add anything.
243
You can pass any extra options to Extension through kwargs. One example is
246
:param module_name: The python path to the module. This will be used to
247
determine the .pyx and .c files to use.
249
path = module_name.replace('.', '/')
250
pyrex_name = path + '.pyx'
253
if sys.platform == 'win32':
254
# pyrex uses the macro WIN32 to detect the platform, even though it
255
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
256
# give it the right value.
257
define_macros.append(('WIN32', None))
259
source = [pyrex_name]
261
if not os.path.isfile(c_name):
262
unavailable_files.append(c_name)
266
source.extend(extra_source)
267
ext_modules.append(Extension(module_name, source,
268
define_macros=define_macros, libraries=libraries))
271
add_pyrex_extension('bzrlib._annotator_pyx')
272
add_pyrex_extension('bzrlib._bencode_pyx')
273
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
274
add_pyrex_extension('bzrlib._groupcompress_pyx',
275
extra_source=['bzrlib/diff-delta.c'])
276
add_pyrex_extension('bzrlib._knit_load_data_pyx')
277
add_pyrex_extension('bzrlib._known_graph_pyx')
278
add_pyrex_extension('bzrlib._rio_pyx')
279
if sys.platform == 'win32':
280
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
281
libraries=['Ws2_32'])
282
add_pyrex_extension('bzrlib._walkdirs_win32')
285
if have_pyrex and pyrex_version == '0.9.4.1':
286
# Pyrex 0.9.4.1 fails to compile this extension correctly
287
# The code it generates re-uses a "local" pointer and
288
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
289
# which is NULL safe with PY_DECREF which is not.)
290
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
291
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
293
print 'install. For now, the non-compiled (python) version will'
294
print 'be used instead.'
296
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
297
add_pyrex_extension('bzrlib._readdir_pyx')
299
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
300
ext_modules.append(Extension('bzrlib._patiencediff_c',
301
['bzrlib/_patiencediff_c.c']))
302
add_pyrex_extension('bzrlib._simple_set_pyx')
303
ext_modules.append(Extension('bzrlib._static_tuple_c',
304
['bzrlib/_static_tuple_c.c']))
305
add_pyrex_extension('bzrlib._btree_serializer_pyx')
308
if unavailable_files:
309
print 'C extension(s) not found:'
310
print ' %s' % ('\n '.join(unavailable_files),)
311
print 'The python versions will be used instead.'
315
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
316
gui_targets, data_files):
317
packages.append('tbzrcommands')
319
# ModuleFinder can't handle runtime changes to __path__, but
320
# win32com uses them. Hook this in so win32com.shell is found.
323
import cPickle as pickle
324
for p in win32com.__path__[1:]:
325
modulefinder.AddPackagePath("win32com", p)
326
for extra in ["win32com.shell"]:
328
m = sys.modules[extra]
329
for p in m.__path__[1:]:
330
modulefinder.AddPackagePath(extra, p)
332
# TBZR points to the TBZR directory
333
tbzr_root = os.environ["TBZR"]
335
# Ensure tbzrlib itself is on sys.path
336
sys.path.append(tbzr_root)
338
packages.append("tbzrlib")
340
# collect up our icons.
342
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
343
icos = [] # list of (path_root, relative_ico_path)
344
# First always bzr's icon and its in the root of the bzr tree.
345
icos.append(('', 'bzr.ico'))
346
for root, dirs, files in os.walk(ico_root):
347
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
348
for f in files if f.endswith('.ico')])
349
# allocate an icon ID for each file and the full path to the ico
350
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
351
for rid, (ico_dir, ico_name) in enumerate(icos)]
352
# create a string resource with the mapping. Might as well save the
353
# runtime some effort and write a pickle.
354
# Runtime expects unicode objects with forward-slash seps.
355
fse = sys.getfilesystemencoding()
356
map_items = [(f.replace('\\', '/').decode(fse), rid)
357
for rid, (_, f) in enumerate(icos)]
358
ico_map = dict(map_items)
359
# Create a new resource type of 'ICON_MAP', and use ID=1
360
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
362
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
363
win32ui crawler.Crawler""".split())
365
# tbzrcache executables - a "console" version for debugging and a
366
# GUI version that is generally used.
368
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
369
icon_resources = icon_resources,
370
other_resources = other_resources,
372
console_targets.append(tbzrcache)
374
# Make a windows version which is the same except for the base name.
375
tbzrcachew = tbzrcache.copy()
376
tbzrcachew["dest_base"]="tbzrcachew"
377
gui_targets.append(tbzrcachew)
379
# ditto for the tbzrcommand tool
381
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
382
icon_resources = [(0,'bzr.ico')],
384
console_targets.append(tbzrcommand)
385
tbzrcommandw = tbzrcommand.copy()
386
tbzrcommandw["dest_base"]="tbzrcommandw"
387
gui_targets.append(tbzrcommandw)
389
# A utility to see python output from both C++ and Python based shell
391
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
392
console_targets.append(tracer)
394
# The C++ implemented shell extensions.
395
dist_dir = os.path.join(tbzr_root, "shellext", "build")
396
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
397
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
400
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
401
# PyQt4 itself still escapes the plugin detection code for some reason...
402
packages.append('PyQt4')
403
excludes.append('PyQt4.elementtree.ElementTree')
404
includes.append('sip') # extension module required for Qt.
405
packages.append('pygments') # colorizer for qbzr
406
packages.append('docutils') # html formatting
407
includes.append('win32event') # for qsubprocess stuff
408
# but we can avoid many Qt4 Dlls.
410
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
411
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
412
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
413
qscintilla2.dll""".split())
414
# the qt binaries might not be on PATH...
415
# They seem to install to a place like C:\Python25\PyQt4\*
416
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
417
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
418
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
419
if os.path.isdir(pyqt_bin_dir):
420
path = os.environ.get("PATH", "")
421
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
422
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
423
# also add all imageformat plugins to distribution
424
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
425
base_dirs_to_check = []
426
if os.path.isdir(pyqt_dir):
427
base_dirs_to_check.append(pyqt_dir)
433
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
434
if pyqt4_base_dir != pyqt_dir:
435
base_dirs_to_check.append(pyqt4_base_dir)
436
if not base_dirs_to_check:
437
log.warn("Can't find PyQt4 installation -> not including imageformat"
441
for base_dir in base_dirs_to_check:
442
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
443
if os.path.isdir(plug_dir):
444
for fname in os.listdir(plug_dir):
445
# Include plugin dlls, but not debugging dlls
446
fullpath = os.path.join(plug_dir, fname)
447
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
448
files.append(fullpath)
450
data_files.append(('imageformats', files))
452
log.warn('PyQt4 was found, but we could not find any imageformat'
453
' plugins. Are you sure your configuration is correct?')
456
def get_svn_py2exe_info(includes, excludes, packages):
457
packages.append('subvertpy')
460
if 'bdist_wininst' in sys.argv:
463
for root, dirs, files in os.walk('doc'):
466
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
467
or f == 'quick-start-summary.svg'):
468
r.append(os.path.join(root, f))
472
target = os.path.join('Doc\\Bazaar', relative)
474
target = 'Doc\\Bazaar'
475
docs.append((target, r))
478
# python's distutils-based win32 installer
479
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
480
'ext_modules': ext_modules,
482
'data_files': find_docs(),
483
# for building pyrex extensions
484
'cmdclass': {'build_ext': build_ext_if_possible},
487
ARGS.update(META_INFO)
489
ARGS.update(PKG_DATA)
493
elif 'py2exe' in sys.argv:
498
# pick real bzr version
502
for i in bzrlib.version_info[:4]:
507
version_number.append(str(i))
508
version_str = '.'.join(version_number)
510
# An override to install_data used only by py2exe builds, which arranges
511
# to byte-compile any .py files in data_files (eg, our plugins)
512
# Necessary as we can't rely on the user having the relevant permissions
513
# to the "Program Files" directory to generate them on the fly.
514
class install_data_with_bytecompile(install_data):
516
from distutils.util import byte_compile
518
install_data.run(self)
520
py2exe = self.distribution.get_command_obj('py2exe', False)
521
optimize = py2exe.optimize
522
compile_names = [f for f in self.outfiles if f.endswith('.py')]
523
byte_compile(compile_names,
525
force=self.force, prefix=self.install_dir,
526
dry_run=self.dry_run)
531
self.outfiles.extend([f + suffix for f in compile_names])
532
# end of class install_data_with_bytecompile
534
target = py2exe.build_exe.Target(script = "bzr",
536
icon_resources = [(0,'bzr.ico')],
537
name = META_INFO['name'],
538
version = version_str,
539
description = META_INFO['description'],
540
author = META_INFO['author'],
541
copyright = "(c) Canonical Ltd, 2005-2009",
542
company_name = "Canonical Ltd.",
543
comments = META_INFO['description'],
546
packages = BZRLIB['packages']
547
packages.remove('bzrlib')
548
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
550
for i in glob.glob('bzrlib\\*.py'):
551
module = i[:-3].replace('\\', '.')
552
if module.endswith('__init__'):
553
module = module[:-len('__init__')]
554
includes.append(module)
556
additional_packages = set()
557
if sys.version.startswith('2.4'):
558
# adding elementtree package
559
additional_packages.add('elementtree')
560
elif sys.version.startswith('2.5'):
561
additional_packages.add('xml.etree')
564
warnings.warn('Unknown Python version.\n'
565
'Please check setup.py script for compatibility.')
567
# Although we currently can't enforce it, we consider it an error for
568
# py2exe to report any files are "missing". Such modules we know aren't
569
# used should be listed here.
570
excludes = """Tkinter psyco ElementPath r_hmac
571
ImaginaryModule cElementTree elementtree.ElementTree
572
Crypto.PublicKey._fastmath
573
medusa medusa.filesys medusa.ftp_server
575
resource validate""".split()
578
# email package from std python library use lazy import,
579
# so we need to explicitly add all package
580
additional_packages.add('email')
581
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
582
# a result, packages like 'email.Parser' show as missing. Tell py2exe
585
for oldname in getattr(email, '_LOWERNAMES', []):
586
excludes.append("email." + oldname)
587
for oldname in getattr(email, '_MIMENAMES', []):
588
excludes.append("email.MIME" + oldname)
590
# text files for help topis
591
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
592
topics_files = [('lib/help_topics/en', text_topics)]
596
# XXX - should we consider having the concept of an 'official' build,
597
# which hard-codes the list of plugins, gets more upset if modules are
599
plugins = None # will be a set after plugin sniffing...
600
for root, dirs, files in os.walk('bzrlib/plugins'):
601
if root == 'bzrlib/plugins':
603
# We ship plugins as normal files on the file-system - however,
604
# the build process can cause *some* of these plugin files to end
605
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
606
# library.zip, and then saw import errors related to that as the
607
# rest of the svn plugin wasn't. So we tell py2exe to leave the
608
# plugins out of the .zip file
609
excludes.extend(["bzrlib.plugins." + d for d in dirs])
612
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
614
if i == '__init__.py' and root == 'bzrlib/plugins':
616
x.append(os.path.join(root, i))
618
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
619
plugins_files.append((target_dir, x))
620
# find modules for built-in plugins
621
import tools.package_mf
622
mf = tools.package_mf.CustomModuleFinder()
623
mf.run_package('bzrlib/plugins')
624
packs, mods = mf.get_result()
625
additional_packages.update(packs)
626
includes.extend(mods)
628
console_targets = [target,
629
'tools/win32/bzr_postinstall.py',
632
data_files = topics_files + plugins_files
634
if 'qbzr' in plugins:
635
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
638
get_svn_py2exe_info(includes, excludes, packages)
640
if "TBZR" in os.environ:
641
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
642
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
643
# can be downloaded from (username=guest, blank password):
644
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
645
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
646
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
647
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
648
'TORTOISE_OVERLAYS_MSI_X64'):
649
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
651
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
653
"\nPlease set %s to the location of the relevant"
654
"\nTortoiseOverlays .msi installer file."
655
" The installers can be found at"
657
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
658
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
659
gui_targets, data_files)
661
# print this warning to stderr as output is redirected, so it is seen
662
# at build time. Also to stdout so it appears in the log
663
for f in (sys.stderr, sys.stdout):
665
"Skipping TBZR binaries - please set TBZR to a directory to enable"
667
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
669
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
670
options_list = {"py2exe": {"packages": packages + list(additional_packages),
671
"includes": includes,
672
"excludes": excludes,
673
"dll_excludes": dll_excludes,
674
"dist_dir": "win32_bzr.exe",
679
setup(options=options_list,
680
console=console_targets,
682
zipfile='lib/library.zip',
683
data_files=data_files,
684
cmdclass={'install_data': install_data_with_bytecompile},
688
# ad-hoc for easy_install
690
if not 'bdist_egg' in sys.argv:
691
# generate and install bzr.1 only with plain install, not the
693
DATA_FILES = [('man/man1', ['bzr.1'])]
696
ARGS = {'scripts': ['bzr'],
697
'data_files': DATA_FILES,
698
'cmdclass': command_classes,
699
'ext_modules': ext_modules,
702
ARGS.update(META_INFO)
704
ARGS.update(PKG_DATA)
added
removed
setup.py
