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 --allow-python-fallback to use slower'
201
' 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 Failed to build "%s".\n'
213
' Use --allow-python-fallback to use slower'
214
' 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._knit_load_data_c')
262
if sys.platform == 'win32':
263
add_pyrex_extension('bzrlib._dirstate_helpers_c',
264
libraries=['Ws2_32'])
265
add_pyrex_extension('bzrlib._walkdirs_win32')
267
if have_pyrex and pyrex_version == '0.9.4.1':
268
# Pyrex 0.9.4.1 fails to compile this extension correctly
269
# The code it generates re-uses a "local" pointer and
270
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
271
# which is NULL safe with PY_DECREF which is not.)
272
print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
273
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
275
print 'install. For now, the non-compiled (python) version will'
276
print 'be used instead.'
278
add_pyrex_extension('bzrlib._dirstate_helpers_c')
279
add_pyrex_extension('bzrlib._readdir_pyx')
280
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
283
if unavailable_files:
284
print 'C extension(s) not found:'
285
print ' %s' % ('\n '.join(unavailable_files),)
286
print 'The python versions will be used instead.'
290
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
292
packages.append('tbzrcommands')
294
# ModuleFinder can't handle runtime changes to __path__, but
295
# win32com uses them. Hook this in so win32com.shell is found.
298
import cPickle as pickle
299
for p in win32com.__path__[1:]:
300
modulefinder.AddPackagePath("win32com", p)
301
for extra in ["win32com.shell"]:
303
m = sys.modules[extra]
304
for p in m.__path__[1:]:
305
modulefinder.AddPackagePath(extra, p)
307
# TBZR points to the TBZR directory
308
tbzr_root = os.environ["TBZR"]
310
# Ensure tbzrlib itself is on sys.path
311
sys.path.append(tbzr_root)
313
# Ensure our COM "entry-point" is on sys.path
314
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
316
packages.append("tbzrlib")
318
# collect up our icons.
320
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
321
icos = [] # list of (path_root, relative_ico_path)
322
# First always bzr's icon and its in the root of the bzr tree.
323
icos.append(('', 'bzr.ico'))
324
for root, dirs, files in os.walk(ico_root):
325
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
326
for f in files if f.endswith('.ico')])
327
# allocate an icon ID for each file and the full path to the ico
328
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
329
for rid, (ico_dir, ico_name) in enumerate(icos)]
330
# create a string resource with the mapping. Might as well save the
331
# runtime some effort and write a pickle.
332
# Runtime expects unicode objects with forward-slash seps.
333
fse = sys.getfilesystemencoding()
334
map_items = [(f.replace('\\', '/').decode(fse), rid)
335
for rid, (_, f) in enumerate(icos)]
336
ico_map = dict(map_items)
337
# Create a new resource type of 'ICON_MAP', and use ID=1
338
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
340
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
341
win32ui crawler.Crawler""".split())
345
create_exe = False, # we only want a .dll
347
com_targets.append(tbzr)
349
# tbzrcache executables - a "console" version for debugging and a
350
# GUI version that is generally used.
352
script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
353
icon_resources = icon_resources,
354
other_resources = other_resources,
356
console_targets.append(tbzrcache)
358
# Make a windows version which is the same except for the base name.
359
tbzrcachew = tbzrcache.copy()
360
tbzrcachew["dest_base"]="tbzrcachew"
361
gui_targets.append(tbzrcachew)
363
# ditto for the tbzrcommand tool
365
script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
366
icon_resources = [(0,'bzr.ico')],
368
console_targets.append(tbzrcommand)
369
tbzrcommandw = tbzrcommand.copy()
370
tbzrcommandw["dest_base"]="tbzrcommandw"
371
gui_targets.append(tbzrcommandw)
375
script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
377
console_targets.append(tbzrtest)
379
# A utility to see python output from the shell extension - this will
380
# die when we get a c++ extension
381
# any .py file from pywin32's win32 lib will do (other than
382
# win32traceutil itself that is)
384
win32_lib_dir = os.path.dirname(winerror.__file__)
385
tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
386
dest_base="tbzr_tracer")
387
console_targets.append(tracer)
390
def get_qbzr_py2exe_info(includes, excludes, packages):
391
# PyQt4 itself still escapes the plugin detection code for some reason...
392
packages.append('PyQt4')
393
excludes.append('PyQt4.elementtree.ElementTree')
394
includes.append('sip') # extension module required for Qt.
395
packages.append('pygments') # colorizer for qbzr
396
packages.append('docutils') # html formatting
397
# but we can avoid many Qt4 Dlls.
399
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
400
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
401
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
402
qscintilla2.dll""".split())
403
# the qt binaries might not be on PATH...
404
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
405
path = os.environ.get("PATH","")
406
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
407
os.environ["PATH"] = path + os.pathsep + qt_dir
410
if 'bdist_wininst' in sys.argv:
413
for root, dirs, files in os.walk('doc'):
416
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
417
or f == 'quick-start-summary.svg'):
418
r.append(os.path.join(root, f))
422
target = os.path.join('Doc\\Bazaar', relative)
424
target = 'Doc\\Bazaar'
425
docs.append((target, r))
428
# python's distutils-based win32 installer
429
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
430
'ext_modules': ext_modules,
432
'data_files': find_docs(),
433
# for building pyrex extensions
434
'cmdclass': {'build_ext': build_ext_if_possible},
437
ARGS.update(META_INFO)
439
ARGS.update(PKG_DATA)
443
elif 'py2exe' in sys.argv:
448
# pick real bzr version
452
for i in bzrlib.version_info[:4]:
457
version_number.append(str(i))
458
version_str = '.'.join(version_number)
460
# An override to install_data used only by py2exe builds, which arranges
461
# to byte-compile any .py files in data_files (eg, our plugins)
462
# Necessary as we can't rely on the user having the relevant permissions
463
# to the "Program Files" directory to generate them on the fly.
464
class install_data_with_bytecompile(install_data):
466
from distutils.util import byte_compile
468
install_data.run(self)
470
py2exe = self.distribution.get_command_obj('py2exe', False)
471
optimize = py2exe.optimize
472
compile_names = [f for f in self.outfiles if f.endswith('.py')]
473
byte_compile(compile_names,
475
force=self.force, prefix=self.install_dir,
476
dry_run=self.dry_run)
481
self.outfiles.extend([f + suffix for f in compile_names])
482
# end of class install_data_with_bytecompile
484
target = py2exe.build_exe.Target(script = "bzr",
486
icon_resources = [(0,'bzr.ico')],
487
name = META_INFO['name'],
488
version = version_str,
489
description = META_INFO['description'],
490
author = META_INFO['author'],
491
copyright = "(c) Canonical Ltd, 2005-2007",
492
company_name = "Canonical Ltd.",
493
comments = META_INFO['description'],
496
packages = BZRLIB['packages']
497
packages.remove('bzrlib')
498
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
500
for i in glob.glob('bzrlib\\*.py'):
501
module = i[:-3].replace('\\', '.')
502
if module.endswith('__init__'):
503
module = module[:-len('__init__')]
504
includes.append(module)
506
additional_packages = set()
507
if sys.version.startswith('2.4'):
508
# adding elementtree package
509
additional_packages.add('elementtree')
510
elif sys.version.startswith('2.5'):
511
additional_packages.add('xml.etree')
514
warnings.warn('Unknown Python version.\n'
515
'Please check setup.py script for compatibility.')
517
# Although we currently can't enforce it, we consider it an error for
518
# py2exe to report any files are "missing". Such modules we know aren't
519
# used should be listed here.
520
excludes = """Tkinter psyco ElementPath r_hmac
521
ImaginaryModule cElementTree elementtree.ElementTree
522
Crypto.PublicKey._fastmath
523
medusa medusa.filesys medusa.ftp_server
524
tools tools.doc_generate
525
resource validate""".split()
528
# email package from std python library use lazy import,
529
# so we need to explicitly add all package
530
additional_packages.add('email')
531
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
532
# a result, packages like 'email.Parser' show as missing. Tell py2exe
535
for oldname in getattr(email, '_LOWERNAMES', []):
536
excludes.append("email." + oldname)
537
for oldname in getattr(email, '_MIMENAMES', []):
538
excludes.append("email.MIME" + oldname)
540
# text files for help topis
541
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
542
topics_files = [('lib/help_topics/en', text_topics)]
546
# XXX - should we consider having the concept of an 'official' build,
547
# which hard-codes the list of plugins, gets more upset if modules are
549
plugins = None # will be a set after plugin sniffing...
550
for root, dirs, files in os.walk('bzrlib/plugins'):
551
if root == 'bzrlib/plugins':
555
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
557
if i == '__init__.py' and root == 'bzrlib/plugins':
559
x.append(os.path.join(root, i))
561
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
562
plugins_files.append((target_dir, x))
563
# find modules for built-in plugins
564
import tools.package_mf
565
mf = tools.package_mf.CustomModuleFinder()
566
mf.run_package('bzrlib/plugins')
567
packs, mods = mf.get_result()
568
additional_packages.update(packs)
569
includes.extend(mods)
571
console_targets = [target,
572
'tools/win32/bzr_postinstall.py',
577
if 'qbzr' in plugins:
578
get_qbzr_py2exe_info(includes, excludes, packages)
580
if "TBZR" in os.environ:
581
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
582
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
583
# can be downloaded from (username=guest, blank password):
584
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
585
if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
587
raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
588
" location of the Win32 TortoiseOverlays .msi"
590
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
593
# print this warning to stderr as output is redirected, so it is seen
594
# at build time. Also to stdout so it appears in the log
595
for f in (sys.stderr, sys.stdout):
597
"Skipping TBZR binaries - please set TBZR to a directory to enable"
599
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
601
dll_excludes.append("MSWSOCK.dll")
602
options_list = {"py2exe": {"packages": packages + list(additional_packages),
603
"includes": includes,
604
"excludes": excludes,
605
"dll_excludes": dll_excludes,
606
"dist_dir": "win32_bzr.exe",
611
setup(options=options_list,
612
console=console_targets,
614
com_server=com_targets,
615
zipfile='lib/library.zip',
616
data_files=topics_files + plugins_files,
617
cmdclass={'install_data': install_data_with_bytecompile},
621
# ad-hoc for easy_install
623
if not 'bdist_egg' in sys.argv:
624
# generate and install bzr.1 only with plain install, not easy_install one
625
DATA_FILES = [('man/man1', ['bzr.1'])]
628
ARGS = {'scripts': ['bzr'],
629
'data_files': DATA_FILES,
630
'cmdclass': command_classes,
631
'ext_modules': ext_modules,
634
ARGS.update(META_INFO)
636
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
