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.
151
from tools import generate_docs
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 extension "%s".\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, extra_source=[]):
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
246
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
247
# give it the right value.
248
define_macros.append(('WIN32', None))
250
source = [pyrex_name]
252
if not os.path.isfile(c_name):
253
unavailable_files.append(c_name)
257
source.extend(extra_source)
258
ext_modules.append(Extension(module_name, source,
259
define_macros=define_macros, libraries=libraries))
262
add_pyrex_extension('bzrlib._annotator_pyx')
263
add_pyrex_extension('bzrlib._bencode_pyx')
264
add_pyrex_extension('bzrlib._btree_serializer_pyx')
265
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
266
add_pyrex_extension('bzrlib._groupcompress_pyx',
267
extra_source=['bzrlib/diff-delta.c'])
268
add_pyrex_extension('bzrlib._knit_load_data_pyx')
269
add_pyrex_extension('bzrlib._known_graph_pyx')
270
add_pyrex_extension('bzrlib._rio_pyx')
271
if sys.platform == 'win32':
272
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
273
libraries=['Ws2_32'])
274
add_pyrex_extension('bzrlib._walkdirs_win32')
277
if have_pyrex and pyrex_version == '0.9.4.1':
278
# Pyrex 0.9.4.1 fails to compile this extension correctly
279
# The code it generates re-uses a "local" pointer and
280
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
281
# which is NULL safe with PY_DECREF which is not.)
282
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
283
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
285
print 'install. For now, the non-compiled (python) version will'
286
print 'be used instead.'
288
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
289
add_pyrex_extension('bzrlib._readdir_pyx')
291
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
292
ext_modules.append(Extension('bzrlib._patiencediff_c',
293
['bzrlib/_patiencediff_c.c']))
296
if unavailable_files:
297
print 'C extension(s) not found:'
298
print ' %s' % ('\n '.join(unavailable_files),)
299
print 'The python versions will be used instead.'
303
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
304
gui_targets, data_files):
305
packages.append('tbzrcommands')
307
# ModuleFinder can't handle runtime changes to __path__, but
308
# win32com uses them. Hook this in so win32com.shell is found.
311
import cPickle as pickle
312
for p in win32com.__path__[1:]:
313
modulefinder.AddPackagePath("win32com", p)
314
for extra in ["win32com.shell"]:
316
m = sys.modules[extra]
317
for p in m.__path__[1:]:
318
modulefinder.AddPackagePath(extra, p)
320
# TBZR points to the TBZR directory
321
tbzr_root = os.environ["TBZR"]
323
# Ensure tbzrlib itself is on sys.path
324
sys.path.append(tbzr_root)
326
# Ensure our COM "entry-point" is on sys.path
327
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
329
packages.append("tbzrlib")
331
# collect up our icons.
333
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
334
icos = [] # list of (path_root, relative_ico_path)
335
# First always bzr's icon and its in the root of the bzr tree.
336
icos.append(('', 'bzr.ico'))
337
for root, dirs, files in os.walk(ico_root):
338
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
339
for f in files if f.endswith('.ico')])
340
# allocate an icon ID for each file and the full path to the ico
341
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
342
for rid, (ico_dir, ico_name) in enumerate(icos)]
343
# create a string resource with the mapping. Might as well save the
344
# runtime some effort and write a pickle.
345
# Runtime expects unicode objects with forward-slash seps.
346
fse = sys.getfilesystemencoding()
347
map_items = [(f.replace('\\', '/').decode(fse), rid)
348
for rid, (_, f) in enumerate(icos)]
349
ico_map = dict(map_items)
350
# Create a new resource type of 'ICON_MAP', and use ID=1
351
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
353
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
354
win32ui crawler.Crawler""".split())
356
# NOTE: We still create a DLL version of the Python implemented shell
357
# extension for testing purposes - but it is *not* registered by
358
# default - our C++ one is instead. To discourage people thinking
359
# this DLL is still necessary, its called 'tbzr_old.dll'
362
create_exe = False, # we only want a .dll
363
dest_base = 'tbzr_old',
365
com_targets.append(tbzr)
367
# tbzrcache executables - a "console" version for debugging and a
368
# GUI version that is generally used.
370
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
371
icon_resources = icon_resources,
372
other_resources = other_resources,
374
console_targets.append(tbzrcache)
376
# Make a windows version which is the same except for the base name.
377
tbzrcachew = tbzrcache.copy()
378
tbzrcachew["dest_base"]="tbzrcachew"
379
gui_targets.append(tbzrcachew)
381
# ditto for the tbzrcommand tool
383
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
384
icon_resources = [(0,'bzr.ico')],
386
console_targets.append(tbzrcommand)
387
tbzrcommandw = tbzrcommand.copy()
388
tbzrcommandw["dest_base"]="tbzrcommandw"
389
gui_targets.append(tbzrcommandw)
391
# A utility to see python output from both C++ and Python based shell
393
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
394
console_targets.append(tracer)
396
# The C++ implemented shell extensions.
397
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
399
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
400
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
403
def get_qbzr_py2exe_info(includes, excludes, packages):
404
# PyQt4 itself still escapes the plugin detection code for some reason...
405
packages.append('PyQt4')
406
excludes.append('PyQt4.elementtree.ElementTree')
407
includes.append('sip') # extension module required for Qt.
408
packages.append('pygments') # colorizer for qbzr
409
packages.append('docutils') # html formatting
410
# but we can avoid many Qt4 Dlls.
412
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
413
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
414
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
415
qscintilla2.dll""".split())
416
# the qt binaries might not be on PATH...
417
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
418
path = os.environ.get("PATH","")
419
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
420
os.environ["PATH"] = path + os.pathsep + qt_dir
423
def get_svn_py2exe_info(includes, excludes, packages):
424
packages.append('subvertpy')
427
if 'bdist_wininst' in sys.argv:
430
for root, dirs, files in os.walk('doc'):
433
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
434
or f == 'quick-start-summary.svg'):
435
r.append(os.path.join(root, f))
439
target = os.path.join('Doc\\Bazaar', relative)
441
target = 'Doc\\Bazaar'
442
docs.append((target, r))
445
# python's distutils-based win32 installer
446
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
447
'ext_modules': ext_modules,
449
'data_files': find_docs(),
450
# for building pyrex extensions
451
'cmdclass': {'build_ext': build_ext_if_possible},
454
ARGS.update(META_INFO)
456
ARGS.update(PKG_DATA)
460
elif 'py2exe' in sys.argv:
465
# pick real bzr version
469
for i in bzrlib.version_info[:4]:
474
version_number.append(str(i))
475
version_str = '.'.join(version_number)
477
# An override to install_data used only by py2exe builds, which arranges
478
# to byte-compile any .py files in data_files (eg, our plugins)
479
# Necessary as we can't rely on the user having the relevant permissions
480
# to the "Program Files" directory to generate them on the fly.
481
class install_data_with_bytecompile(install_data):
483
from distutils.util import byte_compile
485
install_data.run(self)
487
py2exe = self.distribution.get_command_obj('py2exe', False)
488
optimize = py2exe.optimize
489
compile_names = [f for f in self.outfiles if f.endswith('.py')]
490
byte_compile(compile_names,
492
force=self.force, prefix=self.install_dir,
493
dry_run=self.dry_run)
498
self.outfiles.extend([f + suffix for f in compile_names])
499
# end of class install_data_with_bytecompile
501
target = py2exe.build_exe.Target(script = "bzr",
503
icon_resources = [(0,'bzr.ico')],
504
name = META_INFO['name'],
505
version = version_str,
506
description = META_INFO['description'],
507
author = META_INFO['author'],
508
copyright = "(c) Canonical Ltd, 2005-2007",
509
company_name = "Canonical Ltd.",
510
comments = META_INFO['description'],
513
packages = BZRLIB['packages']
514
packages.remove('bzrlib')
515
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
517
for i in glob.glob('bzrlib\\*.py'):
518
module = i[:-3].replace('\\', '.')
519
if module.endswith('__init__'):
520
module = module[:-len('__init__')]
521
includes.append(module)
523
additional_packages = set()
524
if sys.version.startswith('2.4'):
525
# adding elementtree package
526
additional_packages.add('elementtree')
527
elif sys.version.startswith('2.5'):
528
additional_packages.add('xml.etree')
531
warnings.warn('Unknown Python version.\n'
532
'Please check setup.py script for compatibility.')
534
# Although we currently can't enforce it, we consider it an error for
535
# py2exe to report any files are "missing". Such modules we know aren't
536
# used should be listed here.
537
excludes = """Tkinter psyco ElementPath r_hmac
538
ImaginaryModule cElementTree elementtree.ElementTree
539
Crypto.PublicKey._fastmath
540
medusa medusa.filesys medusa.ftp_server
542
resource validate""".split()
545
# email package from std python library use lazy import,
546
# so we need to explicitly add all package
547
additional_packages.add('email')
548
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
549
# a result, packages like 'email.Parser' show as missing. Tell py2exe
552
for oldname in getattr(email, '_LOWERNAMES', []):
553
excludes.append("email." + oldname)
554
for oldname in getattr(email, '_MIMENAMES', []):
555
excludes.append("email.MIME" + oldname)
557
# text files for help topis
558
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
559
topics_files = [('lib/help_topics/en', text_topics)]
563
# XXX - should we consider having the concept of an 'official' build,
564
# which hard-codes the list of plugins, gets more upset if modules are
566
plugins = None # will be a set after plugin sniffing...
567
for root, dirs, files in os.walk('bzrlib/plugins'):
568
if root == 'bzrlib/plugins':
570
# We ship plugins as normal files on the file-system - however,
571
# the build process can cause *some* of these plugin files to end
572
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
573
# library.zip, and then saw import errors related to that as the
574
# rest of the svn plugin wasn't. So we tell py2exe to leave the
575
# plugins out of the .zip file
576
excludes.extend(["bzrlib.plugins." + d for d in dirs])
579
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
581
if i == '__init__.py' and root == 'bzrlib/plugins':
583
x.append(os.path.join(root, i))
585
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
586
plugins_files.append((target_dir, x))
587
# find modules for built-in plugins
588
import tools.package_mf
589
mf = tools.package_mf.CustomModuleFinder()
590
mf.run_package('bzrlib/plugins')
591
packs, mods = mf.get_result()
592
additional_packages.update(packs)
593
includes.extend(mods)
595
console_targets = [target,
596
'tools/win32/bzr_postinstall.py',
600
data_files = topics_files + plugins_files
602
if 'qbzr' in plugins:
603
get_qbzr_py2exe_info(includes, excludes, packages)
606
get_svn_py2exe_info(includes, excludes, packages)
608
if "TBZR" in os.environ:
609
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
610
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
611
# can be downloaded from (username=guest, blank password):
612
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
613
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
614
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
615
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
616
'TORTOISE_OVERLAYS_MSI_X64'):
617
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
619
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
621
"\nPlease set %s to the location of the relevant"
622
"\nTortoiseOverlays .msi installer file."
623
" The installers can be found at"
625
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
626
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
627
gui_targets, data_files)
629
# print this warning to stderr as output is redirected, so it is seen
630
# at build time. Also to stdout so it appears in the log
631
for f in (sys.stderr, sys.stdout):
633
"Skipping TBZR binaries - please set TBZR to a directory to enable"
635
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
637
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
638
options_list = {"py2exe": {"packages": packages + list(additional_packages),
639
"includes": includes,
640
"excludes": excludes,
641
"dll_excludes": dll_excludes,
642
"dist_dir": "win32_bzr.exe",
647
setup(options=options_list,
648
console=console_targets,
650
com_server=com_targets,
651
zipfile='lib/library.zip',
652
data_files=data_files,
653
cmdclass={'install_data': install_data_with_bytecompile},
657
# ad-hoc for easy_install
659
if not 'bdist_egg' in sys.argv:
660
# generate and install bzr.1 only with plain install, not the
662
DATA_FILES = [('man/man1', ['bzr.1'])]
665
ARGS = {'scripts': ['bzr'],
666
'data_files': DATA_FILES,
667
'cmdclass': command_classes,
668
'ext_modules': ext_modules,
671
ARGS.update(META_INFO)
673
ARGS.update(PKG_DATA)
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',
22
'bzrlib.util.urlgrabber'],
added
removed
setup.py
