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://bazaar.canonical.com/',
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
3
# This is an installation script for bzr. Run it with
4
# './setup.py install', or
5
# './setup.py --help' for more options
100
7
from distutils.core import setup
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
189
pyrex_version_info = tuple(map(int, pyrex_version.split('.')))
192
class build_ext_if_possible(build_ext):
194
user_options = build_ext.user_options + [
195
('allow-python-fallback', None,
196
"When an extension cannot be built, allow falling"
197
" back to the pure-python implementation.")
200
def initialize_options(self):
201
build_ext.initialize_options(self)
202
self.allow_python_fallback = False
207
except DistutilsPlatformError, e:
208
if not self.allow_python_fallback:
209
log.warn('\n Cannot build extensions.\n'
210
' Use "build_ext --allow-python-fallback" to use'
211
' slower python implementations instead.\n')
214
log.warn('\n Extensions cannot be built.\n'
215
' Using the slower Python implementations instead.\n')
217
def build_extension(self, ext):
219
build_ext.build_extension(self, ext)
220
except CCompilerError:
221
if not self.allow_python_fallback:
222
log.warn('\n Cannot build extension "%s".\n'
223
' Use "build_ext --allow-python-fallback" to use'
224
' slower python implementations instead.\n'
227
log.warn('\n Building of "%s" extension failed.\n'
228
' Using the slower Python implementation instead.'
232
# Override the build_ext if we have Pyrex available
233
command_classes['build_ext'] = build_ext_if_possible
234
unavailable_files = []
237
def add_pyrex_extension(module_name, libraries=None, extra_source=[]):
238
"""Add a pyrex module to build.
240
This will use Pyrex to auto-generate the .c file if it is available.
241
Otherwise it will fall back on the .c file. If the .c file is not
242
available, it will warn, and not add anything.
244
You can pass any extra options to Extension through kwargs. One example is
247
:param module_name: The python path to the module. This will be used to
248
determine the .pyx and .c files to use.
250
path = module_name.replace('.', '/')
251
pyrex_name = path + '.pyx'
254
if sys.platform == 'win32':
255
# pyrex uses the macro WIN32 to detect the platform, even though it
256
# should be using something like _WIN32 or MS_WINDOWS, oh well, we can
257
# give it the right value.
258
define_macros.append(('WIN32', None))
260
source = [pyrex_name]
262
if not os.path.isfile(c_name):
263
unavailable_files.append(c_name)
267
source.extend(extra_source)
268
ext_modules.append(Extension(module_name, source,
269
define_macros=define_macros, libraries=libraries))
272
add_pyrex_extension('bzrlib._annotator_pyx')
273
add_pyrex_extension('bzrlib._bencode_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_info[:3] == (0,9,4):
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
# <https://bugs.edge.launchpad.net/bzr/+bug/449372>
292
# <https://bugs.edge.launchpad.net/bzr/+bug/276868>
293
print 'Cannot build extension "bzrlib._dirstate_helpers_pyx" using'
294
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
296
print 'install. For now, the non-compiled (python) version will'
297
print 'be used instead.'
299
add_pyrex_extension('bzrlib._dirstate_helpers_pyx')
300
add_pyrex_extension('bzrlib._readdir_pyx')
302
add_pyrex_extension('bzrlib._chk_map_pyx', libraries=[z_lib])
303
ext_modules.append(Extension('bzrlib._patiencediff_c',
304
['bzrlib/_patiencediff_c.c']))
305
if have_pyrex and pyrex_version_info < (0, 9, 6, 3):
307
print 'Your Pyrex/Cython version %s is too old to build the simple_set' % (
309
print 'and static_tuple extensions.'
310
print 'Please upgrade to at least Pyrex 0.9.6.3'
312
# TODO: Should this be a fatal error?
314
# We only need 0.9.6.3 to build _simple_set_pyx, but static_tuple depends
316
add_pyrex_extension('bzrlib._simple_set_pyx')
317
ext_modules.append(Extension('bzrlib._static_tuple_c',
318
['bzrlib/_static_tuple_c.c']))
319
add_pyrex_extension('bzrlib._btree_serializer_pyx')
322
if unavailable_files:
323
print 'C extension(s) not found:'
324
print ' %s' % ('\n '.join(unavailable_files),)
325
print 'The python versions will be used instead.'
329
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
330
gui_targets, data_files):
331
packages.append('tbzrcommands')
333
# ModuleFinder can't handle runtime changes to __path__, but
334
# win32com uses them. Hook this in so win32com.shell is found.
337
import cPickle as pickle
338
for p in win32com.__path__[1:]:
339
modulefinder.AddPackagePath("win32com", p)
340
for extra in ["win32com.shell"]:
342
m = sys.modules[extra]
343
for p in m.__path__[1:]:
344
modulefinder.AddPackagePath(extra, p)
346
# TBZR points to the TBZR directory
347
tbzr_root = os.environ["TBZR"]
349
# Ensure tbzrlib itself is on sys.path
350
sys.path.append(tbzr_root)
352
packages.append("tbzrlib")
354
# collect up our icons.
356
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
357
icos = [] # list of (path_root, relative_ico_path)
358
# First always bzr's icon and its in the root of the bzr tree.
359
icos.append(('', 'bzr.ico'))
360
for root, dirs, files in os.walk(ico_root):
361
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
362
for f in files if f.endswith('.ico')])
363
# allocate an icon ID for each file and the full path to the ico
364
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
365
for rid, (ico_dir, ico_name) in enumerate(icos)]
366
# create a string resource with the mapping. Might as well save the
367
# runtime some effort and write a pickle.
368
# Runtime expects unicode objects with forward-slash seps.
369
fse = sys.getfilesystemencoding()
370
map_items = [(f.replace('\\', '/').decode(fse), rid)
371
for rid, (_, f) in enumerate(icos)]
372
ico_map = dict(map_items)
373
# Create a new resource type of 'ICON_MAP', and use ID=1
374
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
376
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
377
win32ui crawler.Crawler""".split())
379
# tbzrcache executables - a "console" version for debugging and a
380
# GUI version that is generally used.
382
script = os.path.join(tbzr_root, "scripts", "tbzrcache.py"),
383
icon_resources = icon_resources,
384
other_resources = other_resources,
386
console_targets.append(tbzrcache)
388
# Make a windows version which is the same except for the base name.
389
tbzrcachew = tbzrcache.copy()
390
tbzrcachew["dest_base"]="tbzrcachew"
391
gui_targets.append(tbzrcachew)
393
# ditto for the tbzrcommand tool
395
script = os.path.join(tbzr_root, "scripts", "tbzrcommand.py"),
396
icon_resources = [(0,'bzr.ico')],
398
console_targets.append(tbzrcommand)
399
tbzrcommandw = tbzrcommand.copy()
400
tbzrcommandw["dest_base"]="tbzrcommandw"
401
gui_targets.append(tbzrcommandw)
403
# A utility to see python output from both C++ and Python based shell
405
tracer = dict(script=os.path.join(tbzr_root, "scripts", "tbzrtrace.py"))
406
console_targets.append(tracer)
408
# The C++ implemented shell extensions.
409
dist_dir = os.path.join(tbzr_root, "shellext", "build")
410
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x86.dll')]))
411
data_files.append(('', [os.path.join(dist_dir, 'tbzrshellext_x64.dll')]))
414
def get_qbzr_py2exe_info(includes, excludes, packages, data_files):
415
# PyQt4 itself still escapes the plugin detection code for some reason...
416
packages.append('PyQt4')
417
excludes.append('PyQt4.elementtree.ElementTree')
418
excludes.append('PyQt4.uic.port_v3')
419
includes.append('sip') # extension module required for Qt.
420
packages.append('pygments') # colorizer for qbzr
421
packages.append('docutils') # html formatting
422
includes.append('win32event') # for qsubprocess stuff
423
# but we can avoid many Qt4 Dlls.
425
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
426
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
427
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
428
qscintilla2.dll""".split())
429
# the qt binaries might not be on PATH...
430
# They seem to install to a place like C:\Python25\PyQt4\*
431
# Which is not the same as C:\Python25\Lib\site-packages\PyQt4
432
pyqt_dir = os.path.join(sys.prefix, "PyQt4")
433
pyqt_bin_dir = os.path.join(pyqt_dir, "bin")
434
if os.path.isdir(pyqt_bin_dir):
435
path = os.environ.get("PATH", "")
436
if pyqt_bin_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
437
os.environ["PATH"] = path + os.pathsep + pyqt_bin_dir
438
# also add all imageformat plugins to distribution
439
# We will look in 2 places, dirname(PyQt4.__file__) and pyqt_dir
440
base_dirs_to_check = []
441
if os.path.isdir(pyqt_dir):
442
base_dirs_to_check.append(pyqt_dir)
448
pyqt4_base_dir = os.path.dirname(PyQt4.__file__)
449
if pyqt4_base_dir != pyqt_dir:
450
base_dirs_to_check.append(pyqt4_base_dir)
451
if not base_dirs_to_check:
452
log.warn("Can't find PyQt4 installation -> not including imageformat"
456
for base_dir in base_dirs_to_check:
457
plug_dir = os.path.join(base_dir, 'plugins', 'imageformats')
458
if os.path.isdir(plug_dir):
459
for fname in os.listdir(plug_dir):
460
# Include plugin dlls, but not debugging dlls
461
fullpath = os.path.join(plug_dir, fname)
462
if fname.endswith('.dll') and not fname.endswith('d4.dll'):
463
files.append(fullpath)
465
data_files.append(('imageformats', files))
467
log.warn('PyQt4 was found, but we could not find any imageformat'
468
' plugins. Are you sure your configuration is correct?')
471
def get_svn_py2exe_info(includes, excludes, packages):
472
packages.append('subvertpy')
473
packages.append('sqlite3')
476
if 'bdist_wininst' in sys.argv:
479
for root, dirs, files in os.walk('doc'):
482
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
483
or f == 'quick-start-summary.svg'):
484
r.append(os.path.join(root, f))
488
target = os.path.join('Doc\\Bazaar', relative)
490
target = 'Doc\\Bazaar'
491
docs.append((target, r))
494
# python's distutils-based win32 installer
495
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
496
'ext_modules': ext_modules,
498
'data_files': find_docs(),
499
# for building pyrex extensions
500
'cmdclass': {'build_ext': build_ext_if_possible},
503
ARGS.update(META_INFO)
505
ARGS.update(PKG_DATA)
509
elif 'py2exe' in sys.argv:
514
# pick real bzr version
518
for i in bzrlib.version_info[:4]:
523
version_number.append(str(i))
524
version_str = '.'.join(version_number)
526
# An override to install_data used only by py2exe builds, which arranges
527
# to byte-compile any .py files in data_files (eg, our plugins)
528
# Necessary as we can't rely on the user having the relevant permissions
529
# to the "Program Files" directory to generate them on the fly.
530
class install_data_with_bytecompile(install_data):
532
from distutils.util import byte_compile
534
install_data.run(self)
536
py2exe = self.distribution.get_command_obj('py2exe', False)
537
optimize = py2exe.optimize
538
compile_names = [f for f in self.outfiles if f.endswith('.py')]
539
byte_compile(compile_names,
541
force=self.force, prefix=self.install_dir,
542
dry_run=self.dry_run)
547
self.outfiles.extend([f + suffix for f in compile_names])
548
# end of class install_data_with_bytecompile
550
target = py2exe.build_exe.Target(script = "bzr",
552
icon_resources = [(0,'bzr.ico')],
553
name = META_INFO['name'],
554
version = version_str,
555
description = META_INFO['description'],
556
author = META_INFO['author'],
557
copyright = "(c) Canonical Ltd, 2005-2010",
558
company_name = "Canonical Ltd.",
559
comments = META_INFO['description'],
562
packages = BZRLIB['packages']
563
packages.remove('bzrlib')
564
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
566
for i in glob.glob('bzrlib\\*.py'):
567
module = i[:-3].replace('\\', '.')
568
if module.endswith('__init__'):
569
module = module[:-len('__init__')]
570
includes.append(module)
572
additional_packages = set()
573
if sys.version.startswith('2.4'):
574
# adding elementtree package
575
additional_packages.add('elementtree')
576
elif sys.version.startswith('2.6') or sys.version.startswith('2.5'):
577
additional_packages.add('xml.etree')
580
warnings.warn('Unknown Python version.\n'
581
'Please check setup.py script for compatibility.')
583
# Although we currently can't enforce it, we consider it an error for
584
# py2exe to report any files are "missing". Such modules we know aren't
585
# used should be listed here.
586
excludes = """Tkinter psyco ElementPath r_hmac
587
ImaginaryModule cElementTree elementtree.ElementTree
588
Crypto.PublicKey._fastmath
589
medusa medusa.filesys medusa.ftp_server
591
resource validate""".split()
594
# email package from std python library use lazy import,
595
# so we need to explicitly add all package
596
additional_packages.add('email')
597
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
598
# a result, packages like 'email.Parser' show as missing. Tell py2exe
601
for oldname in getattr(email, '_LOWERNAMES', []):
602
excludes.append("email." + oldname)
603
for oldname in getattr(email, '_MIMENAMES', []):
604
excludes.append("email.MIME" + oldname)
606
# text files for help topis
607
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
608
topics_files = [('lib/help_topics/en', text_topics)]
612
# XXX - should we consider having the concept of an 'official' build,
613
# which hard-codes the list of plugins, gets more upset if modules are
615
plugins = None # will be a set after plugin sniffing...
616
for root, dirs, files in os.walk('bzrlib/plugins'):
617
if root == 'bzrlib/plugins':
619
# We ship plugins as normal files on the file-system - however,
620
# the build process can cause *some* of these plugin files to end
621
# up in library.zip. Thus, we saw (eg) "plugins/svn/test" in
622
# library.zip, and then saw import errors related to that as the
623
# rest of the svn plugin wasn't. So we tell py2exe to leave the
624
# plugins out of the .zip file
625
excludes.extend(["bzrlib.plugins." + d for d in dirs])
628
# Throw away files we don't want packaged. Note that plugins may
629
# have data files with all sorts of extensions so we need to
630
# be conservative here about what we ditch.
631
ext = os.path.splitext(i)[1]
632
if ext.endswith('~') or ext in [".pyc", ".swp"]:
634
if i == '__init__.py' and root == 'bzrlib/plugins':
636
x.append(os.path.join(root, i))
638
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
639
plugins_files.append((target_dir, x))
640
# find modules for built-in plugins
641
import tools.package_mf
642
mf = tools.package_mf.CustomModuleFinder()
643
mf.run_package('bzrlib/plugins')
644
packs, mods = mf.get_result()
645
additional_packages.update(packs)
646
includes.extend(mods)
648
console_targets = [target,
649
'tools/win32/bzr_postinstall.py',
652
data_files = topics_files + plugins_files
654
if 'qbzr' in plugins:
655
get_qbzr_py2exe_info(includes, excludes, packages, data_files)
658
get_svn_py2exe_info(includes, excludes, packages)
660
if "TBZR" in os.environ:
661
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
662
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
663
# can be downloaded from (username=guest, blank password):
664
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays
665
# look for: version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
666
# Ditto for TORTOISE_OVERLAYS_MSI_X64, pointing at *-x64.msi.
667
for needed in ('TORTOISE_OVERLAYS_MSI_WIN32',
668
'TORTOISE_OVERLAYS_MSI_X64'):
669
url = ('http://guest:@tortoisesvn.tigris.org/svn/tortoisesvn'
671
if not os.path.isfile(os.environ.get(needed, '<nofile>')):
673
"\nPlease set %s to the location of the relevant"
674
"\nTortoiseOverlays .msi installer file."
675
" The installers can be found at"
677
"\ncheck in the version-X.Y.Z/bin/ subdir" % (needed, url))
678
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
679
gui_targets, data_files)
681
# print this warning to stderr as output is redirected, so it is seen
682
# at build time. Also to stdout so it appears in the log
683
for f in (sys.stderr, sys.stdout):
685
"Skipping TBZR binaries - please set TBZR to a directory to enable"
687
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
689
dll_excludes.extend(["MSWSOCK.dll", "MSVCP60.dll", "powrprof.dll"])
690
options_list = {"py2exe": {"packages": packages + list(additional_packages),
691
"includes": includes,
692
"excludes": excludes,
693
"dll_excludes": dll_excludes,
694
"dist_dir": "win32_bzr.exe",
699
setup(options=options_list,
700
console=console_targets,
702
zipfile='lib/library.zip',
703
data_files=data_files,
704
cmdclass={'install_data': install_data_with_bytecompile},
708
# ad-hoc for easy_install
710
if not 'bdist_egg' in sys.argv:
711
# generate and install bzr.1 only with plain install, not the
713
DATA_FILES = [('man/man1', ['bzr.1'])]
716
ARGS = {'scripts': ['bzr'],
717
'data_files': DATA_FILES,
718
'cmdclass': command_classes,
719
'ext_modules': ext_modules,
722
ARGS.update(META_INFO)
724
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
