← 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-02-17 13:49:11 UTC
  • mfrom: (4988.11.1 imports)
  • Revision ID: pqm@pqm.ubuntu.com-20100217134911-s77se00ni7xc1hz8
(Jelmer) Remove some unused imports.

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-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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
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
 
"""
 
17
"""bzr library"""
33
18
 
34
19
import time
35
20
 
38
23
_start_time = time.time()
39
24
 
40
25
import sys
 
26
if getattr(sys, '_bzr_lazy_regex', False):
 
27
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
 
28
    # hack as soon as possible so that as much of the standard library can
 
29
    # benefit, including the 'string' module.
 
30
    del sys._bzr_lazy_regex
 
31
    import bzrlib.lazy_regex
 
32
    bzrlib.lazy_regex.install_lazy_compile()
41
33
 
42
34
 
43
35
IGNORE_FILENAME = ".bzrignore"
44
36
 
45
37
 
46
 
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
 
38
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
47
39
 
48
40
# same format as sys.version_info: "A tuple containing the five components of
49
41
# the version number: major, minor, micro, releaselevel, and serial. All
52
44
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
53
45
# releaselevel of 'dev' for unreleased under-development code.
54
46
 
55
 
version_info = (2, 5, 0, 'dev', 1)
 
47
version_info = (2, 2, 0, 'dev', 1)
56
48
 
57
49
# API compatibility version
58
 
api_minimum_version = (2, 4, 0)
 
50
api_minimum_version = (2, 1, 0)
59
51
 
60
52
 
61
53
def _format_version_tuple(version_info):
71
63
    1.0.0
72
64
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
73
65
    1.2.0dev
74
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
 
66
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
75
67
    1.2.0dev1
76
68
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
77
69
    1.1.1rc2
78
 
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
79
 
    2.1b1
 
70
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
 
71
    2.1.0b1
80
72
    >>> print _format_version_tuple((1, 4, 0))
81
73
    1.4.0
82
74
    >>> print _format_version_tuple((1, 4))
83
75
    1.4
84
 
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
85
 
    2.1.0.42
 
76
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
 
77
    Traceback (most recent call last):
 
78
    ...
 
79
    ValueError: version_info (2, 1, 0, 'final', 1) not valid
86
80
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
87
 
    1.4.0.wibble.0
 
81
    Traceback (most recent call last):
 
82
    ...
 
83
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
88
84
    """
89
85
    if len(version_info) == 2:
90
86
        main_version = '%d.%d' % version_info[:2]
96
92
    release_type = version_info[3]
97
93
    sub = version_info[4]
98
94
 
 
95
    # check they're consistent
99
96
    if release_type == 'final' and sub == 0:
100
97
        sub_string = ''
101
 
    elif release_type == 'final':
102
 
        sub_string = '.' + str(sub)
103
98
    elif release_type == 'dev' and sub == 0:
104
99
        sub_string = 'dev'
105
100
    elif release_type == 'dev':
106
101
        sub_string = 'dev' + str(sub)
107
102
    elif release_type in ('alpha', 'beta'):
108
 
        if version_info[2] == 0:
109
 
            main_version = '%d.%d' % version_info[:2]
110
103
        sub_string = release_type[0] + str(sub)
111
104
    elif release_type == 'candidate':
112
105
        sub_string = 'rc' + str(sub)
113
106
    else:
114
 
        return '.'.join(map(str, version_info))
 
107
        raise ValueError("version_info %r not valid" % (version_info,))
115
108
 
116
109
    return main_version + sub_string
117
110
 
118
111
 
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
 
 
130
 
 
131
112
__version__ = _format_version_tuple(version_info)
132
113
version_string = __version__
133
114
 
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):
 
115
 
 
116
def test_suite():
 
117
    import tests
 
118
    return tests.test_suite()
 
119
 
 
120
 
 
121
def initialize(
 
122
    setup_ui=True,
 
123
    stdin=None, stdout=None, stderr=None):
150
124
    """Set up everything needed for normal use of bzrlib.
151
125
 
152
126
    Most applications that embed bzrlib, including bzr itself, should call
154
128
 
155
129
    More options may be added in future so callers should use named arguments.
156
130
 
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
131
    :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.
 
132
        something else must be put into `bzrlib.ui.ui_factory`.
166
133
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
167
134
        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
135
    """
173
 
    from bzrlib import library_state, trace
 
136
    # TODO: mention this in a guide to embedding bzrlib
 
137
    #
 
138
    # NB: This function tweaks so much global state it's hard to test it in
 
139
    # isolation within the same interpreter.  It's not reached on normal
 
140
    # in-process run_bzr calls.  If it's broken, we expect that
 
141
    # TestRunBzrSubprocess may fail.
 
142
    
 
143
    import atexit
 
144
    import bzrlib.trace
 
145
 
 
146
    bzrlib.trace.enable_default_logging()
 
147
    atexit.register(bzrlib.trace._flush_stdout_stderr)
 
148
    atexit.register(bzrlib.trace._flush_trace)
 
149
 
 
150
    import bzrlib.ui
 
151
    if stdin is None:
 
152
        stdin = sys.stdin
 
153
    if stdout is None:
 
154
        stdout = sys.stdout
 
155
    if stderr is None:
 
156
        stderr = sys.stderr
 
157
 
174
158
    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
187
 
 
188
 
 
189
 
def test_suite():
190
 
    import tests
191
 
    return tests.test_suite()
 
159
        bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
160
            stdin, stdout, stderr)
 
161
 
 
162
    if bzrlib.version_info[3] == 'final':
 
163
        from bzrlib.symbol_versioning import suppress_deprecation_warnings
 
164
        suppress_deprecation_warnings(override=True)
 
165
 
 
166
    import bzrlib.osutils
 
167
    atexit.register(osutils.report_extension_load_failures)