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',
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',
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
171
from Pyrex.Distutils import build_ext
172
from Pyrex.Compiler.Version import version as pyrex_version
174
print "No Pyrex, trying Cython..."
175
from Cython.Distutils import build_ext
176
from Cython.Compiler.Version import version as pyrex_version
179
# try to build the extension from the prior generated source.
181
print ("The python package 'Pyrex' is not available."
182
" If the .c files are available,")
183
print ("they will be built,"
184
" but modifying the .pyx files will not rebuild them.")
186
from distutils.command.build_ext import build_ext
191
class build_ext_if_possible(build_ext):
193
user_options = build_ext.user_options + [
194
('allow-python-fallback', None,
195
"When an extension cannot be built, allow falling"
196
" back to the pure-python implementation.")
199
def initialize_options(self):
200
build_ext.initialize_options(self)
201
self.allow_python_fallback = False
206
except DistutilsPlatformError, e:
207
if not self.allow_python_fallback:
208
log.warn('\n Cannot build extensions.\n'
209
' Use "build_ext --allow-python-fallback" to use'
210
' slower python implementations instead.\n')
213
log.warn('\n Extensions cannot be built.\n'
214
' Using the slower Python implementations instead.\n')
216
def build_extension(self, ext):
218
build_ext.build_extension(self, ext)
219
except CCompilerError:
220
if not self.allow_python_fallback:
221
log.warn('\n Cannot build extension "%s".\n'
222
' Use "build_ext --allow-python-fallback" to use'
223
' slower python implementations instead.\n'
226
log.warn('\n Building of "%s" extension failed.\n'
227
' Using the slower Python implementation instead.'
231
# Override the build_ext if we have Pyrex available
232
command_classes['build_ext'] = build_ext_if_possible
233
unavailable_files = []
236
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
237
"""Add a pyrex module to build.
239
This will use Pyrex to auto-generate the .c file if it is available.
240
Otherwise it will fall back on the .c file. If the .c file is not
241
available, it will warn, and not add anything.
243
You can pass any extra options to Extension through kwargs. One example is
246
:param module_name: The python path to the module. This will be used to
247
determine the .pyx and .c files to use.
249
path = module_name.replace('.', '/')
250
pyrex_name = path + '.pyx'
253
if sys.platform == 'win32':
254
# pyrex uses the macro WIN32 to detect the platform, even though it
255
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
256
# give it the right value.
257
define_macros.append(('WIN32', None))
259
source = [pyrex_name]
261
if not os.path.isfile(c_name):
262
unavailable_files.append(c_name)
266
source.extend(extra_source)
267
ext_modules.append(Extension(module_name, source,
268
define_macros=define_macros, libraries=libraries))
271
add_pyrex_extension('bzrlib._annotator_pyx')
272
add_pyrex_extension('bzrlib._bencode_pyx')
273
add_pyrex_extension('bzrlib._btree_serializer_pyx')
274
add_pyrex_extension('bzrlib._chunks_to_lines_pyx')
275
add_pyrex_extension('bzrlib._groupcompress_pyx',
276
extra_source=['bzrlib/diff-delta.c'])
277
add_pyrex_extension('bzrlib._knit_load_data_pyx')
278
add_pyrex_extension('bzrlib._known_graph_pyx')
279
add_pyrex_extension('bzrlib._rio_pyx')
280
if sys.platform == 'win32':
281
add_pyrex_extension('bzrlib._dirstate_helpers_pyx',
282
libraries=['Ws2_32'])
283
add_pyrex_extension('bzrlib._walkdirs_win32')
286
if have_pyrex and pyrex_version == '0.9.4.1':
287
# Pyrex 0.9.4.1 fails to compile this extension correctly
288
# The code it generates re-uses a "local" pointer and
289
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
290
# which is NULL safe with PY_DECREF which is not.)
291
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
292
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
294
print 'install. For now, the non-compiled (python) version will'
295
print 'be used instead.'
297
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
298
add_pyrex_extension('bzrlib._readdir_pyx')
300
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
301
ext_modules.append(Extension('bzrlib._patiencediff_c',
302
['bzrlib/_patiencediff_c.c']))
305
if unavailable_files:
306
print 'C extension(s) not found:'
307
print ' %s' % ('\n '.join(unavailable_files),)
308
print 'The python versions will be used instead.'
312
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
313
gui_targets, data_files):
314
packages.append('tbzrcommands')
316
# ModuleFinder can't handle runtime changes to __path__, but
317
# win32com uses them. Hook this in so win32com.shell is found.
320
import cPickle as pickle
321
for p in win32com.__path__[1:]:
322
modulefinder.AddPackagePath("win32com", p)
323
for extra in ["win32com.shell"]:
325
m = sys.modules[extra]
326
for p in m.__path__[1:]:
327
modulefinder.AddPackagePath(extra, p)
329
# TBZR points to the TBZR directory
330
tbzr_root = os.environ["TBZR"]
332
# Ensure tbzrlib itself is on sys.path
333
sys.path.append(tbzr_root)
335
# Ensure our COM "entry-point" is on sys.path
336
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
338
packages.append("tbzrlib")
340
# collect up our icons.
342
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
343
icos = [] # list of (path_root, relative_ico_path)
344
# First always bzr's icon and its in the root of the bzr tree.
345
icos.append(('', 'bzr.ico'))
346
for root, dirs, files in os.walk(ico_root):
347
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
348
for f in files if f.endswith('.ico')])
349
# allocate an icon ID for each file and the full path to the ico
350
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
351
for rid, (ico_dir, ico_name) in enumerate(icos)]
352
# create a string resource with the mapping. Might as well save the
353
# runtime some effort and write a pickle.
354
# Runtime expects unicode objects with forward-slash seps.
355
fse = sys.getfilesystemencoding()
356
map_items = [(f.replace('\\', '/').decode(fse), rid)
357
for rid, (_, f) in enumerate(icos)]
358
ico_map = dict(map_items)
359
# Create a new resource type of 'ICON_MAP', and use ID=1
360
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
362
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
363
win32ui crawler.Crawler""".split())
365
# NOTE: We still create a DLL version of the Python implemented shell
366
# extension for testing purposes - but it is *not* registered by
367
# default - our C++ one is instead. To discourage people thinking
368
# this DLL is still necessary, its called 'tbzr_old.dll'
371
create_exe = False, # we only want a .dll
372
dest_base = 'tbzr_old',
374
com_targets.append(tbzr)
376
# tbzrcache executables - a "console" version for debugging and a
377
# GUI version that is generally used.
379
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
380
icon_resources = icon_resources,
381
other_resources = other_resources,
383
console_targets.append(tbzrcache)
385
# Make a windows version which is the same except for the base name.
386
tbzrcachew = tbzrcache.copy()
387
tbzrcachew["dest_base"]="tbzrcachew"
388
gui_targets.append(tbzrcachew)
390
# ditto for the tbzrcommand tool
392
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
393
icon_resources = [(0,'bzr.ico')],
395
console_targets.append(tbzrcommand)
396
tbzrcommandw = tbzrcommand.copy()
397
tbzrcommandw["dest_base"]="tbzrcommandw"
398
gui_targets.append(tbzrcommandw)
400
# A utility to see python output from both C++ and Python based shell
402
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
403
console_targets.append(tracer)
405
# The C++ implemented shell extensions.
406
dist_dir = os.path.join(tbzr_root, "shellext", "cpp", "tbzrshellext",
408
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
409
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
412
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
413
# PyQt4 itself still escapes the plugin detection code for some reason...
414
packages.append('PyQt4')
415
excludes.append('PyQt4.elementtree.ElementTree')
416
includes.append('sip') # extension module required for Qt.
417
packages.append('pygments') # colorizer for qbzr
418
packages.append('docutils') # html formatting
419
includes.append('win32event') # for qsubprocess stuff
420
# but we can avoid many Qt4 Dlls.
422
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
423
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
424
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
425
qscintilla2.dll""".split())
426
# the qt binaries might not be on PATH...
427
# They seem to install to a place like C:\Python25\PyQt4\*
428
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
429
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
430
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
431
if os.path.isdir(pyqt_bin_dir):
432
path = os.environ.get("PATH", "")
433
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
434
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
435
# also add all imageformat plugins to distribution
436
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
437
base_dirs_to_check = []
438
if os.path.isdir(pyqt_dir):
439
base_dirs_to_check.append(pyqt_dir)
445
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
446
if pyqt4_base_dir != pyqt_dir:
447
base_dirs_to_check.append(pyqt4_base_dir)
448
if not base_dirs_to_check:
449
log.warn("Can't find PyQt4 installation -> not including imageformat"
453
for base_dir in base_dirs_to_check:
454
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
455
if os.path.isdir(plug_dir):
456
for fname in os.listdir(plug_dir):
457
# Include plugin dlls, but not debugging dlls
458
fullpath = os.path.join(plug_dir, fname)
459
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
460
files.append(fullpath)
462
data_files.append(('imageformats', files))
464
log.warn('PyQt4 was found, but we could not find any imageformat'
465
' plugins. Are you sure your configuration is correct?')
468
def get_svn_py2exe_info(includes, excludes, packages):
469
packages.append('subvertpy')
472
if 'bdist_wininst' in sys.argv:
475
for root, dirs, files in os.walk('doc'):
478
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
479
or f == 'quick-start-summary.svg'):
480
r.append(os.path.join(root, f))
484
target = os.path.join('Doc\\Bazaar', relative)
486
target = 'Doc\\Bazaar'
487
docs.append((target, r))
490
# python's distutils-based win32 installer
491
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
492
'ext_modules': ext_modules,
494
'data_files': find_docs(),
495
# for building pyrex extensions
496
'cmdclass': {'build_ext': build_ext_if_possible},
499
ARGS.update(META_INFO)
501
ARGS.update(PKG_DATA)
505
elif 'py2exe' in sys.argv:
510
# pick real bzr version
514
for i in bzrlib.version_info[:4]:
519
version_number.append(str(i))
520
version_str = '.'.join(version_number)
522
# An override to install_data used only by py2exe builds, which arranges
523
# to byte-compile any .py files in data_files (eg, our plugins)
524
# Necessary as we can't rely on the user having the relevant permissions
525
# to the "Program Files" directory to generate them on the fly.
526
class install_data_with_bytecompile(install_data):
528
from distutils.util import byte_compile
530
install_data.run(self)
532
py2exe = self.distribution.get_command_obj('py2exe', False)
533
optimize = py2exe.optimize
534
compile_names = [f for f in self.outfiles if f.endswith('.py')]
535
byte_compile(compile_names,
537
force=self.force, prefix=self.install_dir,
538
dry_run=self.dry_run)
543
self.outfiles.extend([f + suffix for f in compile_names])
544
# end of class install_data_with_bytecompile
546
target = py2exe.build_exe.Target(script = "bzr",
548
icon_resources = [(0,'bzr.ico')],
549
name = META_INFO['name'],
550
version = version_str,
551
description = META_INFO['description'],
552
author = META_INFO['author'],
553
copyright = "(c) Canonical Ltd, 2005-2009",
554
company_name = "Canonical Ltd.",
555
comments = META_INFO['description'],
558
packages = BZRLIB['packages']
559
packages.remove('bzrlib')
560
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
562
for i in glob.glob('bzrlib\\*.py'):
563
module = i[:-3].replace('\\', '.')
564
if module.endswith('__init__'):
565
module = module[:-len('__init__')]
566
includes.append(module)
568
additional_packages = set()
569
if sys.version.startswith('2.4'):
570
# adding elementtree package
571
additional_packages.add('elementtree')
572
elif sys.version.startswith('2.5'):
573
additional_packages.add('xml.etree')
576
warnings.warn('Unknown Python version.\n'
577
'Please check setup.py script for compatibility.')
579
# Although we currently can't enforce it, we consider it an error for
580
# py2exe to report any files are "missing". Such modules we know aren't
581
# used should be listed here.
582
excludes = """Tkinter psyco ElementPath r_hmac
583
ImaginaryModule cElementTree elementtree.ElementTree
584
Crypto.PublicKey._fastmath
585
medusa medusa.filesys medusa.ftp_server
587
resource validate""".split()
590
# email package from std python library use lazy import,
591
# so we need to explicitly add all package
592
additional_packages.add('email')
593
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
594
# a result, packages like 'email.Parser' show as missing. Tell py2exe
597
for oldname in getattr(email, '_LOWERNAMES', []):
598
excludes.append("email." + oldname)
599
for oldname in getattr(email, '_MIMENAMES', []):
600
excludes.append("email.MIME" + oldname)
602
# text files for help topis
603
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
604
topics_files = [('lib/help_topics/en', text_topics)]
608
# XXX - should we consider having the concept of an 'official' build,
609
# which hard-codes the list of plugins, gets more upset if modules are
611
plugins = None # will be a set after plugin sniffing...
612
for root, dirs, files in os.walk('bzrlib/plugins'):
613
if root == 'bzrlib/plugins':
615
# We ship plugins as normal files on the file-system - however,
616
# the build process can cause *some* of these plugin files to end
617
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
618
# library.zip, and then saw import errors related to that as the
619
# rest of the svn plugin wasn't. So we tell py2exe to leave the
620
# plugins out of the .zip file
621
excludes.extend(["bzrlib.plugins." + d for d in dirs])
624
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
626
if i == '__init__.py' and root == 'bzrlib/plugins':
628
x.append(os.path.join(root, i))
630
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
631
plugins_files.append((target_dir, x))
632
# find modules for built-in plugins
633
import tools.package_mf
634
mf = tools.package_mf.CustomModuleFinder()
635
mf.run_package('bzrlib/plugins')
636
packs, mods = mf.get_result()
637
additional_packages.update(packs)
638
includes.extend(mods)
640
console_targets = [target,
641
'tools/win32/bzr_postinstall.py',
645
data_files = topics_files + plugins_files
647
if 'qbzr' in plugins:
648
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
651
get_svn_py2exe_info(includes, excludes, packages)
653
if "TBZR" in os.environ:
654
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
655
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
656
# can be downloaded from (username=guest, blank password):
657
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
658
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
659
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
660
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
661
'TORTOISE_OVERLAYS_MSI_X64'):
662
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
664
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
666
"\nPlease set %s to the location of the relevant"
667
"\nTortoiseOverlays .msi installer file."
668
" The installers can be found at"
670
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
671
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
672
gui_targets, data_files)
674
# print this warning to stderr as output is redirected, so it is seen
675
# at build time. Also to stdout so it appears in the log
676
for f in (sys.stderr, sys.stdout):
678
"Skipping TBZR binaries - please set TBZR to a directory to enable"
680
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
682
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
683
options_list = {"py2exe": {"packages": packages + list(additional_packages),
684
"includes": includes,
685
"excludes": excludes,
686
"dll_excludes": dll_excludes,
687
"dist_dir": "win32_bzr.exe",
692
setup(options=options_list,
693
console=console_targets,
695
com_server=com_targets,
696
zipfile='lib/library.zip',
697
data_files=data_files,
698
cmdclass={'install_data': install_data_with_bytecompile},
702
# ad-hoc for easy_install
704
if not 'bdist_egg' in sys.argv:
705
# generate and install bzr.1 only with plain install, not the
707
DATA_FILES = [('man/man1', ['bzr.1'])]
710
ARGS = {'scripts': ['bzr'],
711
'data_files': DATA_FILES,
712
'cmdclass': command_classes,
713
'ext_modules': ext_modules,
716
ARGS.update(META_INFO)
718
ARGS.update(PKG_DATA)
added
removed
setup.py
