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 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 should
246
# be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
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._btree_serializer_c')
263
add_pyrex_extension('bzrlib._groupcompress_pyx',
264
extra_source=['bzrlib/diff-delta.c'])
265
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
266
add_pyrex_extension('bzrlib._knit_load_data_c')
267
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=['z'])
268
if sys.platform == 'win32':
269
add_pyrex_extension('bzrlib._dirstate_helpers_c',
270
libraries=['Ws2_32'])
271
add_pyrex_extension('bzrlib._walkdirs_win32')
273
if have_pyrex and pyrex_version == '0.9.4.1':
274
# Pyrex 0.9.4.1 fails to compile this extension correctly
275
# The code it generates re-uses a "local" pointer and
276
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
277
# which is NULL safe with PY_DECREF which is not.)
278
print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
279
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
281
print 'install. For now, the non-compiled (python) version will'
282
print 'be used instead.'
284
add_pyrex_extension('bzrlib._dirstate_helpers_c')
285
add_pyrex_extension('bzrlib._readdir_pyx')
286
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
289
if unavailable_files:
290
print 'C extension(s) not found:'
291
print ' %s' % ('\n '.join(unavailable_files),)
292
print 'The python versions will be used instead.'
296
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
297
gui_targets, data_files):
298
packages.append('tbzrcommands')
300
# ModuleFinder can't handle runtime changes to __path__, but
301
# win32com uses them. Hook this in so win32com.shell is found.
304
import cPickle as pickle
305
for p in win32com.__path__[1:]:
306
modulefinder.AddPackagePath("win32com", p)
307
for extra in ["win32com.shell"]:
309
m = sys.modules[extra]
310
for p in m.__path__[1:]:
311
modulefinder.AddPackagePath(extra, p)
313
# TBZR points to the TBZR directory
314
tbzr_root = os.environ["TBZR"]
316
# Ensure tbzrlib itself is on sys.path
317
sys.path.append(tbzr_root)
319
# Ensure our COM "entry-point" is on sys.path
320
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
322
packages.append("tbzrlib")
324
# collect up our icons.
326
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
327
icos = [] # list of (path_root, relative_ico_path)
328
# First always bzr's icon and its in the root of the bzr tree.
329
icos.append(('', 'bzr.ico'))
330
for root, dirs, files in os.walk(ico_root):
331
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
332
for f in files if f.endswith('.ico')])
333
# allocate an icon ID for each file and the full path to the ico
334
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
335
for rid, (ico_dir, ico_name) in enumerate(icos)]
336
# create a string resource with the mapping. Might as well save the
337
# runtime some effort and write a pickle.
338
# Runtime expects unicode objects with forward-slash seps.
339
fse = sys.getfilesystemencoding()
340
map_items = [(f.replace('\\', '/').decode(fse), rid)
341
for rid, (_, f) in enumerate(icos)]
342
ico_map = dict(map_items)
343
# Create a new resource type of 'ICON_MAP', and use ID=1
344
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
346
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
347
win32ui crawler.Crawler""".split())
349
# NOTE: We still create a DLL version of the Python implemented shell
350
# extension for testing purposes - but it is *not* registered by
351
# default - our C++ one is instead. To discourage people thinking
352
# this DLL is still necessary, its called 'tbzr_old.dll'
355
create_exe = False, # we only want a .dll
356
dest_base = 'tbzr_old',
358
com_targets.append(tbzr)
360
# tbzrcache executables - a "console" version for debugging and a
361
# GUI version that is generally used.
363
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
364
icon_resources = icon_resources,
365
other_resources = other_resources,
367
console_targets.append(tbzrcache)
369
# Make a windows version which is the same except for the base name.
370
tbzrcachew = tbzrcache.copy()
371
tbzrcachew["dest_base"]="tbzrcachew"
372
gui_targets.append(tbzrcachew)
374
# ditto for the tbzrcommand tool
376
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
377
icon_resources = [(0,'bzr.ico')],
379
console_targets.append(tbzrcommand)
380
tbzrcommandw = tbzrcommand.copy()
381
tbzrcommandw["dest_base"]="tbzrcommandw"
382
gui_targets.append(tbzrcommandw)
384
# A utility to see python output from both C++ and Python based shell
386
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
387
console_targets.append(tracer)
389
# The C++ implemented shell extensions.
390
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
392
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
393
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
396
def get_qbzr_py2exe_info(includes, excludes, packages):
397
# PyQt4 itself still escapes the plugin detection code for some reason...
398
packages.append('PyQt4')
399
excludes.append('PyQt4.elementtree.ElementTree')
400
includes.append('sip') # extension module required for Qt.
401
packages.append('pygments') # colorizer for qbzr
402
packages.append('docutils') # html formatting
403
# but we can avoid many Qt4 Dlls.
405
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
406
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
407
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
408
qscintilla2.dll""".split())
409
# the qt binaries might not be on PATH...
410
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
411
path = os.environ.get("PATH","")
412
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
413
os.environ["PATH"] = path + os.pathsep + qt_dir
416
def get_svn_py2exe_info(includes, excludes, packages):
417
packages.append('subvertpy')
420
if 'bdist_wininst' in sys.argv:
423
for root, dirs, files in os.walk('doc'):
426
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
427
or f == 'quick-start-summary.svg'):
428
r.append(os.path.join(root, f))
432
target = os.path.join('Doc\\Bazaar', relative)
434
target = 'Doc\\Bazaar'
435
docs.append((target, r))
438
# python's distutils-based win32 installer
439
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
440
'ext_modules': ext_modules,
442
'data_files': find_docs(),
443
# for building pyrex extensions
444
'cmdclass': {'build_ext': build_ext_if_possible},
447
ARGS.update(META_INFO)
449
ARGS.update(PKG_DATA)
453
elif 'py2exe' in sys.argv:
458
# pick real bzr version
462
for i in bzrlib.version_info[:4]:
467
version_number.append(str(i))
468
version_str = '.'.join(version_number)
470
# An override to install_data used only by py2exe builds, which arranges
471
# to byte-compile any .py files in data_files (eg, our plugins)
472
# Necessary as we can't rely on the user having the relevant permissions
473
# to the "Program Files" directory to generate them on the fly.
474
class install_data_with_bytecompile(install_data):
476
from distutils.util import byte_compile
478
install_data.run(self)
480
py2exe = self.distribution.get_command_obj('py2exe', False)
481
optimize = py2exe.optimize
482
compile_names = [f for f in self.outfiles if f.endswith('.py')]
483
byte_compile(compile_names,
485
force=self.force, prefix=self.install_dir,
486
dry_run=self.dry_run)
491
self.outfiles.extend([f + suffix for f in compile_names])
492
# end of class install_data_with_bytecompile
494
target = py2exe.build_exe.Target(script = "bzr",
496
icon_resources = [(0,'bzr.ico')],
497
name = META_INFO['name'],
498
version = version_str,
499
description = META_INFO['description'],
500
author = META_INFO['author'],
501
copyright = "(c) Canonical Ltd, 2005-2007",
502
company_name = "Canonical Ltd.",
503
comments = META_INFO['description'],
506
packages = BZRLIB['packages']
507
packages.remove('bzrlib')
508
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
510
for i in glob.glob('bzrlib\\*.py'):
511
module = i[:-3].replace('\\', '.')
512
if module.endswith('__init__'):
513
module = module[:-len('__init__')]
514
includes.append(module)
516
additional_packages = set()
517
if sys.version.startswith('2.4'):
518
# adding elementtree package
519
additional_packages.add('elementtree')
520
elif sys.version.startswith('2.5'):
521
additional_packages.add('xml.etree')
524
warnings.warn('Unknown Python version.\n'
525
'Please check setup.py script for compatibility.')
527
# Although we currently can't enforce it, we consider it an error for
528
# py2exe to report any files are "missing". Such modules we know aren't
529
# used should be listed here.
530
excludes = """Tkinter psyco ElementPath r_hmac
531
ImaginaryModule cElementTree elementtree.ElementTree
532
Crypto.PublicKey._fastmath
533
medusa medusa.filesys medusa.ftp_server
534
tools tools.doc_generate
535
resource validate""".split()
538
# email package from std python library use lazy import,
539
# so we need to explicitly add all package
540
additional_packages.add('email')
541
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
542
# a result, packages like 'email.Parser' show as missing. Tell py2exe
545
for oldname in getattr(email, '_LOWERNAMES', []):
546
excludes.append("email." + oldname)
547
for oldname in getattr(email, '_MIMENAMES', []):
548
excludes.append("email.MIME" + oldname)
550
# text files for help topis
551
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
552
topics_files = [('lib/help_topics/en', text_topics)]
556
# XXX - should we consider having the concept of an 'official' build,
557
# which hard-codes the list of plugins, gets more upset if modules are
559
plugins = None # will be a set after plugin sniffing...
560
for root, dirs, files in os.walk('bzrlib/plugins'):
561
if root == 'bzrlib/plugins':
563
# We ship plugins as normal files on the file-system - however,
564
# the build process can cause *some* of these plugin files to end
565
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
566
# library.zip, and then saw import errors related to that as the
567
# rest of the svn plugin wasn't. So we tell py2exe to leave the
568
# plugins out of the .zip file
569
excludes.extend(["bzrlib.plugins." + d for d in dirs])
572
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
574
if i == '__init__.py' and root == 'bzrlib/plugins':
576
x.append(os.path.join(root, i))
578
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
579
plugins_files.append((target_dir, x))
580
# find modules for built-in plugins
581
import tools.package_mf
582
mf = tools.package_mf.CustomModuleFinder()
583
mf.run_package('bzrlib/plugins')
584
packs, mods = mf.get_result()
585
additional_packages.update(packs)
586
includes.extend(mods)
588
console_targets = [target,
589
'tools/win32/bzr_postinstall.py',
593
data_files = topics_files + plugins_files
595
if 'qbzr' in plugins:
596
get_qbzr_py2exe_info(includes, excludes, packages)
599
get_svn_py2exe_info(includes, excludes, packages)
601
if "TBZR" in os.environ:
602
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
603
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
604
# can be downloaded from (username=guest, blank password):
605
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
606
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
607
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
608
'TORTOISE_OVERLAYS_MSI_X64'):
609
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
610
raise RuntimeError("Please set %s to the"
611
" location of the relevant TortoiseOverlays"
612
" .msi installer file" % needed)
613
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
614
gui_targets, data_files)
616
# print this warning to stderr as output is redirected, so it is seen
617
# at build time. Also to stdout so it appears in the log
618
for f in (sys.stderr, sys.stdout):
620
"Skipping TBZR binaries - please set TBZR to a directory to enable"
622
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
624
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
625
options_list = {"py2exe": {"packages": packages + list(additional_packages),
626
"includes": includes,
627
"excludes": excludes,
628
"dll_excludes": dll_excludes,
629
"dist_dir": "win32_bzr.exe",
634
setup(options=options_list,
635
console=console_targets,
637
com_server=com_targets,
638
zipfile='lib/library.zip',
639
data_files=data_files,
640
cmdclass={'install_data': install_data_with_bytecompile},
644
# ad-hoc for easy_install
646
if not 'bdist_egg' in sys.argv:
647
# generate and install bzr.1 only with plain install, not easy_install one
648
DATA_FILES = [('man/man1', ['bzr.1'])]
651
ARGS = {'scripts': ['bzr'],
652
'data_files': DATA_FILES,
653
'cmdclass': command_classes,
654
'ext_modules': ext_modules,
657
ARGS.update(META_INFO)
659
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
