← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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., 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
 
"""
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""bzr library"""
33
18
 
34
19
import time
35
20
 
37
22
# timestamps relative to program start in the log file kept by bzrlib.trace.
38
23
_start_time = time.time()
39
24
 
40
 
import sys
 
25
from bzrlib.osutils import get_user_encoding
41
26
 
42
27
 
43
28
IGNORE_FILENAME = ".bzrignore"
44
29
 
45
30
 
46
 
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
 
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."
47
36
 
48
37
# same format as sys.version_info: "A tuple containing the five components of
49
38
# the version number: major, minor, micro, releaselevel, and serial. All
52
41
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
53
42
# releaselevel of 'dev' for unreleased under-development code.
54
43
 
55
 
version_info = (2, 5, 0, 'dev', 1)
56
 
 
57
 
# API compatibility version
58
 
api_minimum_version = (2, 4, 0)
 
44
version_info = (1, 8, 0, 'dev', 0)
 
45
 
 
46
 
 
47
# API compatibility version: bzrlib is currently API compatible with 1.7.
 
48
api_minimum_version = (1, 7, 0)
59
49
 
60
50
 
61
51
def _format_version_tuple(version_info):
62
 
    """Turn a version number 2, 3 or 5-tuple into a short string.
 
52
    """Turn a version number 3-tuple or 5-tuple into a short string.
63
53
 
64
54
    This format matches <http://docs.python.org/dist/meta-data.html>
65
55
    and the typical presentation used in Python output.
66
56
 
67
57
    This also checks that the version is reasonable: the sub-release must be
68
 
    zero for final releases.
 
58
    zero for final releases, and non-zero for alpha, beta and preview.
69
59
 
70
60
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
71
 
    1.0.0
 
61
    1.0
72
62
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
73
 
    1.2.0dev
74
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
75
 
    1.2.0dev1
 
63
    1.2dev
76
64
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
77
65
    1.1.1rc2
78
 
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
79
 
    2.1b1
80
66
    >>> print _format_version_tuple((1, 4, 0))
81
 
    1.4.0
82
 
    >>> print _format_version_tuple((1, 4))
83
67
    1.4
84
 
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
85
 
    2.1.0.42
86
 
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
87
 
    1.4.0.wibble.0
88
68
    """
89
 
    if len(version_info) == 2:
 
69
    if version_info[2] == 0:
90
70
        main_version = '%d.%d' % version_info[:2]
91
71
    else:
92
72
        main_version = '%d.%d.%d' % version_info[:3]
93
73
    if len(version_info) <= 3:
94
74
        return main_version
95
75
 
96
 
    release_type = version_info[3]
97
 
    sub = version_info[4]
 
76
    __release_type = version_info[3]
 
77
    __sub = version_info[4]
98
78
 
99
 
    if release_type == 'final' and sub == 0:
100
 
        sub_string = ''
101
 
    elif release_type == 'final':
102
 
        sub_string = '.' + str(sub)
103
 
    elif release_type == 'dev' and sub == 0:
104
 
        sub_string = 'dev'
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)
 
79
    # check they're consistent
 
80
    if __release_type == 'final' and __sub == 0:
 
81
        __sub_string = ''
 
82
    elif __release_type == 'dev' and __sub == 0:
 
83
        __sub_string = 'dev'
 
84
    elif __release_type in ('alpha', 'beta') and __sub != 0:
 
85
        __sub_string = __release_type[0] + str(__sub)
 
86
    elif __release_type == 'candidate' and __sub != 0:
 
87
        __sub_string = 'rc' + str(__sub)
113
88
    else:
114
 
        return '.'.join(map(str, version_info))
115
 
 
116
 
    return main_version + sub_string
117
 
 
118
 
 
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()
129
 
 
 
89
        raise AssertionError("version_info %r not valid" % version_info)
 
90
 
 
91
    version_string = '%d.%d.%d.%s.%d' % version_info
 
92
    return main_version + __sub_string
130
93
 
131
94
__version__ = _format_version_tuple(version_info)
132
95
version_string = __version__
133
96
 
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 branch new
141
 
# global variable.
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.
146
 
global_state = None
147
 
 
148
 
 
149
 
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
150
 
    """Set up everything needed for normal use of bzrlib.
151
 
 
152
 
    Most applications that embed bzrlib, including bzr itself, should call
153
 
    this function to initialize various subsystems.  
154
 
 
155
 
    More options may be added in future so callers should use named arguments.
156
 
 
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.
162
 
 
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
165
 
        the caller.
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.
172
 
    """
173
 
    from bzrlib import library_state, trace
174
 
    if setup_ui:
175
 
        import bzrlib.ui
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)
180
 
    else:
181
 
        ui_factory = None
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.
185
 
    state._start()
186
 
    return state
 
97
 
 
98
# allow bzrlib plugins to be imported.
 
99
import bzrlib.plugin
 
100
bzrlib.plugin.set_plugins_path()
187
101
 
188
102
 
189
103
def test_suite():