← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-15 11:53:48 UTC
  • mto: This revision was merged to the branch mainline in revision 6375.
  • Revision ID: jelmer@samba.org-20111215115348-murs91ipn8jbw6y0
Add tests for default_email behaviour.

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
 
22
37
# timestamps relative to program start in the log file kept by bzrlib.trace.
23
38
_start_time = time.time()
24
39
 
 
40
import codecs
25
41
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
42
 
34
43
 
35
44
IGNORE_FILENAME = ".bzrignore"
36
45
 
37
46
 
38
 
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
 
47
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
39
48
 
40
49
# same format as sys.version_info: "A tuple containing the five components of
41
50
# the version number: major, minor, micro, releaselevel, and serial. All
44
53
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
45
54
# releaselevel of 'dev' for unreleased under-development code.
46
55
 
47
 
version_info = (2, 2, 0, 'dev', 1)
 
56
version_info = (2, 5, 0, 'dev', 5)
48
57
 
49
58
# API compatibility version
50
 
api_minimum_version = (2, 2, 0)
 
59
api_minimum_version = (2, 4, 0)
51
60
 
52
61
 
53
62
def _format_version_tuple(version_info):
63
72
    1.0.0
64
73
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
65
74
    1.2.0dev
66
 
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
 
75
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
67
76
    1.2.0dev1
68
77
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
69
78
    1.1.1rc2
70
 
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
 
79
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
71
80
    2.1b1
72
81
    >>> print _format_version_tuple((1, 4, 0))
73
82
    1.4.0
74
83
    >>> print _format_version_tuple((1, 4))
75
84
    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
 
85
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
 
86
    2.1.0.42
80
87
    >>> 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
 
88
    1.4.0.wibble.0
84
89
    """
85
90
    if len(version_info) == 2:
86
91
        main_version = '%d.%d' % version_info[:2]
92
97
    release_type = version_info[3]
93
98
    sub = version_info[4]
94
99
 
95
 
    # check they're consistent
96
100
    if release_type == 'final' and sub == 0:
97
101
        sub_string = ''
 
102
    elif release_type == 'final':
 
103
        sub_string = '.' + str(sub)
98
104
    elif release_type == 'dev' and sub == 0:
99
105
        sub_string = 'dev'
100
106
    elif release_type == 'dev':
106
112
    elif release_type == 'candidate':
107
113
        sub_string = 'rc' + str(sub)
108
114
    else:
109
 
        raise ValueError("version_info %r not valid" % (version_info,))
 
115
        return '.'.join(map(str, version_info))
110
116
 
111
117
    return main_version + sub_string
112
118
 
113
119
 
 
120
# lazy_regex import must be done after _format_version_tuple definition
 
121
# to avoid "no attribute '_format_version_tuple'" error when using
 
122
# deprecated_function in the lazy_regex module.
 
123
if getattr(sys, '_bzr_lazy_regex', False):
 
124
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
 
125
    # hack as soon as possible so that as much of the standard library can
 
126
    # benefit, including the 'string' module.
 
127
    del sys._bzr_lazy_regex
 
128
    import bzrlib.lazy_regex
 
129
    bzrlib.lazy_regex.install_lazy_compile()
 
130
 
 
131
 
114
132
__version__ = _format_version_tuple(version_info)
115
133
version_string = __version__
116
134
 
117
135
 
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):
 
136
def _patch_filesystem_default_encoding(new_enc):
 
137
    """Change the Python process global encoding for filesystem names
 
138
    
 
139
    The effect is to change how open() and other builtin functions handle
 
140
    unicode filenames on posix systems. This should only be done near startup.
 
141
 
 
142
    The new encoding string passed to this function must survive until process
 
143
    termination, otherwise the interpreter may access uninitialized memory.
 
144
    The use of intern() may defer breakage is but is not enough, the string
 
145
    object should be secure against module reloading and during teardown.
 
146
    """
 
147
    try:
 
148
        import ctypes
 
149
    except ImportError:
 
150
        return
 
151
    pythonapi = getattr(ctypes, "pythonapi", None)
 
152
    if pythonapi is None:
 
153
        # Not CPython ctypes implementation
 
154
        return
 
155
    old_ptr = ctypes.c_void_p.in_dll(pythonapi, "Py_FileSystemDefaultEncoding")
 
156
    new_ptr = ctypes.cast(ctypes.c_char_p(intern(new_enc)), ctypes.c_void_p)
 
157
    old_ptr.value = new_ptr.value
 
158
    if sys.getfilesystemencoding() != new_enc:
 
159
        raise RuntimeError("Failed to change the filesystem default encoding")
 
160
    return new_enc
 
161
 
 
162
 
 
163
# When running under the bzr script, override bad filesystem default encoding.
 
164
# This is not safe to do for all users of bzrlib, other scripts should instead
 
165
# just ensure a usable locale is set via the $LANG variable on posix systems.
 
166
_fs_enc = sys.getfilesystemencoding()
 
167
if getattr(sys, "_bzr_default_fs_enc", None) is not None:
 
168
    if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
 
169
        _fs_enc = _patch_filesystem_default_encoding(sys._bzr_default_fs_enc)
 
170
if _fs_enc is None:
 
171
    _fs_enc = "ascii"
 
172
else:
 
173
    _fs_enc = codecs.lookup(_fs_enc).name
 
174
 
 
175
 
 
176
# bzr has various bits of global state that are slowly being eliminated.
 
177
# This variable is intended to permit any new state-like things to be attached
 
178
# to a library_state.BzrLibraryState object rather than getting new global
 
179
# variables that need to be hunted down. Accessing the current BzrLibraryState
 
180
# through this variable is not encouraged: it is better to pass it around as
 
181
# part of the context of an operation than to look it up directly, but when
 
182
# that is too hard, it is better to use this variable than to make a brand new
 
183
# global variable.
 
184
# If using this variable by looking it up (because it can't be easily obtained)
 
185
# it is important to store the reference you get, rather than looking it up
 
186
# repeatedly; that way your code will behave properly in the bzrlib test suite
 
187
# and from programs that do use multiple library contexts.
 
188
global_state = None
 
189
 
 
190
 
 
191
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
126
192
    """Set up everything needed for normal use of bzrlib.
127
193
 
128
194
    Most applications that embed bzrlib, including bzr itself, should call
130
196
 
131
197
    More options may be added in future so callers should use named arguments.
132
198
 
 
199
    The object returned by this function can be used as a contex manager
 
200
    through the 'with' statement to automatically shut down when the process
 
201
    is finished with bzrlib.  However (from bzr 2.4) it's not necessary to
 
202
    separately enter the context as well as starting bzr: bzrlib is ready to
 
203
    go when this function returns.
 
204
 
133
205
    :param setup_ui: If true (default) use a terminal UI; otherwise 
134
 
        something else must be put into `bzrlib.ui.ui_factory`.
 
206
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
 
207
        the caller.
135
208
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
136
209
        otherwise use the files in `sys`.
 
210
    :return: A context manager for the use of bzrlib. The __exit__
 
211
        should be called by the caller before exiting their process or
 
212
        otherwise stopping use of bzrlib. Advanced callers can use
 
213
        BzrLibraryState directly.
137
214
    """
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
 
 
 
215
    from bzrlib import library_state, trace
160
216
    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)
 
217
        import bzrlib.ui
 
218
        stdin = stdin or sys.stdin
 
219
        stdout = stdout or sys.stdout
 
220
        stderr = stderr or sys.stderr
 
221
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
222
    else:
 
223
        ui_factory = None
 
224
    tracer = trace.DefaultConfig()
 
225
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
 
226
    # Start automatically in case people don't realize this returns a context.
 
227
    state._start()
 
228
    return state
 
229
 
 
230
 
 
231
def test_suite():
 
232
    import tests
 
233
    return tests.test_suite()