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.
23
38
_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()
35
43
IGNORE_FILENAME = ".bzrignore"
44
52
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
45
53
# releaselevel of 'dev' for unreleased under-development code.
47
version_info = (2, 2, 0, 'dev', 1)
55
version_info = (2, 4, 0, 'dev', 2)
49
57
# API compatibility version
50
api_minimum_version = (2, 2, 0)
58
api_minimum_version = (2, 4, 0)
53
61
def _format_version_tuple(version_info):
64
72
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
66
>>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
74
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
68
76
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
70
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
78
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
72
80
>>> print _format_version_tuple((1, 4, 0))
74
82
>>> print _format_version_tuple((1, 4))
76
>>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
84
>>> print _format_version_tuple((2, 1, 0, 'final', 1))
77
85
Traceback (most recent call last):
79
87
ValueError: version_info (2, 1, 0, 'final', 1) not valid
111
119
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()
114
134
__version__ = _format_version_tuple(version_info)
115
135
version_string = __version__
120
return tests.test_suite()
125
stdin=None, stdout=None, stderr=None):
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):
126
153
"""Set up everything needed for normal use of bzrlib.
128
155
Most applications that embed bzrlib, including bzr itself, should call
131
158
More options may be added in future so callers should use named arguments.
160
The object returned by this function can be used as a contex manager
161
through the 'with' statement to automatically shut down when the process
162
is finished with bzrlib. However (from bzr 2.4) it's not necessary to
163
separately enter the context as well as starting bzr: bzrlib is ready to
164
go when this function returns.
133
166
:param setup_ui: If true (default) use a terminal UI; otherwise
134
something else must be put into `bzrlib.ui.ui_factory`.
167
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
135
169
:param stdin, stdout, stderr: If provided, use these for terminal IO;
136
170
otherwise use the files in `sys`.
171
:return: A context manager for the use of bzrlib. The __exit__
172
should be called by the caller before exiting their process or
173
otherwise stopping use of bzrlib. Advanced callers can use
174
BzrLibraryState directly.
138
# TODO: mention this in a guide to embedding bzrlib
140
# NB: This function tweaks so much global state it's hard to test it in
141
# isolation within the same interpreter. It's not reached on normal
142
# in-process run_bzr calls. If it's broken, we expect that
143
# TestRunBzrSubprocess may fail.
148
bzrlib.trace.enable_default_logging()
149
atexit.register(bzrlib.trace._flush_stdout_stderr)
150
atexit.register(bzrlib.trace._flush_trace)
176
from bzrlib import library_state, trace
161
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
162
stdin, stdout, stderr)
164
if bzrlib.version_info[3] == 'final':
165
from bzrlib.symbol_versioning import suppress_deprecation_warnings
166
suppress_deprecation_warnings(override=True)
168
import bzrlib.osutils
169
atexit.register(osutils.report_extension_load_failures)
179
stdin = stdin or sys.stdin
180
stdout = stdout or sys.stdout
181
stderr = stderr or sys.stderr
182
ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
185
tracer = trace.DefaultConfig()
186
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
187
# Start automatically in case people don't realize this returns a context.
194
return tests.test_suite()
added
removed
bzrlib/__init__.py
