14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
Developer documentation is available at
20
http://doc.bazaar.canonical.com/bzr.dev/developers/
22
The project website is at http://bazaar.canonical.com/
24
Some particularly interesting things in bzrlib are:
26
* bzrlib.initialize -- setup the library for use
27
* bzrlib.plugin.load_plugins -- load all installed plugins
28
* bzrlib.branch.Branch.open -- open a branch
29
* bzrlib.workingtree.WorkingTree.open -- open a working tree
31
We hope you enjoy this library.
38
23
_start_time = time.time()
26
if getattr(sys, '_bzr_lazy_regex', False):
27
# The 'bzr' executable sets _bzr_lazy_regex. We install the lazy regex
28
# hack as soon as possible so that as much of the standard library can
29
# benefit, including the 'string' module.
30
del sys._bzr_lazy_regex
31
import bzrlib.lazy_regex
32
bzrlib.lazy_regex.install_lazy_compile()
34
from bzrlib.osutils import get_user_encoding
43
37
IGNORE_FILENAME = ".bzrignore"
46
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
40
# XXX: Compatibility. This should probably be deprecated
41
user_encoding = get_user_encoding()
44
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
48
46
# same format as sys.version_info: "A tuple containing the five components of
49
47
# the version number: major, minor, micro, releaselevel, and serial. All
52
50
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
53
51
# releaselevel of 'dev' for unreleased under-development code.
55
version_info = (2, 3, 0, 'dev', 2)
53
version_info = (1, 15, 0, 'dev', 0)
57
# API compatibility version
58
api_minimum_version = (2, 2, 0)
55
# API compatibility version: bzrlib is currently API compatible with 1.13.
56
api_minimum_version = (1, 13, 0)
61
59
def _format_version_tuple(version_info):
68
66
zero for final releases.
70
68
>>> print _format_version_tuple((1, 0, 0, 'final', 0))
72
70
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
74
>>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
76
72
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
78
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
80
74
>>> print _format_version_tuple((1, 4, 0))
82
76
>>> print _format_version_tuple((1, 4))
84
>>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
85
Traceback (most recent call last):
87
ValueError: version_info (2, 1, 0, 'final', 1) not valid
88
78
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
89
79
Traceback (most recent call last):
91
81
ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
93
if len(version_info) == 2:
83
if len(version_info) == 2 or version_info[2] == 0:
94
84
main_version = '%d.%d' % version_info[:2]
96
86
main_version = '%d.%d.%d' % version_info[:3]
106
96
elif release_type == 'dev' and sub == 0:
107
97
sub_string = 'dev'
108
elif release_type == 'dev':
109
sub_string = 'dev' + str(sub)
110
98
elif release_type in ('alpha', 'beta'):
111
if version_info[2] == 0:
112
main_version = '%d.%d' % version_info[:2]
113
99
sub_string = release_type[0] + str(sub)
114
100
elif release_type == 'candidate':
115
101
sub_string = 'rc' + str(sub)
117
103
raise ValueError("version_info %r not valid" % (version_info,))
105
version_string = '%d.%d.%d.%s.%d' % tuple(version_info)
119
106
return main_version + sub_string
122
# lazy_regex import must be done after _format_version_tuple definition
123
# to avoid "no attribute '_format_version_tuple'" error when using
124
# deprecated_function in the lazy_regex module.
125
if getattr(sys, '_bzr_lazy_regex', False):
126
# The 'bzr' executable sets _bzr_lazy_regex. We install the lazy regex
127
# hack as soon as possible so that as much of the standard library can
128
# benefit, including the 'string' module.
129
del sys._bzr_lazy_regex
130
import bzrlib.lazy_regex
131
bzrlib.lazy_regex.install_lazy_compile()
134
109
__version__ = _format_version_tuple(version_info)
135
110
version_string = __version__
137
# bzr has various bits of global state that are slowly being eliminated.
138
# This variable is intended to permit any new state-like things to be attached
139
# to a library_state.BzrLibraryState object rather than getting new global
140
# variables that need to be hunted down. Accessing the current BzrLibraryState
141
# through this variable is not encouraged: it is better to pass it around as
142
# part of the context of an operation than to look it up directly, but when
143
# that is too hard, it is better to use this variable than to make a branch new
145
# If using this variable by looking it up (because it can't be easily obtained)
146
# it is important to store the reference you get, rather than looking it up
147
# repeatedly; that way your code will behave properly in the bzrlib test suite
148
# and from programs that do use multiple library contexts.
152
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
153
"""Set up everything needed for normal use of bzrlib.
155
Most applications that embed bzrlib, including bzr itself, should call
156
this function to initialize various subsystems.
158
More options may be added in future so callers should use named arguments.
160
:param setup_ui: If true (default) use a terminal UI; otherwise
161
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
163
:param stdin, stdout, stderr: If provided, use these for terminal IO;
164
otherwise use the files in `sys`.
165
:return: A context manager for the use of bzrlib. The __enter__ method of
166
this context needs to be called before it takes effect, and the __exit__
167
should be called by the caller before exiting their process or
168
otherwise stopping use of bzrlib. Advanced callers can use
169
BzrLibraryState directly.
171
from bzrlib import library_state, trace
174
stdin = stdin or sys.stdin
175
stdout = stdout or sys.stdout
176
stderr = stderr or sys.stderr
177
ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
180
tracer = trace.DefaultConfig()
181
return library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
184
113
def test_suite():