← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

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