/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: 2019-10-28 01:38:39 UTC
  • mto: This revision was merged to the branch mainline in revision 7412.
  • Revision ID: jelmer@jelmer.uk-20191028013839-q63zzm4yr0id9b3o
Allow unknown extras in git commits when just inspecting revisions, rather than importing.

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