1
1
#! /usr/bin/env python
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',
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()
3
# This is an installation script for bzr. Run it with
4
# './setup.py install', or
5
# './setup.py --help' for more options
96
7
from distutils.core import setup
97
from distutils.command.install_scripts import install_scripts
98
from distutils.command.install_data import install_data
99
from distutils.command.build import build
101
###############################
102
# Overridden distutils actions
103
###############################
105
class my_install_scripts(install_scripts):
106
""" Customized install_scripts distutils action.
107
Create bzr.bat for win32.
110
install_scripts.run(self) # standard action
112
if sys.platform == "win32":
114
scripts_dir = os.path.join(sys.prefix, 'Scripts')
115
script_path = self._quoted_path(os.path.join(scripts_dir,
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)
120
batch_path = os.path.join(self.install_dir, "bzr.bat")
121
f = file(batch_path, "w")
124
print "Created:", batch_path
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
143
class bzr_build(build):
144
"""Customized build distutils action.
152
generate_docs.main(argv=["bzr", "man"])
155
########################
157
########################
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 extensions.\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):
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
ext_modules.append(Extension(module_name, [pyrex_name],
251
define_macros=define_macros, libraries=libraries))
253
if not os.path.isfile(c_name):
254
unavailable_files.append(c_name)
256
ext_modules.append(Extension(module_name, [c_name],
257
define_macros=define_macros, libraries=libraries))
260
add_pyrex_extension('bzrlib._btree_serializer_c')
261
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
262
add_pyrex_extension('bzrlib._knit_load_data_c')
263
if sys.platform == 'win32':
264
add_pyrex_extension('bzrlib._dirstate_helpers_c',
265
libraries=['Ws2_32'])
266
add_pyrex_extension('bzrlib._walkdirs_win32')
268
if have_pyrex and pyrex_version == '0.9.4.1':
269
# Pyrex 0.9.4.1 fails to compile this extension correctly
270
# The code it generates re-uses a "local" pointer and
271
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
272
# which is NULL safe with PY_DECREF which is not.)
273
print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
274
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
276
print 'install. For now, the non-compiled (python) version will'
277
print 'be used instead.'
279
add_pyrex_extension('bzrlib._dirstate_helpers_c')
280
add_pyrex_extension('bzrlib._readdir_pyx')
281
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
284
if unavailable_files:
285
print 'C extension(s) not found:'
286
print ' %s' % ('\n '.join(unavailable_files),)
287
print 'The python versions will be used instead.'
291
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
292
gui_targets, data_files):
293
packages.append('tbzrcommands')
295
# ModuleFinder can't handle runtime changes to __path__, but
296
# win32com uses them. Hook this in so win32com.shell is found.
299
import cPickle as pickle
300
for p in win32com.__path__[1:]:
301
modulefinder.AddPackagePath("win32com", p)
302
for extra in ["win32com.shell"]:
304
m = sys.modules[extra]
305
for p in m.__path__[1:]:
306
modulefinder.AddPackagePath(extra, p)
308
# TBZR points to the TBZR directory
309
tbzr_root = os.environ["TBZR"]
311
# Ensure tbzrlib itself is on sys.path
312
sys.path.append(tbzr_root)
314
# Ensure our COM "entry-point" is on sys.path
315
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
317
packages.append("tbzrlib")
319
# collect up our icons.
321
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
322
icos = [] # list of (path_root, relative_ico_path)
323
# First always bzr's icon and its in the root of the bzr tree.
324
icos.append(('', 'bzr.ico'))
325
for root, dirs, files in os.walk(ico_root):
326
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
327
for f in files if f.endswith('.ico')])
328
# allocate an icon ID for each file and the full path to the ico
329
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
330
for rid, (ico_dir, ico_name) in enumerate(icos)]
331
# create a string resource with the mapping. Might as well save the
332
# runtime some effort and write a pickle.
333
# Runtime expects unicode objects with forward-slash seps.
334
fse = sys.getfilesystemencoding()
335
map_items = [(f.replace('\\', '/').decode(fse), rid)
336
for rid, (_, f) in enumerate(icos)]
337
ico_map = dict(map_items)
338
# Create a new resource type of 'ICON_MAP', and use ID=1
339
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
341
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
342
win32ui crawler.Crawler""".split())
344
# NOTE: We still create a DLL version of the Python implemented shell
345
# extension for testing purposes - but it is *not* registered by
346
# default - our C++ one is instead. To discourage people thinking
347
# this DLL is still necessary, its called 'tbzr_old.dll'
350
create_exe = False, # we only want a .dll
351
dest_base = 'tbzr_old',
353
com_targets.append(tbzr)
355
# tbzrcache executables - a "console" version for debugging and a
356
# GUI version that is generally used.
358
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
359
icon_resources = icon_resources,
360
other_resources = other_resources,
362
console_targets.append(tbzrcache)
364
# Make a windows version which is the same except for the base name.
365
tbzrcachew = tbzrcache.copy()
366
tbzrcachew["dest_base"]="tbzrcachew"
367
gui_targets.append(tbzrcachew)
369
# ditto for the tbzrcommand tool
371
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
372
icon_resources = [(0,'bzr.ico')],
374
console_targets.append(tbzrcommand)
375
tbzrcommandw = tbzrcommand.copy()
376
tbzrcommandw["dest_base"]="tbzrcommandw"
377
gui_targets.append(tbzrcommandw)
379
# A utility to see python output from both C++ and Python based shell
381
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
382
console_targets.append(tracer)
384
# The C++ implemented shell extensions.
385
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
387
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
388
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
391
def get_qbzr_py2exe_info(includes, excludes, packages):
392
# PyQt4 itself still escapes the plugin detection code for some reason...
393
packages.append('PyQt4')
394
excludes.append('PyQt4.elementtree.ElementTree')
395
includes.append('sip') # extension module required for Qt.
396
packages.append('pygments') # colorizer for qbzr
397
packages.append('docutils') # html formatting
398
# but we can avoid many Qt4 Dlls.
400
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
401
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
402
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
403
qscintilla2.dll""".split())
404
# the qt binaries might not be on PATH...
405
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
406
path = os.environ.get("PATH","")
407
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
408
os.environ["PATH"] = path + os.pathsep + qt_dir
411
def get_svn_py2exe_info(includes, excludes, packages):
412
packages.append('subvertpy')
415
if 'bdist_wininst' in sys.argv:
418
for root, dirs, files in os.walk('doc'):
421
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
422
or f == 'quick-start-summary.svg'):
423
r.append(os.path.join(root, f))
427
target = os.path.join('Doc\\Bazaar', relative)
429
target = 'Doc\\Bazaar'
430
docs.append((target, r))
433
# python's distutils-based win32 installer
434
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
435
'ext_modules': ext_modules,
437
'data_files': find_docs(),
438
# for building pyrex extensions
439
'cmdclass': {'build_ext': build_ext_if_possible},
442
ARGS.update(META_INFO)
444
ARGS.update(PKG_DATA)
448
elif 'py2exe' in sys.argv:
453
# pick real bzr version
457
for i in bzrlib.version_info[:4]:
462
version_number.append(str(i))
463
version_str = '.'.join(version_number)
465
# An override to install_data used only by py2exe builds, which arranges
466
# to byte-compile any .py files in data_files (eg, our plugins)
467
# Necessary as we can't rely on the user having the relevant permissions
468
# to the "Program Files" directory to generate them on the fly.
469
class install_data_with_bytecompile(install_data):
471
from distutils.util import byte_compile
473
install_data.run(self)
475
py2exe = self.distribution.get_command_obj('py2exe', False)
476
optimize = py2exe.optimize
477
compile_names = [f for f in self.outfiles if f.endswith('.py')]
478
byte_compile(compile_names,
480
force=self.force, prefix=self.install_dir,
481
dry_run=self.dry_run)
486
self.outfiles.extend([f + suffix for f in compile_names])
487
# end of class install_data_with_bytecompile
489
target = py2exe.build_exe.Target(script = "bzr",
491
icon_resources = [(0,'bzr.ico')],
492
name = META_INFO['name'],
493
version = version_str,
494
description = META_INFO['description'],
495
author = META_INFO['author'],
496
copyright = "(c) Canonical Ltd, 2005-2007",
497
company_name = "Canonical Ltd.",
498
comments = META_INFO['description'],
501
packages = BZRLIB['packages']
502
packages.remove('bzrlib')
503
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
505
for i in glob.glob('bzrlib\\*.py'):
506
module = i[:-3].replace('\\', '.')
507
if module.endswith('__init__'):
508
module = module[:-len('__init__')]
509
includes.append(module)
511
additional_packages = set()
512
if sys.version.startswith('2.4'):
513
# adding elementtree package
514
additional_packages.add('elementtree')
515
elif sys.version.startswith('2.5'):
516
additional_packages.add('xml.etree')
519
warnings.warn('Unknown Python version.\n'
520
'Please check setup.py script for compatibility.')
522
# Although we currently can't enforce it, we consider it an error for
523
# py2exe to report any files are "missing". Such modules we know aren't
524
# used should be listed here.
525
excludes = """Tkinter psyco ElementPath r_hmac
526
ImaginaryModule cElementTree elementtree.ElementTree
527
Crypto.PublicKey._fastmath
528
medusa medusa.filesys medusa.ftp_server
529
tools tools.doc_generate
530
resource validate""".split()
533
# email package from std python library use lazy import,
534
# so we need to explicitly add all package
535
additional_packages.add('email')
536
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
537
# a result, packages like 'email.Parser' show as missing. Tell py2exe
540
for oldname in getattr(email, '_LOWERNAMES', []):
541
excludes.append("email." + oldname)
542
for oldname in getattr(email, '_MIMENAMES', []):
543
excludes.append("email.MIME" + oldname)
545
# text files for help topis
546
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
547
topics_files = [('lib/help_topics/en', text_topics)]
551
# XXX - should we consider having the concept of an 'official' build,
552
# which hard-codes the list of plugins, gets more upset if modules are
554
plugins = None # will be a set after plugin sniffing...
555
for root, dirs, files in os.walk('bzrlib/plugins'):
556
if root == 'bzrlib/plugins':
558
# We ship plugins as normal files on the file-system - however,
559
# the build process can cause *some* of these plugin files to end
560
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
561
# library.zip, and then saw import errors related to that as the
562
# rest of the svn plugin wasn't. So we tell py2exe to leave the
563
# plugins out of the .zip file
564
excludes.extend(["bzrlib.plugins." + d for d in dirs])
567
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
569
if i == '__init__.py' and root == 'bzrlib/plugins':
571
x.append(os.path.join(root, i))
573
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
574
plugins_files.append((target_dir, x))
575
# find modules for built-in plugins
576
import tools.package_mf
577
mf = tools.package_mf.CustomModuleFinder()
578
mf.run_package('bzrlib/plugins')
579
packs, mods = mf.get_result()
580
additional_packages.update(packs)
581
includes.extend(mods)
583
console_targets = [target,
584
'tools/win32/bzr_postinstall.py',
588
data_files = topics_files + plugins_files
590
if 'qbzr' in plugins:
591
get_qbzr_py2exe_info(includes, excludes, packages)
594
get_svn_py2exe_info(includes, excludes, packages)
596
if "TBZR" in os.environ:
597
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
598
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
599
# can be downloaded from (username=guest, blank password):
600
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
601
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
602
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
603
'TORTOISE_OVERLAYS_MSI_X64'):
604
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
605
raise RuntimeError("Please set %s to the"
606
" location of the relevant TortoiseOverlays"
607
" .msi installer file" % needed)
608
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
609
gui_targets, data_files)
611
# print this warning to stderr as output is redirected, so it is seen
612
# at build time. Also to stdout so it appears in the log
613
for f in (sys.stderr, sys.stdout):
615
"Skipping TBZR binaries - please set TBZR to a directory to enable"
617
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
619
dll_excludes.append("MSWSOCK.dll")
620
options_list = {"py2exe": {"packages": packages + list(additional_packages),
621
"includes": includes,
622
"excludes": excludes,
623
"dll_excludes": dll_excludes,
624
"dist_dir": "win32_bzr.exe",
629
setup(options=options_list,
630
console=console_targets,
632
com_server=com_targets,
633
zipfile='lib/library.zip',
634
data_files=data_files,
635
cmdclass={'install_data': install_data_with_bytecompile},
639
# ad-hoc for easy_install
641
if not 'bdist_egg' in sys.argv:
642
# generate and install bzr.1 only with plain install, not easy_install one
643
DATA_FILES = [('man/man1', ['bzr.1'])]
646
ARGS = {'scripts': ['bzr'],
647
'data_files': DATA_FILES,
648
'cmdclass': command_classes,
649
'ext_modules': ext_modules,
652
ARGS.update(META_INFO)
654
ARGS.update(PKG_DATA)
12
author_email='mbp@sourcefrog.net',
13
url='http://www.bazaar-ng.org/',
14
description='Friendly distributed version control system',
added
removed
setup.py
