1
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
1
# (C) 2005 Canonical Development Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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 is available at
20
https://www.breezy-vcs.org/developers/.
22
Some particularly interesting things in breezy are:
24
* breezy.initialize -- setup the library for use
25
* breezy.plugin.load_plugins -- load all installed plugins
26
* breezy.branch.Branch.open -- open a branch
27
* breezy.workingtree.WorkingTree.open -- open a working tree
29
We hope you enjoy this library.
32
from __future__ import absolute_import
36
# Keep track of when breezy was first imported, so that we can give rough
37
# timestamps relative to program start in the log file kept by breezy.trace.
38
_start_time = time.time()
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
# please keep these sorted (in C locale order) to aid merging
43
'.sw[nop]', # vim editing nameless file
77
IGNORE_FILENAME = ".bzrignore"
45
"Copyright 2005-2012 Canonical Ltd.\n"
46
"Copyright 2017-2019 Breezy developers"
49
# same format as sys.version_info: "A tuple containing the five components of
50
# the version number: major, minor, micro, releaselevel, and serial. All
51
# values except releaselevel are integers; the release level is 'alpha',
52
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
53
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
54
# releaselevel of 'dev' for unreleased under-development code.
56
version_info = (3, 1, 0, 'dev', 0)
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
__version__ = _format_version_tuple(version_info)
118
version_string = __version__
121
def _patch_filesystem_default_encoding(new_enc):
122
"""Change the Python process global encoding for filesystem names
124
The effect is to change how open() and other builtin functions handle
125
unicode filenames on posix systems. This should only be done near startup.
127
The new encoding string passed to this function must survive until process
128
termination, otherwise the interpreter may access uninitialized memory.
129
The use of intern() may defer breakage is but is not enough, the string
130
object should be secure against module reloading and during teardown.
132
is_py3 = sys.version_info > (3,)
81
if sys.platform == 'darwin':
82
# work around egregious python 2.4 bug
83
sys.platform = 'posix'
85
sys.platform = 'darwin'
88
user_encoding = locale.getpreferredencoding() or 'ascii'
91
__copyright__ = "Copyright 2005,06 Canonical Development Ltd."
92
__version__ = version_string = '0.8rc1'
93
# same format as sys.version_info
94
version_info = (0, 8, 0, 'rc', 1)
97
from bzrlib.symbol_versioning import deprecated_function, zero_seven
99
@deprecated_function(zero_seven)
100
def get_bzr_revision():
101
"""If bzr is run from a branch, return (revno,revid) or None."""
103
from bzrlib.branch import Branch
135
old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
136
"Py_FileSystemDefaultEncoding")
138
has_enc = ctypes.c_int.in_dll(ctypes.pythonapi,
139
"Py_HasFileSystemDefaultEncoding")
140
as_utf8 = ctypes.PYFUNCTYPE(
141
ctypes.POINTER(ctypes.c_char), ctypes.py_object)(
142
("PyUnicode_AsUTF8", ctypes.pythonapi))
143
except (ImportError, ValueError):
144
return # No ctypes or not CPython implementation, do nothing
146
new_enc = sys.intern(new_enc)
147
enc_ptr = as_utf8(new_enc)
150
new_enc = intern(new_enc)
151
enc_ptr = ctypes.c_char_p(new_enc)
152
old_ptr.value = ctypes.cast(enc_ptr, ctypes.c_void_p).value
153
if sys.getfilesystemencoding() != new_enc:
154
raise RuntimeError("Failed to change the filesystem default encoding")
158
# When running under the brz script, override bad filesystem default encoding.
159
# This is not safe to do for all users of breezy, other scripts should instead
160
# just ensure a usable locale is set via the $LANG variable on posix systems.
161
_fs_enc = sys.getfilesystemencoding()
162
if getattr(sys, "_brz_default_fs_enc", None) is not None:
163
if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
164
_fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
168
_fs_enc = codecs.lookup(_fs_enc).name
171
# brz has various bits of global state that are slowly being eliminated.
172
# This variable is intended to permit any new state-like things to be attached
173
# to a library_state.BzrLibraryState object rather than getting new global
174
# variables that need to be hunted down. Accessing the current BzrLibraryState
175
# through this variable is not encouraged: it is better to pass it around as
176
# part of the context of an operation than to look it up directly, but when
177
# that is too hard, it is better to use this variable than to make a brand new
179
# If using this variable by looking it up (because it can't be easily obtained)
180
# it is important to store the reference you get, rather than looking it up
181
# repeatedly; that way your code will behave properly in the breezy test suite
182
# and from programs that do use multiple library contexts.
186
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
187
"""Set up everything needed for normal use of breezy.
189
Most applications that embed breezy, including brz itself, should call
190
this function to initialize various subsystems.
192
More options may be added in future so callers should use named arguments.
194
The object returned by this function can be used as a contex manager
195
through the 'with' statement to automatically shut down when the process
196
is finished with breezy. However it's not necessary to
197
separately enter the context as well as starting brz: breezy is ready to
198
go when this function returns.
200
:param setup_ui: If true (default) use a terminal UI; otherwise
201
some other ui_factory must be assigned to `breezy.ui.ui_factory` by
203
:param stdin, stdout, stderr: If provided, use these for terminal IO;
204
otherwise use the files in `sys`.
205
:return: A context manager for the use of breezy. The __exit__
206
should be called by the caller before exiting their process or
207
otherwise stopping use of breezy. Advanced callers can use
208
BzrLibraryState directly.
210
from breezy import library_state, trace
213
stdin = stdin or sys.stdin
214
stdout = stdout or sys.stdout
215
stderr = stderr or sys.stderr
216
ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
219
tracer = trace.DefaultConfig()
220
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
221
# Start automatically in case people don't realize this returns a context.
226
def get_global_state():
227
if _global_state is None:
106
branch = Branch.open(os.path.dirname(__path__[0]))
107
rh = branch.revision_history()
109
return len(rh), rh[-1]
112
except bzrlib.errors.BzrError:
232
115
def test_suite():
234
117
return tests.test_suite()