1
# Copyright (C) 2005-2011 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
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.
36
# Keep track of when bzrlib was first imported, so that we can give rough
37
# timestamps relative to program start in the log file kept by bzrlib.trace.
38
_start_time = time.time()
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from branch import Branch, ScratchBranch, find_branch
20
from errors import BzrError
24
DEFAULT_IGNORE = ['.bzr.log',
25
'*~', '#*#', '*$', '.#*',
26
'.*.sw[nop]', '.*.tmp',
27
'*.tmp', '*.bak', '*.BAK', '*.orig',
28
'*.o', '*.obj', '*.a', '*.py[oc]', '*.so', '*.exe', '*.elc',
29
'{arch}', 'CVS', 'CVS.adm', '.svn', '_darcs', 'SCCS', 'RCS',
33
'TAGS', '.make.state', '.sconsign', '.tmp*',
43
36
IGNORE_FILENAME = ".bzrignore"
46
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
48
# same format as sys.version_info: "A tuple containing the five components of
49
# the version number: major, minor, micro, releaselevel, and serial. All
50
# values except releaselevel are integers; the release level is 'alpha',
51
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
52
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
53
# releaselevel of 'dev' for unreleased under-development code.
55
version_info = (2, 5, 0, 'dev', 5)
57
# API compatibility version
58
api_minimum_version = (2, 4, 0)
61
def _format_version_tuple(version_info):
62
"""Turn a version number 2, 3 or 5-tuple into a short string.
64
This format matches <http://docs.python.org/dist/meta-data.html>
65
and the typical presentation used in Python output.
67
This also checks that the version is reasonable: the sub-release must be
68
zero for final releases.
70
>>> print _format_version_tuple((1, 0, 0, 'final', 0))
72
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
74
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
76
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
78
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
80
>>> print _format_version_tuple((1, 4, 0))
82
>>> print _format_version_tuple((1, 4))
84
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
86
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
89
if len(version_info) == 2:
90
main_version = '%d.%d' % version_info[:2]
92
main_version = '%d.%d.%d' % version_info[:3]
93
if len(version_info) <= 3:
96
release_type = version_info[3]
99
if release_type == 'final' and sub == 0:
101
elif release_type == 'final':
102
sub_string = '.' + str(sub)
103
elif release_type == 'dev' and sub == 0:
105
elif release_type == 'dev':
106
sub_string = 'dev' + str(sub)
107
elif release_type in ('alpha', 'beta'):
108
if version_info[2] == 0:
109
main_version = '%d.%d' % version_info[:2]
110
sub_string = release_type[0] + str(sub)
111
elif release_type == 'candidate':
112
sub_string = 'rc' + str(sub)
114
return '.'.join(map(str, version_info))
116
return main_version + sub_string
119
# lazy_regex import must be done after _format_version_tuple definition
120
# to avoid "no attribute '_format_version_tuple'" error when using
121
# deprecated_function in the lazy_regex module.
122
if getattr(sys, '_bzr_lazy_regex', False):
123
# The 'bzr' executable sets _bzr_lazy_regex. We install the lazy regex
124
# hack as soon as possible so that as much of the standard library can
125
# benefit, including the 'string' module.
126
del sys._bzr_lazy_regex
127
import bzrlib.lazy_regex
128
bzrlib.lazy_regex.install_lazy_compile()
131
__version__ = _format_version_tuple(version_info)
132
version_string = __version__
134
# bzr has various bits of global state that are slowly being eliminated.
135
# This variable is intended to permit any new state-like things to be attached
136
# to a library_state.BzrLibraryState object rather than getting new global
137
# variables that need to be hunted down. Accessing the current BzrLibraryState
138
# through this variable is not encouraged: it is better to pass it around as
139
# part of the context of an operation than to look it up directly, but when
140
# that is too hard, it is better to use this variable than to make a brand new
142
# If using this variable by looking it up (because it can't be easily obtained)
143
# it is important to store the reference you get, rather than looking it up
144
# repeatedly; that way your code will behave properly in the bzrlib test suite
145
# and from programs that do use multiple library contexts.
149
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
150
"""Set up everything needed for normal use of bzrlib.
152
Most applications that embed bzrlib, including bzr itself, should call
153
this function to initialize various subsystems.
155
More options may be added in future so callers should use named arguments.
157
The object returned by this function can be used as a contex manager
158
through the 'with' statement to automatically shut down when the process
159
is finished with bzrlib. However (from bzr 2.4) it's not necessary to
160
separately enter the context as well as starting bzr: bzrlib is ready to
161
go when this function returns.
163
:param setup_ui: If true (default) use a terminal UI; otherwise
164
some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
166
:param stdin, stdout, stderr: If provided, use these for terminal IO;
167
otherwise use the files in `sys`.
168
:return: A context manager for the use of bzrlib. The __exit__
169
should be called by the caller before exiting their process or
170
otherwise stopping use of bzrlib. Advanced callers can use
171
BzrLibraryState directly.
173
from bzrlib import library_state, trace
176
stdin = stdin or sys.stdin
177
stdout = stdout or sys.stdout
178
stderr = stderr or sys.stderr
179
ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
182
tracer = trace.DefaultConfig()
183
state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
184
# Start automatically in case people don't realize this returns a context.
191
return tests.test_suite()
39
user_encoding = locale.getpreferredencoding() or 'ascii'
42
__copyright__ = "Copyright 2005 Canonical Development Ltd."
43
__author__ = "Martin Pool <mbp@canonical.com>"
47
def get_bzr_revision():
48
"""If bzr is run from a branch, return (revno,revid) or None"""
50
branch = Branch(__path__[0])
51
rh = branch.revision_history()
53
return len(rh), rh[-1]
added
removed
bzrlib/__init__.py
