1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# Copyright (C) 2005-2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""All of bzr.
Developer documentation is available at
http://doc.bazaar.canonical.com/bzr.dev/developers/
The project website is at http://bazaar.canonical.com/
Some particularly interesting things in bzrlib are:
* bzrlib.initialize -- setup the library for use
* bzrlib.plugin.load_plugins -- load all installed plugins
* bzrlib.branch.Branch.open -- open a branch
* bzrlib.workingtree.WorkingTree.open -- open a working tree
We hope you enjoy this library.
"""
import time
# Keep track of when bzrlib was first imported, so that we can give rough
# timestamps relative to program start in the log file kept by bzrlib.trace.
# XXX: GLOBAL
_start_time = time.time()
import sys
if getattr(sys, '_bzr_lazy_regex', False):
# The 'bzr' executable sets _bzr_lazy_regex. We install the lazy regex
# hack as soon as possible so that as much of the standard library can
# benefit, including the 'string' module.
del sys._bzr_lazy_regex
import bzrlib.lazy_regex
bzrlib.lazy_regex.install_lazy_compile()
IGNORE_FILENAME = ".bzrignore"
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
# same format as sys.version_info: "A tuple containing the five components of
# the version number: major, minor, micro, releaselevel, and serial. All
# values except releaselevel are integers; the release level is 'alpha',
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
# releaselevel of 'dev' for unreleased under-development code.
version_info = (2, 2, 0, 'beta', 3)
# API compatibility version
api_minimum_version = (2, 2, 0)
def _format_version_tuple(version_info):
"""Turn a version number 2, 3 or 5-tuple into a short string.
This format matches <http://docs.python.org/dist/meta-data.html>
and the typical presentation used in Python output.
This also checks that the version is reasonable: the sub-release must be
zero for final releases.
>>> print _format_version_tuple((1, 0, 0, 'final', 0))
1.0.0
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
1.2.0dev
>>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
1.2.0dev1
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
1.1.1rc2
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
2.1b1
>>> print _format_version_tuple((1, 4, 0))
1.4.0
>>> print _format_version_tuple((1, 4))
1.4
>>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
Traceback (most recent call last):
...
ValueError: version_info (2, 1, 0, 'final', 1) not valid
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
Traceback (most recent call last):
...
ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
"""
if len(version_info) == 2:
main_version = '%d.%d' % version_info[:2]
else:
main_version = '%d.%d.%d' % version_info[:3]
if len(version_info) <= 3:
return main_version
release_type = version_info[3]
sub = version_info[4]
# check they're consistent
if release_type == 'final' and sub == 0:
sub_string = ''
elif release_type == 'dev' and sub == 0:
sub_string = 'dev'
elif release_type == 'dev':
sub_string = 'dev' + str(sub)
elif release_type in ('alpha', 'beta'):
if version_info[2] == 0:
main_version = '%d.%d' % version_info[:2]
sub_string = release_type[0] + str(sub)
elif release_type == 'candidate':
sub_string = 'rc' + str(sub)
else:
raise ValueError("version_info %r not valid" % (version_info,))
return main_version + sub_string
__version__ = _format_version_tuple(version_info)
version_string = __version__
# bzr has various bits of global state that are slowly being eliminated.
# This variable is intended to permit any new state-like things to be attached
# to a library_state.BzrLibraryState object rather than getting new global
# variables that need to be hunted down. Accessing the current BzrLibraryState
# through this variable is not encouraged: it is better to pass it around as
# part of the context of an operation than to look it up directly, but when
# that is too hard, it is better to use this variable than to make a branch new
# global variable.
# If using this variable by looking it up (because it can't be easily obtained)
# it is important to store the reference you get, rather than looking it up
# repeatedly; that way your code will behave properly in the bzrlib test suite
# and from programs that do use multiple library contexts.
global_state = None
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
"""Set up everything needed for normal use of bzrlib.
Most applications that embed bzrlib, including bzr itself, should call
this function to initialize various subsystems.
More options may be added in future so callers should use named arguments.
:param setup_ui: If true (default) use a terminal UI; otherwise
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
the caller.
:param stdin, stdout, stderr: If provided, use these for terminal IO;
otherwise use the files in `sys`.
:return: A context manager for the use of bzrlib. The __enter__ method of
this context needs to be called before it takes effect, and the __exit__
should be called by the caller before exiting their process or
otherwise stopping use of bzrlib. Advanced callers can use
BzrLibraryState directly.
"""
import bzrlib.library_state
if setup_ui:
import bzrlib.ui
stdin = stdin or sys.stdin
stdout = stdout or sys.stdout
stderr = stderr or sys.stderr
ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
else:
ui_factory = None
tracer = bzrlib.trace.DefaultConfig()
return bzrlib.library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
def test_suite():
import tests
return tests.test_suite()
|