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',
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()
96
from distutils import log
7
97
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',
98
from distutils.command.install_scripts import install_scripts
99
from distutils.command.install_data import install_data
100
from distutils.command.build import build
102
###############################
103
# Overridden distutils actions
104
###############################
106
class my_install_scripts(install_scripts):
107
""" Customized install_scripts distutils action.
108
Create bzr.bat for win32.
111
install_scripts.run(self) # standard action
113
if sys.platform == "win32":
115
scripts_dir = os.path.join(sys.prefix, 'Scripts')
116
script_path = self._quoted_path(os.path.join(scripts_dir,
118
python_exe = self._quoted_path(sys.executable)
119
args = self._win_batch_args()
120
batch_str = "@%s %s %s" % (python_exe, script_path, args)
121
batch_path = os.path.join(self.install_dir, "bzr.bat")
122
f = file(batch_path, "w")
125
print "Created:", batch_path
127
print "ERROR: Unable to create %s: %s" % (batch_path, e)
129
def _quoted_path(self, path):
131
return '"' + path + '"'
135
def _win_batch_args(self):
136
from bzrlib.win32utils import winver
137
if winver == 'Windows NT':
140
return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
141
#/class my_install_scripts
144
class bzr_build(build):
145
"""Customized build distutils action.
152
from tools import generate_docs
153
generate_docs.main(argv=["bzr", "man"])
156
########################
158
########################
160
command_classes = {'install_scripts': my_install_scripts,
162
from distutils import log
163
from distutils.errors import CCompilerError, DistutilsPlatformError
164
from distutils.extension import Extension
167
from Pyrex.Distutils import build_ext
170
# try to build the extension from the prior generated source.
172
print ("The python package 'Pyrex' is not available."
173
" If the .c files are available,")
174
print ("they will be built,"
175
" but modifying the .pyx files will not rebuild them.")
177
from distutils.command.build_ext import build_ext
180
from Pyrex.Compiler.Version import version as pyrex_version
183
class build_ext_if_possible(build_ext):
185
user_options = build_ext.user_options + [
186
('allow-python-fallback', None,
187
"When an extension cannot be built, allow falling"
188
" back to the pure-python implementation.")
191
def initialize_options(self):
192
build_ext.initialize_options(self)
193
self.allow_python_fallback = False
198
except DistutilsPlatformError, e:
199
if not self.allow_python_fallback:
200
log.warn('\n Cannot build extensions.\n'
201
' Use "build_ext --allow-python-fallback" to use'
202
' slower python implementations instead.\n')
205
log.warn('\n Extensions cannot be built.\n'
206
' Using the slower Python implementations instead.\n')
208
def build_extension(self, ext):
210
build_ext.build_extension(self, ext)
211
except CCompilerError:
212
if not self.allow_python_fallback:
213
log.warn('\n Cannot build extension "%s".\n'
214
' Use "build_ext --allow-python-fallback" to use'
215
' slower python implementations instead.\n'
218
log.warn('\n Building of "%s" extension failed.\n'
219
' Using the slower Python implementation instead.'
223
# Override the build_ext if we have Pyrex available
224
command_classes['build_ext'] = build_ext_if_possible
225
unavailable_files = []
228
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
229
"""Add a pyrex module to build.
231
This will use Pyrex to auto-generate the .c file if it is available.
232
Otherwise it will fall back on the .c file. If the .c file is not
233
available, it will warn, and not add anything.
235
You can pass any extra options to Extension through kwargs. One example is
238
:param module_name: The python path to the module. This will be used to
239
determine the .pyx and .c files to use.
241
path = module_name.replace('.', '/')
242
pyrex_name = path + '.pyx'
245
if sys.platform == 'win32':
246
# pyrex uses the macro WIN32 to detect the platform, even though it
247
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
248
# give it the right value.
249
define_macros.append(('WIN32', None))
251
source = [pyrex_name]
253
if not os.path.isfile(c_name):
254
unavailable_files.append(c_name)
258
source.extend(extra_source)
259
ext_modules.append(Extension(module_name, source,
260
define_macros=define_macros, libraries=libraries))
263
add_pyrex_extension('bzrlib._annotator_pyx')
264
add_pyrex_extension('bzrlib._bencode_pyx')
265
add_pyrex_extension('bzrlib._btree_serializer_pyx')
266
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
267
add_pyrex_extension('bzrlib._groupcompress_pyx',
268
extra_source=['bzrlib/diff-delta.c'])
269
add_pyrex_extension('bzrlib._knit_load_data_pyx')
270
add_pyrex_extension('bzrlib._known_graph_pyx')
271
add_pyrex_extension('bzrlib._rio_pyx')
272
if sys.platform == 'win32':
273
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
274
libraries=['Ws2_32'])
275
add_pyrex_extension('bzrlib._walkdirs_win32')
278
if have_pyrex and pyrex_version == '0.9.4.1':
279
# Pyrex 0.9.4.1 fails to compile this extension correctly
280
# The code it generates re-uses a "local" pointer and
281
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
282
# which is NULL safe with PY_DECREF which is not.)
283
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
284
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
286
print 'install. For now, the non-compiled (python) version will'
287
print 'be used instead.'
289
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
290
add_pyrex_extension('bzrlib._readdir_pyx')
292
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
293
ext_modules.append(Extension('bzrlib._patiencediff_c',
294
['bzrlib/_patiencediff_c.c']))
297
if unavailable_files:
298
print 'C extension(s) not found:'
299
print ' %s' % ('\n '.join(unavailable_files),)
300
print 'The python versions will be used instead.'
304
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
305
gui_targets, data_files):
306
packages.append('tbzrcommands')
308
# ModuleFinder can't handle runtime changes to __path__, but
309
# win32com uses them. Hook this in so win32com.shell is found.
312
import cPickle as pickle
313
for p in win32com.__path__[1:]:
314
modulefinder.AddPackagePath("win32com", p)
315
for extra in ["win32com.shell"]:
317
m = sys.modules[extra]
318
for p in m.__path__[1:]:
319
modulefinder.AddPackagePath(extra, p)
321
# TBZR points to the TBZR directory
322
tbzr_root = os.environ["TBZR"]
324
# Ensure tbzrlib itself is on sys.path
325
sys.path.append(tbzr_root)
327
# Ensure our COM "entry-point" is on sys.path
328
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
330
packages.append("tbzrlib")
332
# collect up our icons.
334
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
335
icos = [] # list of (path_root, relative_ico_path)
336
# First always bzr's icon and its in the root of the bzr tree.
337
icos.append(('', 'bzr.ico'))
338
for root, dirs, files in os.walk(ico_root):
339
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
340
for f in files if f.endswith('.ico')])
341
# allocate an icon ID for each file and the full path to the ico
342
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
343
for rid, (ico_dir, ico_name) in enumerate(icos)]
344
# create a string resource with the mapping. Might as well save the
345
# runtime some effort and write a pickle.
346
# Runtime expects unicode objects with forward-slash seps.
347
fse = sys.getfilesystemencoding()
348
map_items = [(f.replace('\\', '/').decode(fse), rid)
349
for rid, (_, f) in enumerate(icos)]
350
ico_map = dict(map_items)
351
# Create a new resource type of 'ICON_MAP', and use ID=1
352
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
354
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
355
win32ui crawler.Crawler""".split())
357
# NOTE: We still create a DLL version of the Python implemented shell
358
# extension for testing purposes - but it is *not* registered by
359
# default - our C++ one is instead. To discourage people thinking
360
# this DLL is still necessary, its called 'tbzr_old.dll'
363
create_exe = False, # we only want a .dll
364
dest_base = 'tbzr_old',
366
com_targets.append(tbzr)
368
# tbzrcache executables - a "console" version for debugging and a
369
# GUI version that is generally used.
371
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
372
icon_resources = icon_resources,
373
other_resources = other_resources,
375
console_targets.append(tbzrcache)
377
# Make a windows version which is the same except for the base name.
378
tbzrcachew = tbzrcache.copy()
379
tbzrcachew["dest_base"]="tbzrcachew"
380
gui_targets.append(tbzrcachew)
382
# ditto for the tbzrcommand tool
384
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
385
icon_resources = [(0,'bzr.ico')],
387
console_targets.append(tbzrcommand)
388
tbzrcommandw = tbzrcommand.copy()
389
tbzrcommandw["dest_base"]="tbzrcommandw"
390
gui_targets.append(tbzrcommandw)
392
# A utility to see python output from both C++ and Python based shell
394
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
395
console_targets.append(tracer)
397
# The C++ implemented shell extensions.
398
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
400
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
401
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
404
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
405
# PyQt4 itself still escapes the plugin detection code for some reason...
406
packages.append('PyQt4')
407
excludes.append('PyQt4.elementtree.ElementTree')
408
includes.append('sip') # extension module required for Qt.
409
packages.append('pygments') # colorizer for qbzr
410
packages.append('docutils') # html formatting
411
# but we can avoid many Qt4 Dlls.
413
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
414
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
415
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
416
qscintilla2.dll""".split())
417
# the qt binaries might not be on PATH...
418
# They seem to install to a place like C:\Python25\PyQt4\*
419
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
420
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
421
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
422
if os.path.isdir(pyqt_bin_dir):
423
path = os.environ.get("PATH", "")
424
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
425
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
426
# also add all imageformat plugins to distribution
427
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
428
base_dirs_to_check = []
429
if os.path.isdir(pyqt_dir):
430
base_dirs_to_check.append(pyqt_dir)
436
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
437
if pyqt4_base_dir != pyqt_dir:
438
base_dirs_to_check.append(pyqt4_base_dir)
439
if not base_dirs_to_check:
440
log.warn("Can't find PyQt4 installation -> not including imageformat"
444
for base_dir in base_dirs_to_check:
445
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
446
if os.path.isdir(plug_dir):
447
for fname in os.listdir(plug_dir):
448
# Include plugin dlls, but not debugging dlls
449
fullpath = os.path.join(plug_dir, fname)
450
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
451
files.append(fullpath)
453
data_files.append(('imageformats', files))
455
log.warn('PyQt4 was found, but we could not find any imageformat'
456
' plugins. Are you sure your configuration is correct?')
459
def get_svn_py2exe_info(includes, excludes, packages):
460
packages.append('subvertpy')
463
if 'bdist_wininst' in sys.argv:
466
for root, dirs, files in os.walk('doc'):
469
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
470
or f == 'quick-start-summary.svg'):
471
r.append(os.path.join(root, f))
475
target = os.path.join('Doc\\Bazaar', relative)
477
target = 'Doc\\Bazaar'
478
docs.append((target, r))
481
# python's distutils-based win32 installer
482
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
483
'ext_modules': ext_modules,
485
'data_files': find_docs(),
486
# for building pyrex extensions
487
'cmdclass': {'build_ext': build_ext_if_possible},
490
ARGS.update(META_INFO)
492
ARGS.update(PKG_DATA)
496
elif 'py2exe' in sys.argv:
501
# pick real bzr version
505
for i in bzrlib.version_info[:4]:
510
version_number.append(str(i))
511
version_str = '.'.join(version_number)
513
# An override to install_data used only by py2exe builds, which arranges
514
# to byte-compile any .py files in data_files (eg, our plugins)
515
# Necessary as we can't rely on the user having the relevant permissions
516
# to the "Program Files" directory to generate them on the fly.
517
class install_data_with_bytecompile(install_data):
519
from distutils.util import byte_compile
521
install_data.run(self)
523
py2exe = self.distribution.get_command_obj('py2exe', False)
524
optimize = py2exe.optimize
525
compile_names = [f for f in self.outfiles if f.endswith('.py')]
526
byte_compile(compile_names,
528
force=self.force, prefix=self.install_dir,
529
dry_run=self.dry_run)
534
self.outfiles.extend([f + suffix for f in compile_names])
535
# end of class install_data_with_bytecompile
537
target = py2exe.build_exe.Target(script = "bzr",
539
icon_resources = [(0,'bzr.ico')],
540
name = META_INFO['name'],
541
version = version_str,
542
description = META_INFO['description'],
543
author = META_INFO['author'],
544
copyright = "(c) Canonical Ltd, 2005-2007",
545
company_name = "Canonical Ltd.",
546
comments = META_INFO['description'],
549
packages = BZRLIB['packages']
550
packages.remove('bzrlib')
551
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
553
for i in glob.glob('bzrlib\\*.py'):
554
module = i[:-3].replace('\\', '.')
555
if module.endswith('__init__'):
556
module = module[:-len('__init__')]
557
includes.append(module)
559
additional_packages = set()
560
if sys.version.startswith('2.4'):
561
# adding elementtree package
562
additional_packages.add('elementtree')
563
elif sys.version.startswith('2.5'):
564
additional_packages.add('xml.etree')
567
warnings.warn('Unknown Python version.\n'
568
'Please check setup.py script for compatibility.')
570
# Although we currently can't enforce it, we consider it an error for
571
# py2exe to report any files are "missing". Such modules we know aren't
572
# used should be listed here.
573
excludes = """Tkinter psyco ElementPath r_hmac
574
ImaginaryModule cElementTree elementtree.ElementTree
575
Crypto.PublicKey._fastmath
576
medusa medusa.filesys medusa.ftp_server
578
resource validate""".split()
581
# email package from std python library use lazy import,
582
# so we need to explicitly add all package
583
additional_packages.add('email')
584
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
585
# a result, packages like 'email.Parser' show as missing. Tell py2exe
588
for oldname in getattr(email, '_LOWERNAMES', []):
589
excludes.append("email." + oldname)
590
for oldname in getattr(email, '_MIMENAMES', []):
591
excludes.append("email.MIME" + oldname)
593
# text files for help topis
594
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
595
topics_files = [('lib/help_topics/en', text_topics)]
599
# XXX - should we consider having the concept of an 'official' build,
600
# which hard-codes the list of plugins, gets more upset if modules are
602
plugins = None # will be a set after plugin sniffing...
603
for root, dirs, files in os.walk('bzrlib/plugins'):
604
if root == 'bzrlib/plugins':
606
# We ship plugins as normal files on the file-system - however,
607
# the build process can cause *some* of these plugin files to end
608
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
609
# library.zip, and then saw import errors related to that as the
610
# rest of the svn plugin wasn't. So we tell py2exe to leave the
611
# plugins out of the .zip file
612
excludes.extend(["bzrlib.plugins." + d for d in dirs])
615
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
617
if i == '__init__.py' and root == 'bzrlib/plugins':
619
x.append(os.path.join(root, i))
621
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
622
plugins_files.append((target_dir, x))
623
# find modules for built-in plugins
624
import tools.package_mf
625
mf = tools.package_mf.CustomModuleFinder()
626
mf.run_package('bzrlib/plugins')
627
packs, mods = mf.get_result()
628
additional_packages.update(packs)
629
includes.extend(mods)
631
console_targets = [target,
632
'tools/win32/bzr_postinstall.py',
636
data_files = topics_files + plugins_files
638
if 'qbzr' in plugins:
639
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
642
get_svn_py2exe_info(includes, excludes, packages)
644
if "TBZR" in os.environ:
645
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
646
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
647
# can be downloaded from (username=guest, blank password):
648
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
649
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
650
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
651
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
652
'TORTOISE_OVERLAYS_MSI_X64'):
653
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
655
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
657
"\nPlease set %s to the location of the relevant"
658
"\nTortoiseOverlays .msi installer file."
659
" The installers can be found at"
661
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
662
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
663
gui_targets, data_files)
665
# print this warning to stderr as output is redirected, so it is seen
666
# at build time. Also to stdout so it appears in the log
667
for f in (sys.stderr, sys.stdout):
669
"Skipping TBZR binaries - please set TBZR to a directory to enable"
671
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
673
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
674
options_list = {"py2exe": {"packages": packages + list(additional_packages),
675
"includes": includes,
676
"excludes": excludes,
677
"dll_excludes": dll_excludes,
678
"dist_dir": "win32_bzr.exe",
683
setup(options=options_list,
684
console=console_targets,
686
com_server=com_targets,
687
zipfile='lib/library.zip',
688
data_files=data_files,
689
cmdclass={'install_data': install_data_with_bytecompile},
693
# ad-hoc for easy_install
695
if not 'bdist_egg' in sys.argv:
696
# generate and install bzr.1 only with plain install, not the
698
DATA_FILES = [('man/man1', ['bzr.1'])]
701
ARGS = {'scripts': ['bzr'],
702
'data_files': DATA_FILES,
703
'cmdclass': command_classes,
704
'ext_modules': ext_modules,
707
ARGS.update(META_INFO)
709
ARGS.update(PKG_DATA)
added
removed
setup.py
