/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/__init__.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-16 23:19:12 UTC
  • mfrom: (7180 work)
  • mto: This revision was merged to the branch mainline in revision 7294.
  • Revision ID: jelmer@jelmer.uk-20181116231912-e043vpq22bdkxa6q
Merge trunk.

Show diffs side-by-side

added added

removed removed

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