← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-29 22:03:03 UTC
  • mfrom: (5416.2.6 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100929220303-cr95h8iwtggco721
(mbp) Add 'break-lock --force'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
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
12
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
"""bzr library"""
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""All of bzr.
 
18
 
 
19
Developer documentation is available at
 
20
http://doc.bazaar.canonical.com/bzr.dev/developers/
 
21
 
 
22
The project website is at http://bazaar.canonical.com/
 
23
 
 
24
Some particularly interesting things in bzrlib are:
 
25
 
 
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
 
30
 
 
31
We hope you enjoy this library.
 
32
"""
18
33
 
19
34
import time
20
35
 
22
37
# timestamps relative to program start in the log file kept by bzrlib.trace.
23
38
_start_time = time.time()
24
39
 
25
 
from bzrlib.osutils import get_user_encoding
 
40
import sys
26
41
 
27
42
 
28
43
IGNORE_FILENAME = ".bzrignore"
29
44
 
30
45
 
31
 
# XXX: Compatibility. This should probably be deprecated
32
 
user_encoding = get_user_encoding()
33
 
 
34
 
 
35
 
__copyright__ = "Copyright 2005, 2006, 2007, 2008 Canonical Ltd."
 
46
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
36
47
 
37
48
# same format as sys.version_info: "A tuple containing the five components of
38
49
# the version number: major, minor, micro, releaselevel, and serial. All
41
52
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
42
53
# releaselevel of 'dev' for unreleased under-development code.
43
54
 
44
 
version_info = (1, 6, 0, 'beta', 3)
45
 
 
46
 
 
47
 
# API compatibility version: bzrlib is currently API compatible with 0.18.
48
 
api_minimum_version = (0, 18, 0)
 
55
version_info = (2, 3, 0, 'dev', 2)
 
56
 
 
57
# API compatibility version
 
58
api_minimum_version = (2, 2, 0)
 
59
 
49
60
 
50
61
def _format_version_tuple(version_info):
51
 
    """Turn a version number 3-tuple or 5-tuple into a short string.
 
62
    """Turn a version number 2, 3 or 5-tuple into a short string.
52
63
 
53
64
    This format matches <http://docs.python.org/dist/meta-data.html>
54
65
    and the typical presentation used in Python output.
55
66
 
56
67
    This also checks that the version is reasonable: the sub-release must be
57
 
    zero for final releases, and non-zero for alpha, beta and preview.
 
68
    zero for final releases.
58
69
 
59
70
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
60
 
    1.0
 
71
    1.0.0
61
72
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
62
 
    1.2dev
 
73
    1.2.0dev
 
74
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
 
75
    1.2.0dev1
63
76
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
64
77
    1.1.1rc2
 
78
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
 
79
    2.1b1
65
80
    >>> print _format_version_tuple((1, 4, 0))
 
81
    1.4.0
 
82
    >>> print _format_version_tuple((1, 4))
66
83
    1.4
 
84
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
 
85
    Traceback (most recent call last):
 
86
    ...
 
87
    ValueError: version_info (2, 1, 0, 'final', 1) not valid
 
88
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
 
89
    Traceback (most recent call last):
 
90
    ...
 
91
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
67
92
    """
68
 
    if version_info[2] == 0:
 
93
    if len(version_info) == 2:
69
94
        main_version = '%d.%d' % version_info[:2]
70
95
    else:
71
96
        main_version = '%d.%d.%d' % version_info[:3]
72
97
    if len(version_info) <= 3:
73
98
        return main_version
74
99
 
75
 
    __release_type = version_info[3]
76
 
    __sub = version_info[4]
 
100
    release_type = version_info[3]
 
101
    sub = version_info[4]
77
102
 
78
103
    # check they're consistent
79
 
    if __release_type == 'final' and __sub == 0:
80
 
        __sub_string = ''
81
 
    elif __release_type == 'dev' and __sub == 0:
82
 
        __sub_string = 'dev'
83
 
    elif __release_type in ('alpha', 'beta') and __sub != 0:
84
 
        __sub_string = __release_type[0] + str(__sub)
85
 
    elif __release_type == 'candidate' and __sub != 0:
86
 
        __sub_string = 'rc' + str(__sub)
 
104
    if release_type == 'final' and sub == 0:
 
105
        sub_string = ''
 
106
    elif release_type == 'dev' and sub == 0:
 
107
        sub_string = 'dev'
 
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)
87
116
    else:
88
 
        raise AssertionError("version_info %r not valid" % version_info)
89
 
 
90
 
    version_string = '%d.%d.%d.%s.%d' % version_info
91
 
    return main_version + __sub_string
 
117
        raise ValueError("version_info %r not valid" % (version_info,))
 
118
 
 
119
    return main_version + sub_string
 
120
 
 
121
 
 
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()
 
132
 
92
133
 
93
134
__version__ = _format_version_tuple(version_info)
94
135
version_string = __version__
95
136
 
96
 
 
97
 
# allow bzrlib plugins to be imported.
98
 
import bzrlib.plugin
99
 
bzrlib.plugin.set_plugins_path()
 
137
# bzr has various bits of global state that are slowly being eliminated.
 
138
# This variable is intended to permit any new state-like things to be attached
 
139
# to a library_state.BzrLibraryState object rather than getting new global
 
140
# variables that need to be hunted down. Accessing the current BzrLibraryState
 
141
# through this variable is not encouraged: it is better to pass it around as
 
142
# 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
 
144
# global variable.
 
145
# If using this variable by looking it up (because it can't be easily obtained)
 
146
# it is important to store the reference you get, rather than looking it up
 
147
# repeatedly; that way your code will behave properly in the bzrlib test suite
 
148
# and from programs that do use multiple library contexts.
 
149
global_state = None
 
150
 
 
151
 
 
152
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
 
153
    """Set up everything needed for normal use of bzrlib.
 
154
 
 
155
    Most applications that embed bzrlib, including bzr itself, should call
 
156
    this function to initialize various subsystems.  
 
157
 
 
158
    More options may be added in future so callers should use named arguments.
 
159
 
 
160
    :param setup_ui: If true (default) use a terminal UI; otherwise 
 
161
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
 
162
        the caller.
 
163
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
 
164
        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__
 
167
        should be called by the caller before exiting their process or
 
168
        otherwise stopping use of bzrlib. Advanced callers can use
 
169
        BzrLibraryState directly.
 
170
    """
 
171
    from bzrlib import library_state, trace
 
172
    if setup_ui:
 
173
        import bzrlib.ui
 
174
        stdin = stdin or sys.stdin
 
175
        stdout = stdout or sys.stdout
 
176
        stderr = stderr or sys.stderr
 
177
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
178
    else:
 
179
        ui_factory = None
 
180
    tracer = trace.DefaultConfig()
 
181
    return library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
100
182
 
101
183
 
102
184
def test_suite():