← 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, 2006, 2007, 2008, 2009 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
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
 
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
 
 
34
 
from bzrlib.osutils import get_user_encoding
35
41
 
36
42
 
37
43
IGNORE_FILENAME = ".bzrignore"
38
44
 
39
45
 
40
 
# XXX: Compatibility. This should probably be deprecated
41
 
user_encoding = get_user_encoding()
42
 
 
43
 
 
44
 
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
 
46
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
45
47
 
46
48
# same format as sys.version_info: "A tuple containing the five components of
47
49
# the version number: major, minor, micro, releaselevel, and serial. All
50
52
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
51
53
# releaselevel of 'dev' for unreleased under-development code.
52
54
 
53
 
version_info = (1, 13, 0, 'dev', 0)
54
 
 
55
 
 
56
 
# API compatibility version: bzrlib is currently API compatible with 1.11.
57
 
api_minimum_version = (1, 11, 0)
 
55
version_info = (2, 5, 0, 'dev', 2)
 
56
 
 
57
# API compatibility version
 
58
api_minimum_version = (2, 4, 0)
58
59
 
59
60
 
60
61
def _format_version_tuple(version_info):
61
 
    """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.
62
63
 
63
64
    This format matches <http://docs.python.org/dist/meta-data.html>
64
65
    and the typical presentation used in Python output.
67
68
    zero for final releases.
68
69
 
69
70
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
70
 
    1.0
 
71
    1.0.0
71
72
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
72
 
    1.2dev
 
73
    1.2.0dev
 
74
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
 
75
    1.2.0dev1
73
76
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
74
77
    1.1.1rc2
 
78
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
 
79
    2.1b1
75
80
    >>> print _format_version_tuple((1, 4, 0))
 
81
    1.4.0
 
82
    >>> print _format_version_tuple((1, 4))
76
83
    1.4
 
84
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
 
85
    2.1.0.42
77
86
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
78
 
    Traceback (most recent call last):
79
 
    ...
80
 
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
 
87
    1.4.0.wibble.0
81
88
    """
82
 
    if version_info[2] == 0:
 
89
    if len(version_info) == 2:
83
90
        main_version = '%d.%d' % version_info[:2]
84
91
    else:
85
92
        main_version = '%d.%d.%d' % version_info[:3]
89
96
    release_type = version_info[3]
90
97
    sub = version_info[4]
91
98
 
92
 
    # check they're consistent
93
99
    if release_type == 'final' and sub == 0:
94
100
        sub_string = ''
 
101
    elif release_type == 'final':
 
102
        sub_string = '.' + str(sub)
95
103
    elif release_type == 'dev' and sub == 0:
96
104
        sub_string = 'dev'
 
105
    elif release_type == 'dev':
 
106
        sub_string = 'dev' + str(sub)
97
107
    elif release_type in ('alpha', 'beta'):
 
108
        if version_info[2] == 0:
 
109
            main_version = '%d.%d' % version_info[:2]
98
110
        sub_string = release_type[0] + str(sub)
99
111
    elif release_type == 'candidate':
100
112
        sub_string = 'rc' + str(sub)
101
113
    else:
102
 
        raise ValueError("version_info %r not valid" % (version_info,))
 
114
        return '.'.join(map(str, version_info))
103
115
 
104
 
    version_string = '%d.%d.%d.%s.%d' % version_info
105
116
    return main_version + sub_string
106
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
 
 
130
 
107
131
__version__ = _format_version_tuple(version_info)
108
132
version_string = __version__
109
133
 
 
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
 
187
 
110
188
 
111
189
def test_suite():
112
190
    import tests