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 for Bazaar is available at
20
http://doc.bazaar.canonical.com/bzr.dev/developers/,
21
it should mostly also apply to Breezy.
23
Some particularly interesting things in breezy are:
25
* breezy.initialize -- setup the library for use
26
* breezy.plugin.load_plugins -- load all installed plugins
27
* breezy.branch.Branch.open -- open a branch
28
* breezy.workingtree.WorkingTree.open -- open a working tree
30
We hope you enjoy this library.
33
from __future__ import absolute_import
21
# Keep track of when bzrlib was first imported, so that we can give rough
22
# timestamps relative to program start in the log file kept by bzrlib.trace.
37
# Keep track of when breezy was first imported, so that we can give rough
38
# timestamps relative to program start in the log file kept by breezy.trace.
23
39
_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
45
IGNORE_FILENAME = ".bzrignore"
38
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
48
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
40
50
# same format as sys.version_info: "A tuple containing the five components of
41
51
# the version number: major, minor, micro, releaselevel, and serial. All
64
74
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
66
>>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
76
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
68
78
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
70
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
80
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
72
82
>>> print _format_version_tuple((1, 4, 0))
74
84
>>> print _format_version_tuple((1, 4))
76
>>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
77
Traceback (most recent call last):
79
ValueError: version_info (2, 1, 0, 'final', 1) not valid
86
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
80
88
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
81
Traceback (most recent call last):
83
ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
85
91
if len(version_info) == 2:
86
92
main_version = '%d.%d' % version_info[:2]
106
113
elif release_type == 'candidate':
107
114
sub_string = 'rc' + str(sub)
109
raise ValueError("version_info %r not valid" % (version_info,))
116
return '.'.join(map(str, version_info))
111
118
return main_version + sub_string
121
# lazy_regex import must be done after _format_version_tuple definition
122
# to avoid "no attribute '_format_version_tuple'" error when using
123
# deprecated_function in the lazy_regex module.
124
if getattr(sys, '_brz_lazy_regex', False):
125
# The 'brz' executable sets _brz_lazy_regex. We install the lazy regex
126
# hack as soon as possible so that as much of the standard library can
127
# benefit, including the 'string' module.
128
del sys._brz_lazy_regex
129
import breezy.lazy_regex
130
breezy.lazy_regex.install_lazy_compile()
114
133
__version__ = _format_version_tuple(version_info)
115
134
version_string = __version__
120
return tests.test_suite()
125
stdin=None, stdout=None, stderr=None):
126
"""Set up everything needed for normal use of bzrlib.
128
Most applications that embed bzrlib, including bzr itself, should call
129
this function to initialize various subsystems.
137
def _patch_filesystem_default_encoding(new_enc):
138
"""Change the Python process global encoding for filesystem names
140
The effect is to change how open() and other builtin functions handle
141
unicode filenames on posix systems. This should only be done near startup.
143
The new encoding string passed to this function must survive until process
144
termination, otherwise the interpreter may access uninitialized memory.
145
The use of intern() may defer breakage is but is not enough, the string
146
object should be secure against module reloading and during teardown.
150
old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
151
"Py_FileSystemDefaultEncoding")
152
except (ImportError, ValueError):
153
return # No ctypes or not CPython implementation, do nothing
154
new_ptr = ctypes.cast(ctypes.c_char_p(intern(new_enc)), ctypes.c_void_p)
155
old_ptr.value = new_ptr.value
156
if sys.getfilesystemencoding() != new_enc:
157
raise RuntimeError("Failed to change the filesystem default encoding")
161
# When running under the brz script, override bad filesystem default encoding.
162
# This is not safe to do for all users of breezy, other scripts should instead
163
# just ensure a usable locale is set via the $LANG variable on posix systems.
164
_fs_enc = sys.getfilesystemencoding()
165
if getattr(sys, "_brz_default_fs_enc", None) is not None:
166
if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
167
_fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
171
_fs_enc = codecs.lookup(_fs_enc).name
174
# brz has various bits of global state that are slowly being eliminated.
175
# This variable is intended to permit any new state-like things to be attached
176
# to a library_state.BzrLibraryState object rather than getting new global
177
# variables that need to be hunted down. Accessing the current BzrLibraryState
178
# through this variable is not encouraged: it is better to pass it around as
179
# part of the context of an operation than to look it up directly, but when
180
# that is too hard, it is better to use this variable than to make a brand new
182
# If using this variable by looking it up (because it can't be easily obtained)
183
# it is important to store the reference you get, rather than looking it up
184
# repeatedly; that way your code will behave properly in the breezy test suite
185
# and from programs that do use multiple library contexts.
189
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
190
"""Set up everything needed for normal use of breezy.
192
Most applications that embed breezy, including brz itself, should call
193
this function to initialize various subsystems.
131
195
More options may be added in future so callers should use named arguments.
133
:param setup_ui: If true (default) use a terminal UI; otherwise
134
something else must be put into `bzrlib.ui.ui_factory`.
197
The object returned by this function can be used as a contex manager
198
through the 'with' statement to automatically shut down when the process
199
is finished with breezy. However it's not necessary to
200
separately enter the context as well as starting brz: breezy is ready to
201
go when this function returns.
203
:param setup_ui: If true (default) use a terminal UI; otherwise
204
some other ui_factory must be assigned to `breezy.ui.ui_factory` by
135
206
:param stdin, stdout, stderr: If provided, use these for terminal IO;
136
207
otherwise use the files in `sys`.
208
:return: A context manager for the use of breezy. The __exit__
209
should be called by the caller before exiting their process or
210
otherwise stopping use of breezy. Advanced callers can use
211
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)
213
from breezy 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)
216
stdin = stdin or sys.stdin
217
stdout = stdout or sys.stdout
218
stderr = stderr or sys.stderr
219
ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
222
tracer = trace.DefaultConfig()
223
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
224
# Start automatically in case people don't realize this returns a context.
231
return tests.test_suite()
added
removed
breezy/__init__.py
