31
31
We hope you enjoy this library.
34
from __future__ import absolute_import
36
38
# Keep track of when bzrlib was first imported, so that we can give rough
37
39
# timestamps relative to program start in the log file kept by bzrlib.trace.
38
40
_start_time = time.time()
43
46
IGNORE_FILENAME = ".bzrignore"
46
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
49
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
48
51
# same format as sys.version_info: "A tuple containing the five components of
49
52
# the version number: major, minor, micro, releaselevel, and serial. All
52
55
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
53
56
# releaselevel of 'dev' for unreleased under-development code.
55
version_info = (2, 3, 0, 'dev', 2)
58
version_info = (2, 6, 0, 'dev', 3)
57
60
# API compatibility version
58
api_minimum_version = (2, 2, 0)
61
api_minimum_version = (2, 4, 0)
61
64
def _format_version_tuple(version_info):
72
75
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
74
>>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
77
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
76
79
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
78
>>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
81
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
80
83
>>> print _format_version_tuple((1, 4, 0))
82
85
>>> print _format_version_tuple((1, 4))
84
>>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
85
Traceback (most recent call last):
87
ValueError: version_info (2, 1, 0, 'final', 1) not valid
87
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
88
89
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
89
Traceback (most recent call last):
91
ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
93
92
if len(version_info) == 2:
94
93
main_version = '%d.%d' % version_info[:2]
100
99
release_type = version_info[3]
101
100
sub = version_info[4]
103
# check they're consistent
104
102
if release_type == 'final' and sub == 0:
104
elif release_type == 'final':
105
sub_string = '.' + str(sub)
106
106
elif release_type == 'dev' and sub == 0:
107
107
sub_string = 'dev'
108
108
elif release_type == 'dev':
114
114
elif release_type == 'candidate':
115
115
sub_string = 'rc' + str(sub)
117
raise ValueError("version_info %r not valid" % (version_info,))
117
return '.'.join(map(str, version_info))
119
119
return main_version + sub_string
134
134
__version__ = _format_version_tuple(version_info)
135
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)
172
_fs_enc = codecs.lookup(_fs_enc).name
137
175
# bzr has various bits of global state that are slowly being eliminated.
138
176
# This variable is intended to permit any new state-like things to be attached
139
177
# to a library_state.BzrLibraryState object rather than getting new global
140
178
# variables that need to be hunted down. Accessing the current BzrLibraryState
141
179
# through this variable is not encouraged: it is better to pass it around as
142
180
# 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
181
# that is too hard, it is better to use this variable than to make a brand new
144
182
# global variable.
145
183
# If using this variable by looking it up (because it can't be easily obtained)
146
184
# it is important to store the reference you get, rather than looking it up
158
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.
160
204
:param setup_ui: If true (default) use a terminal UI; otherwise
161
205
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
163
207
:param stdin, stdout, stderr: If provided, use these for terminal IO;
164
208
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__
209
:return: A context manager for the use of bzrlib. The __exit__
167
210
should be called by the caller before exiting their process or
168
211
otherwise stopping use of bzrlib. Advanced callers can use
169
212
BzrLibraryState directly.
added
removed
bzrlib/__init__.py
