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',
20
'bzrlib.util.elementtree',
21
'bzrlib.util.effbot.org',
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 == '0.9.4.1':
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
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
287
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
289
print 'install. For now, the non-compiled (python) version will'
290
print 'be used instead.'
292
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
293
add_pyrex_extension('bzrlib._readdir_pyx')
295
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
296
ext_modules.append(Extension('bzrlib._patiencediff_c',
297
['bzrlib/_patiencediff_c.c']))
300
if unavailable_files:
301
print 'C extension(s) not found:'
302
print ' %s' % ('\n '.join(unavailable_files),)
303
print 'The python versions will be used instead.'
307
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
308
gui_targets, data_files):
309
packages.append('tbzrcommands')
311
# ModuleFinder can't handle runtime changes to __path__, but
312
# win32com uses them. Hook this in so win32com.shell is found.
315
import cPickle as pickle
316
for p in win32com.__path__[1:]:
317
modulefinder.AddPackagePath("win32com", p)
318
for extra in ["win32com.shell"]:
320
m = sys.modules[extra]
321
for p in m.__path__[1:]:
322
modulefinder.AddPackagePath(extra, p)
324
# TBZR points to the TBZR directory
325
tbzr_root = os.environ["TBZR"]
327
# Ensure tbzrlib itself is on sys.path
328
sys.path.append(tbzr_root)
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
# tbzrcache executables - a "console" version for debugging and a
358
# GUI version that is generally used.
360
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
361
icon_resources = icon_resources,
362
other_resources = other_resources,
364
console_targets.append(tbzrcache)
366
# Make a windows version which is the same except for the base name.
367
tbzrcachew = tbzrcache.copy()
368
tbzrcachew["dest_base"]="tbzrcachew"
369
gui_targets.append(tbzrcachew)
371
# ditto for the tbzrcommand tool
373
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
374
icon_resources = [(0,'bzr.ico')],
376
console_targets.append(tbzrcommand)
377
tbzrcommandw = tbzrcommand.copy()
378
tbzrcommandw["dest_base"]="tbzrcommandw"
379
gui_targets.append(tbzrcommandw)
381
# A utility to see python output from both C++ and Python based shell
383
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
384
console_targets.append(tracer)
386
# The C++ implemented shell extensions.
387
dist_dir = os.path.join(tbzr_root, "shellext", "build")
388
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
389
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
392
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
393
# PyQt4 itself still escapes the plugin detection code for some reason...
394
packages.append('PyQt4')
395
excludes.append('PyQt4.elementtree.ElementTree')
396
includes.append('sip') # extension module required for Qt.
397
packages.append('pygments') # colorizer for qbzr
398
packages.append('docutils') # html formatting
399
includes.append('win32event') # for qsubprocess stuff
400
# but we can avoid many Qt4 Dlls.
402
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
403
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
404
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
405
qscintilla2.dll""".split())
406
# the qt binaries might not be on PATH...
407
# They seem to install to a place like C:\Python25\PyQt4\*
408
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
409
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
410
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
411
if os.path.isdir(pyqt_bin_dir):
412
path = os.environ.get("PATH", "")
413
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
414
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
415
# also add all imageformat plugins to distribution
416
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
417
base_dirs_to_check = []
418
if os.path.isdir(pyqt_dir):
419
base_dirs_to_check.append(pyqt_dir)
425
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
426
if pyqt4_base_dir != pyqt_dir:
427
base_dirs_to_check.append(pyqt4_base_dir)
428
if not base_dirs_to_check:
429
log.warn("Can't find PyQt4 installation -> not including imageformat"
433
for base_dir in base_dirs_to_check:
434
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
435
if os.path.isdir(plug_dir):
436
for fname in os.listdir(plug_dir):
437
# Include plugin dlls, but not debugging dlls
438
fullpath = os.path.join(plug_dir, fname)
439
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
440
files.append(fullpath)
442
data_files.append(('imageformats', files))
444
log.warn('PyQt4 was found, but we could not find any imageformat'
445
' plugins. Are you sure your configuration is correct?')
448
def get_svn_py2exe_info(includes, excludes, packages):
449
packages.append('subvertpy')
452
if 'bdist_wininst' in sys.argv:
455
for root, dirs, files in os.walk('doc'):
458
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
459
or f == 'quick-start-summary.svg'):
460
r.append(os.path.join(root, f))
464
target = os.path.join('Doc\\Bazaar', relative)
466
target = 'Doc\\Bazaar'
467
docs.append((target, r))
470
# python's distutils-based win32 installer
471
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
472
'ext_modules': ext_modules,
474
'data_files': find_docs(),
475
# for building pyrex extensions
476
'cmdclass': {'build_ext': build_ext_if_possible},
479
ARGS.update(META_INFO)
481
ARGS.update(PKG_DATA)
485
elif 'py2exe' in sys.argv:
490
# pick real bzr version
494
for i in bzrlib.version_info[:4]:
499
version_number.append(str(i))
500
version_str = '.'.join(version_number)
502
# An override to install_data used only by py2exe builds, which arranges
503
# to byte-compile any .py files in data_files (eg, our plugins)
504
# Necessary as we can't rely on the user having the relevant permissions
505
# to the "Program Files" directory to generate them on the fly.
506
class install_data_with_bytecompile(install_data):
508
from distutils.util import byte_compile
510
install_data.run(self)
512
py2exe = self.distribution.get_command_obj('py2exe', False)
513
optimize = py2exe.optimize
514
compile_names = [f for f in self.outfiles if f.endswith('.py')]
515
byte_compile(compile_names,
517
force=self.force, prefix=self.install_dir,
518
dry_run=self.dry_run)
523
self.outfiles.extend([f + suffix for f in compile_names])
524
# end of class install_data_with_bytecompile
526
target = py2exe.build_exe.Target(script = "bzr",
528
icon_resources = [(0,'bzr.ico')],
529
name = META_INFO['name'],
530
version = version_str,
531
description = META_INFO['description'],
532
author = META_INFO['author'],
533
copyright = "(c) Canonical Ltd, 2005-2009",
534
company_name = "Canonical Ltd.",
535
comments = META_INFO['description'],
538
packages = BZRLIB['packages']
539
packages.remove('bzrlib')
540
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
542
for i in glob.glob('bzrlib\\*.py'):
543
module = i[:-3].replace('\\', '.')
544
if module.endswith('__init__'):
545
module = module[:-len('__init__')]
546
includes.append(module)
548
additional_packages = set()
549
if sys.version.startswith('2.4'):
550
# adding elementtree package
551
additional_packages.add('elementtree')
552
elif sys.version.startswith('2.5'):
553
additional_packages.add('xml.etree')
556
warnings.warn('Unknown Python version.\n'
557
'Please check setup.py script for compatibility.')
559
# Although we currently can't enforce it, we consider it an error for
560
# py2exe to report any files are "missing". Such modules we know aren't
561
# used should be listed here.
562
excludes = """Tkinter psyco ElementPath r_hmac
563
ImaginaryModule cElementTree elementtree.ElementTree
564
Crypto.PublicKey._fastmath
565
medusa medusa.filesys medusa.ftp_server
567
resource validate""".split()
570
# email package from std python library use lazy import,
571
# so we need to explicitly add all package
572
additional_packages.add('email')
573
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
574
# a result, packages like 'email.Parser' show as missing. Tell py2exe
577
for oldname in getattr(email, '_LOWERNAMES', []):
578
excludes.append("email." + oldname)
579
for oldname in getattr(email, '_MIMENAMES', []):
580
excludes.append("email.MIME" + oldname)
582
# text files for help topis
583
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
584
topics_files = [('lib/help_topics/en', text_topics)]
588
# XXX - should we consider having the concept of an 'official' build,
589
# which hard-codes the list of plugins, gets more upset if modules are
591
plugins = None # will be a set after plugin sniffing...
592
for root, dirs, files in os.walk('bzrlib/plugins'):
593
if root == 'bzrlib/plugins':
595
# We ship plugins as normal files on the file-system - however,
596
# the build process can cause *some* of these plugin files to end
597
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
598
# library.zip, and then saw import errors related to that as the
599
# rest of the svn plugin wasn't. So we tell py2exe to leave the
600
# plugins out of the .zip file
601
excludes.extend(["bzrlib.plugins." + d for d in dirs])
604
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
606
if i == '__init__.py' and root == 'bzrlib/plugins':
608
x.append(os.path.join(root, i))
610
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
611
plugins_files.append((target_dir, x))
612
# find modules for built-in plugins
613
import tools.package_mf
614
mf = tools.package_mf.CustomModuleFinder()
615
mf.run_package('bzrlib/plugins')
616
packs, mods = mf.get_result()
617
additional_packages.update(packs)
618
includes.extend(mods)
620
console_targets = [target,
621
'tools/win32/bzr_postinstall.py',
624
data_files = topics_files + plugins_files
626
if 'qbzr' in plugins:
627
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
630
get_svn_py2exe_info(includes, excludes, packages)
632
if "TBZR" in os.environ:
633
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
634
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
635
# can be downloaded from (username=guest, blank password):
636
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
637
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
638
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
639
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
640
'TORTOISE_OVERLAYS_MSI_X64'):
641
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
643
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
645
"\nPlease set %s to the location of the relevant"
646
"\nTortoiseOverlays .msi installer file."
647
" The installers can be found at"
649
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
650
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
651
gui_targets, data_files)
653
# print this warning to stderr as output is redirected, so it is seen
654
# at build time. Also to stdout so it appears in the log
655
for f in (sys.stderr, sys.stdout):
657
"Skipping TBZR binaries - please set TBZR to a directory to enable"
659
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
661
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
662
options_list = {"py2exe": {"packages": packages + list(additional_packages),
663
"includes": includes,
664
"excludes": excludes,
665
"dll_excludes": dll_excludes,
666
"dist_dir": "win32_bzr.exe",
671
setup(options=options_list,
672
console=console_targets,
674
zipfile='lib/library.zip',
675
data_files=data_files,
676
cmdclass={'install_data': install_data_with_bytecompile},
680
# ad-hoc for easy_install
682
if not 'bdist_egg' in sys.argv:
683
# generate and install bzr.1 only with plain install, not the
685
DATA_FILES = [('man/man1', ['bzr.1'])]
688
ARGS = {'scripts': ['bzr'],
689
'data_files': DATA_FILES,
690
'cmdclass': command_classes,
691
'ext_modules': ext_modules,
694
ARGS.update(META_INFO)
696
ARGS.update(PKG_DATA)
added
removed
setup.py
