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()
43
35
IGNORE_FILENAME = ".bzrignore"
52
44
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
53
45
# releaselevel of 'dev' for unreleased under-development code.
55
version_info = (2, 3, 0, 'dev', 1)
47
version_info = (2, 2, 0, 'dev', 1)
57
49
# API compatibility version
58
50
api_minimum_version = (2, 2, 0)
76
68
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
78
70
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
80
72
>>> print _format_version_tuple((1, 4, 0))
82
74
>>> print _format_version_tuple((1, 4))
108
100
elif release_type == 'dev':
109
101
sub_string = 'dev' + str(sub)
110
102
elif release_type in ('alpha', 'beta'):
111
if version_info[2] == 0:
112
main_version = '%d.%d' % version_info[:2]
113
103
sub_string = release_type[0] + str(sub)
114
104
elif release_type == 'candidate':
115
105
sub_string = 'rc' + str(sub)
119
109
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
112
__version__ = _format_version_tuple(version_info)
135
113
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):
118
return tests.test_suite()
123
stdin=None, stdout=None, stderr=None):
153
124
"""Set up everything needed for normal use of bzrlib.
155
126
Most applications that embed bzrlib, including bzr itself, should call
158
129
More options may be added in future so callers should use named arguments.
160
131
: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
132
something else must be put into `bzrlib.ui.ui_factory`.
163
133
:param stdin, stdout, stderr: If provided, use these for terminal IO;
164
134
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
136
# TODO: mention this in a guide to embedding bzrlib
138
# NB: This function tweaks so much global state it's hard to test it in
139
# isolation within the same interpreter. It's not reached on normal
140
# in-process run_bzr calls. If it's broken, we expect that
141
# TestRunBzrSubprocess may fail.
146
bzrlib.trace.enable_default_logging()
147
atexit.register(bzrlib.trace._flush_stdout_stderr)
148
atexit.register(bzrlib.trace._flush_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)
186
return tests.test_suite()
159
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
160
stdin, stdout, stderr)
162
if bzrlib.version_info[3] == 'final':
163
from bzrlib.symbol_versioning import suppress_deprecation_warnings
164
suppress_deprecation_warnings(override=True)
166
import bzrlib.osutils
167
atexit.register(osutils.report_extension_load_failures)
added
removed
bzrlib/__init__.py
