1
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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
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.
39
_start_time = time.time()
45
IGNORE_FILENAME = ".bzrignore"
48
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
50
# same format as sys.version_info: "A tuple containing the five components of
51
# the version number: major, minor, micro, releaselevel, and serial. All
52
# values except releaselevel are integers; the release level is 'alpha',
53
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
54
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
55
# releaselevel of 'dev' for unreleased under-development code.
57
version_info = (3, 0, 0, 'dev', 1)
59
def _format_version_tuple(version_info):
60
"""Turn a version number 2, 3 or 5-tuple into a short string.
62
This format matches <http://docs.python.org/dist/meta-data.html>
63
and the typical presentation used in Python output.
65
This also checks that the version is reasonable: the sub-release must be
66
zero for final releases.
68
>>> print _format_version_tuple((1, 0, 0, 'final', 0))
70
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
72
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
74
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
76
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
78
>>> print _format_version_tuple((1, 4, 0))
80
>>> print _format_version_tuple((1, 4))
82
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
84
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
87
if len(version_info) == 2:
88
main_version = '%d.%d' % version_info[:2]
90
main_version = '%d.%d.%d' % version_info[:3]
91
if len(version_info) <= 3:
94
release_type = version_info[3]
97
if release_type == 'final' and sub == 0:
99
elif release_type == 'final':
100
sub_string = '.' + str(sub)
101
elif release_type == 'dev' and sub == 0:
103
elif release_type == 'dev':
104
sub_string = 'dev' + str(sub)
105
elif release_type in ('alpha', 'beta'):
106
if version_info[2] == 0:
107
main_version = '%d.%d' % version_info[:2]
108
sub_string = release_type[0] + str(sub)
109
elif release_type == 'candidate':
110
sub_string = 'rc' + str(sub)
112
return '.'.join(map(str, version_info))
114
return main_version + sub_string
117
# lazy_regex import must be done after _format_version_tuple definition
118
# to avoid "no attribute '_format_version_tuple'" error when using
119
# deprecated_function in the lazy_regex module.
120
if getattr(sys, '_brz_lazy_regex', False):
121
# The 'brz' executable sets _brz_lazy_regex. We install the lazy regex
122
# hack as soon as possible so that as much of the standard library can
123
# benefit, including the 'string' module.
124
del sys._brz_lazy_regex
125
import breezy.lazy_regex
126
breezy.lazy_regex.install_lazy_compile()
129
__version__ = _format_version_tuple(version_info)
130
version_string = __version__
133
def _patch_filesystem_default_encoding(new_enc):
134
"""Change the Python process global encoding for filesystem names
136
The effect is to change how open() and other builtin functions handle
137
unicode filenames on posix systems. This should only be done near startup.
139
The new encoding string passed to this function must survive until process
140
termination, otherwise the interpreter may access uninitialized memory.
141
The use of intern() may defer breakage is but is not enough, the string
142
object should be secure against module reloading and during teardown.
144
is_py3 = sys.version_info > (3,)
147
old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
148
"Py_FileSystemDefaultEncoding")
150
has_enc = ctypes.c_int.in_dll(ctypes.pythonapi,
151
"Py_HasFileSystemDefaultEncoding")
152
as_utf8 = ctypes.PYFUNCTYPE(
153
ctypes.POINTER(ctypes.c_char), ctypes.py_object)(
154
("PyUnicode_AsUTF8", ctypes.pythonapi))
155
except (ImportError, ValueError):
156
return # No ctypes or not CPython implementation, do nothing
158
new_enc = sys.intern(new_enc)
159
enc_ptr = as_utf8(new_enc)
162
new_enc = intern(new_enc)
163
enc_ptr = ctypes.c_char_p(new_enc)
164
old_ptr.value = ctypes.cast(enc_ptr, ctypes.c_void_p).value
165
if sys.getfilesystemencoding() != new_enc:
166
raise RuntimeError("Failed to change the filesystem default encoding")
170
# When running under the brz script, override bad filesystem default encoding.
171
# This is not safe to do for all users of breezy, other scripts should instead
172
# just ensure a usable locale is set via the $LANG variable on posix systems.
173
_fs_enc = sys.getfilesystemencoding()
174
if getattr(sys, "_brz_default_fs_enc", None) is not None:
175
if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
176
_fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
180
_fs_enc = codecs.lookup(_fs_enc).name
183
# brz has various bits of global state that are slowly being eliminated.
184
# This variable is intended to permit any new state-like things to be attached
185
# to a library_state.BzrLibraryState object rather than getting new global
186
# variables that need to be hunted down. Accessing the current BzrLibraryState
187
# through this variable is not encouraged: it is better to pass it around as
188
# part of the context of an operation than to look it up directly, but when
189
# that is too hard, it is better to use this variable than to make a brand new
191
# If using this variable by looking it up (because it can't be easily obtained)
192
# it is important to store the reference you get, rather than looking it up
193
# repeatedly; that way your code will behave properly in the breezy test suite
194
# and from programs that do use multiple library contexts.
198
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
199
"""Set up everything needed for normal use of breezy.
201
Most applications that embed breezy, including brz itself, should call
202
this function to initialize various subsystems.
204
More options may be added in future so callers should use named arguments.
206
The object returned by this function can be used as a contex manager
207
through the 'with' statement to automatically shut down when the process
208
is finished with breezy. However it's not necessary to
209
separately enter the context as well as starting brz: breezy is ready to
210
go when this function returns.
212
:param setup_ui: If true (default) use a terminal UI; otherwise
213
some other ui_factory must be assigned to `breezy.ui.ui_factory` by
215
:param stdin, stdout, stderr: If provided, use these for terminal IO;
216
otherwise use the files in `sys`.
217
:return: A context manager for the use of breezy. The __exit__
218
should be called by the caller before exiting their process or
219
otherwise stopping use of breezy. Advanced callers can use
220
BzrLibraryState directly.
222
from breezy import library_state, trace
225
stdin = stdin or sys.stdin
226
stdout = stdout or sys.stdout
227
stderr = stderr or sys.stderr
228
ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
231
tracer = trace.DefaultConfig()
232
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
233
# Start automatically in case people don't realize this returns a context.
238
def get_global_state():
239
if _global_state is None:
246
return tests.test_suite()
added
removed
breezy/__init__.py
