1
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
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.
34
from __future__ import absolute_import
38
# Keep track of when bzrlib was first imported, so that we can give rough
39
# timestamps relative to program start in the log file kept by bzrlib.trace.
40
_start_time = time.time()
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
IGNORE_FILENAME = ".bzrignore"
46
IGNORE_FILENAME = ".bzrignore"
49
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
24
if sys.platform == 'darwin':
25
# work around egregious python 2.4 bug
26
sys.platform = 'posix'
28
sys.platform = 'darwin'
31
# XXX: This probably belongs in osutils instead
32
user_encoding = locale.getpreferredencoding() or 'ascii'
35
__copyright__ = "Copyright 2005, 2006 Canonical Development Ltd."
51
37
# same format as sys.version_info: "A tuple containing the five components of
52
38
# the version number: major, minor, micro, releaselevel, and serial. All
55
41
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
56
42
# releaselevel of 'dev' for unreleased under-development code.
58
version_info = (2, 8, 0, 'dev', 1)
60
# API compatibility version
61
api_minimum_version = (2, 4, 0)
64
def _format_version_tuple(version_info):
65
"""Turn a version number 2, 3 or 5-tuple into a short string.
67
This format matches <http://docs.python.org/dist/meta-data.html>
68
and the typical presentation used in Python output.
70
This also checks that the version is reasonable: the sub-release must be
71
zero for final releases.
73
>>> print _format_version_tuple((1, 0, 0, 'final', 0))
75
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
77
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
79
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
81
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
83
>>> print _format_version_tuple((1, 4, 0))
85
>>> print _format_version_tuple((1, 4))
87
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
89
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
92
if len(version_info) == 2:
93
main_version = '%d.%d' % version_info[:2]
95
main_version = '%d.%d.%d' % version_info[:3]
96
if len(version_info) <= 3:
99
release_type = version_info[3]
100
sub = version_info[4]
102
if release_type == 'final' and sub == 0:
104
elif release_type == 'final':
105
sub_string = '.' + str(sub)
106
elif release_type == 'dev' and sub == 0:
108
elif release_type == 'dev':
109
sub_string = 'dev' + str(sub)
110
elif release_type in ('alpha', 'beta'):
111
if version_info[2] == 0:
112
main_version = '%d.%d' % version_info[:2]
113
sub_string = release_type[0] + str(sub)
114
elif release_type == 'candidate':
115
sub_string = 'rc' + str(sub)
117
return '.'.join(map(str, version_info))
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()
134
__version__ = _format_version_tuple(version_info)
135
version_string = __version__
138
def _patch_filesystem_default_encoding(new_enc):
139
"""Change the Python process global encoding for filesystem names
141
The effect is to change how open() and other builtin functions handle
142
unicode filenames on posix systems. This should only be done near startup.
144
The new encoding string passed to this function must survive until process
145
termination, otherwise the interpreter may access uninitialized memory.
146
The use of intern() may defer breakage is but is not enough, the string
147
object should be secure against module reloading and during teardown.
151
old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
152
"Py_FileSystemDefaultEncoding")
153
except (ImportError, ValueError):
154
return # No ctypes or not CPython implementation, do nothing
155
new_ptr = ctypes.cast(ctypes.c_char_p(intern(new_enc)), ctypes.c_void_p)
156
old_ptr.value = new_ptr.value
157
if sys.getfilesystemencoding() != new_enc:
158
raise RuntimeError("Failed to change the filesystem default encoding")
162
# When running under the bzr script, override bad filesystem default encoding.
163
# This is not safe to do for all users of bzrlib, other scripts should instead
164
# just ensure a usable locale is set via the $LANG variable on posix systems.
165
_fs_enc = sys.getfilesystemencoding()
166
if getattr(sys, "_bzr_default_fs_enc", None) is not None:
167
if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
168
_fs_enc = _patch_filesystem_default_encoding(sys._bzr_default_fs_enc)
44
version_info = (0, 10, 0, 'dev', 0)
46
if version_info[3] == 'final':
47
version_string = '%d.%d.%d' % version_info[:3]
172
_fs_enc = codecs.lookup(_fs_enc).name
175
# bzr has various bits of global state that are slowly being eliminated.
176
# This variable is intended to permit any new state-like things to be attached
177
# to a library_state.BzrLibraryState object rather than getting new global
178
# variables that need to be hunted down. Accessing the current BzrLibraryState
179
# through this variable is not encouraged: it is better to pass it around as
180
# part of the context of an operation than to look it up directly, but when
181
# that is too hard, it is better to use this variable than to make a brand new
183
# If using this variable by looking it up (because it can't be easily obtained)
184
# it is important to store the reference you get, rather than looking it up
185
# repeatedly; that way your code will behave properly in the bzrlib test suite
186
# and from programs that do use multiple library contexts.
190
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
191
"""Set up everything needed for normal use of bzrlib.
193
Most applications that embed bzrlib, including bzr itself, should call
194
this function to initialize various subsystems.
196
More options may be added in future so callers should use named arguments.
198
The object returned by this function can be used as a contex manager
199
through the 'with' statement to automatically shut down when the process
200
is finished with bzrlib. However (from bzr 2.4) it's not necessary to
201
separately enter the context as well as starting bzr: bzrlib is ready to
202
go when this function returns.
204
:param setup_ui: If true (default) use a terminal UI; otherwise
205
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
207
:param stdin, stdout, stderr: If provided, use these for terminal IO;
208
otherwise use the files in `sys`.
209
:return: A context manager for the use of bzrlib. The __exit__
210
should be called by the caller before exiting their process or
211
otherwise stopping use of bzrlib. Advanced callers can use
212
BzrLibraryState directly.
214
from bzrlib import library_state, trace
217
stdin = stdin or sys.stdin
218
stdout = stdout or sys.stdout
219
stderr = stderr or sys.stderr
220
ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
223
tracer = trace.DefaultConfig()
224
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
225
# Start automatically in case people don't realize this returns a context.
49
version_string = '%d.%d.%d%s%d' % version_info
50
__version__ = version_string
52
from bzrlib.symbol_versioning import (deprecated_function,
58
# Kept for compatibility with 0.8, it is considered deprecated to modify it
59
DEFAULT_IGNORE = deprecated_list(zero_nine, 'DEFAULT_IGNORE', [],
60
'Consider using bzrlib.ignores.add_unique_user_ignores'
61
' or bzrlib.ignores.add_runtime_ignores')
added
removed
bzrlib/__init__.py
