/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: 2020-05-06 02:13:25 UTC
  • mfrom: (7490.7.21 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200506021325-awbmmqu1zyorz7sj
Merge 3.1 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/__init__.py
 
1
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
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
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
import time
 
33
 
 
34
# Keep track of when breezy was first imported, so that we can give rough
 
35
# timestamps relative to program start in the log file kept by breezy.trace.
 
36
_start_time = time.time()
 
37
 
 
38
import codecs
 
39
import sys
 
40
 
 
41
 
 
42
__copyright__ = (
 
43
    "Copyright 2005-2012 Canonical Ltd.\n"
 
44
    "Copyright 2017-2020 Breezy developers"
 
45
)
 
46
 
 
47
# same format as sys.version_info: "A tuple containing the five components of
 
48
# the version number: major, minor, micro, releaselevel, and serial. All
 
49
# values except releaselevel are integers; the release level is 'alpha',
 
50
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
 
51
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
52
# releaselevel of 'dev' for unreleased under-development code.
 
53
 
 
54
version_info = (3, 2, 0, 'dev', 0)
 
55
 
 
56
 
 
57
def _format_version_tuple(version_info):
 
58
    """Turn a version number 2, 3 or 5-tuple into a short string.
 
59
 
 
60
    This format matches <http://docs.python.org/dist/meta-data.html>
 
61
    and the typical presentation used in Python output.
 
62
 
 
63
    This also checks that the version is reasonable: the sub-release must be
 
64
    zero for final releases.
 
65
 
 
66
    >>> print(_format_version_tuple((1, 0, 0, 'final', 0)))
 
67
    1.0.0
 
68
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 0)))
 
69
    1.2.0dev
 
70
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 1)))
 
71
    1.2.0dev1
 
72
    >>> print(_format_version_tuple((1, 1, 1, 'candidate', 2)))
 
73
    1.1.1rc2
 
74
    >>> print(_format_version_tuple((2, 1, 0, 'beta', 1)))
 
75
    2.1b1
 
76
    >>> print(_format_version_tuple((1, 4, 0)))
 
77
    1.4.0
 
78
    >>> print(_format_version_tuple((1, 4)))
 
79
    1.4
 
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
    """
 
85
    if len(version_info) == 2:
 
86
        main_version = '%d.%d' % version_info[:2]
 
87
    else:
 
88
        main_version = '%d.%d.%d' % version_info[:3]
 
89
    if len(version_info) <= 3:
 
90
        return main_version
 
91
 
 
92
    release_type = version_info[3]
 
93
    sub = version_info[4]
 
94
 
 
95
    if release_type == 'final' and sub == 0:
 
96
        sub_string = ''
 
97
    elif release_type == 'final':
 
98
        sub_string = '.' + str(sub)
 
99
    elif release_type == 'dev' and sub == 0:
 
100
        sub_string = 'dev'
 
101
    elif release_type == 'dev':
 
102
        sub_string = 'dev' + str(sub)
 
103
    elif release_type in ('alpha', 'beta'):
 
104
        if version_info[2] == 0:
 
105
            main_version = '%d.%d' % version_info[:2]
 
106
        sub_string = release_type[0] + str(sub)
 
107
    elif release_type == 'candidate':
 
108
        sub_string = 'rc' + str(sub)
 
109
    else:
 
110
        return '.'.join(map(str, version_info))
 
111
 
 
112
    return main_version + sub_string
 
113
 
 
114
 
 
115
__version__ = _format_version_tuple(version_info)
 
116
version_string = __version__
 
117
 
 
118
 
 
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
    try:
 
131
        import ctypes
 
132
        old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
 
133
                                         "Py_FileSystemDefaultEncoding")
 
134
        has_enc = ctypes.c_int.in_dll(ctypes.pythonapi,
 
135
                                      "Py_HasFileSystemDefaultEncoding")
 
136
        as_utf8 = ctypes.PYFUNCTYPE(
 
137
            ctypes.POINTER(ctypes.c_char), ctypes.py_object)(
 
138
                ("PyUnicode_AsUTF8", ctypes.pythonapi))
 
139
    except (ImportError, ValueError):
 
140
        return  # No ctypes or not CPython implementation, do nothing
 
141
    new_enc = sys.intern(new_enc)
 
142
    enc_ptr = as_utf8(new_enc)
 
143
    has_enc.value = 1
 
144
    old_ptr.value = ctypes.cast(enc_ptr, ctypes.c_void_p).value
 
145
    if sys.getfilesystemencoding() != new_enc:
 
146
        raise RuntimeError("Failed to change the filesystem default encoding")
 
147
    return new_enc
 
148
 
 
149
 
 
150
# When running under the brz script, override bad filesystem default encoding.
 
151
# This is not safe to do for all users of breezy, other scripts should instead
 
152
# just ensure a usable locale is set via the $LANG variable on posix systems.
 
153
_fs_enc = sys.getfilesystemencoding()
 
154
if getattr(sys, "_brz_default_fs_enc", None) is not None:
 
155
    if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
 
156
        _fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
 
157
if _fs_enc is None:
 
158
    _fs_enc = "ascii"
 
159
else:
 
160
    _fs_enc = codecs.lookup(_fs_enc).name
 
161
 
 
162
 
 
163
# brz has various bits of global state that are slowly being eliminated.
 
164
# This variable is intended to permit any new state-like things to be attached
 
165
# to a library_state.BzrLibraryState object rather than getting new global
 
166
# variables that need to be hunted down. Accessing the current BzrLibraryState
 
167
# through this variable is not encouraged: it is better to pass it around as
 
168
# part of the context of an operation than to look it up directly, but when
 
169
# that is too hard, it is better to use this variable than to make a brand new
 
170
# global variable.
 
171
# If using this variable by looking it up (because it can't be easily obtained)
 
172
# it is important to store the reference you get, rather than looking it up
 
173
# repeatedly; that way your code will behave properly in the breezy test suite
 
174
# and from programs that do use multiple library contexts.
 
175
_global_state = None
 
176
 
 
177
 
 
178
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
 
179
    """Set up everything needed for normal use of breezy.
 
180
 
 
181
    Most applications that embed breezy, including brz itself, should call
 
182
    this function to initialize various subsystems.
 
183
 
 
184
    More options may be added in future so callers should use named arguments.
 
185
 
 
186
    The object returned by this function can be used as a contex manager
 
187
    through the 'with' statement to automatically shut down when the process
 
188
    is finished with breezy.  However it's not necessary to
 
189
    separately enter the context as well as starting brz: breezy is ready to
 
190
    go when this function returns.
 
191
 
 
192
    :param setup_ui: If true (default) use a terminal UI; otherwise
 
193
        some other ui_factory must be assigned to `breezy.ui.ui_factory` by
 
194
        the caller.
 
195
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
 
196
        otherwise use the files in `sys`.
 
197
    :return: A context manager for the use of breezy. The __exit__
 
198
        should be called by the caller before exiting their process or
 
199
        otherwise stopping use of breezy. Advanced callers can use
 
200
        BzrLibraryState directly.
 
201
    """
 
202
    from breezy import library_state, trace
 
203
    if setup_ui:
 
204
        import breezy.ui
 
205
        stdin = stdin or sys.stdin
 
206
        stdout = stdout or sys.stdout
 
207
        stderr = stderr or sys.stderr
 
208
        ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
209
    else:
 
210
        ui_factory = None
 
211
    tracer = trace.DefaultConfig()
 
212
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
 
213
    # Start automatically in case people don't realize this returns a context.
 
214
    state._start()
 
215
    return state
 
216
 
 
217
 
 
218
def get_global_state():
 
219
    if _global_state is None:
 
220
        return initialize()
 
221
    return _global_state
 
222
 
 
223
 
 
224
def test_suite():
 
225
    import tests
 
226
    return tests.test_suite()