/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-12-10 01:46:35 UTC
  • mto: This revision was merged to the branch mainline in revision 7219.
  • Revision ID: jelmer@jelmer.uk-20181210014635-oxhnf8s46u0nvp5c
Fix import

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/__init__.py
1
 
# (C) 2005 Canonical Development Ltd
2
 
 
 
1
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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"""
18
 
 
19
 
 
20
 
# please keep these sorted (in C locale order) to aid merging
21
 
DEFAULT_IGNORE = [
22
 
                  '#*#',
23
 
                  '*$',
24
 
                  '*,v',
25
 
                  '*.BAK',
26
 
                  '*.a',
27
 
                  '*.bak',
28
 
                  '*.elc',
29
 
                  '*.exe',
30
 
                  '*.la',
31
 
                  '*.lo',
32
 
                  '*.o',
33
 
                  '*.o',
34
 
                  '*.obj',
35
 
                  '*.orig',
36
 
                  '*.py[oc]',
37
 
                  '*.so',
38
 
                  '*.tmp',
39
 
                  '.*.tmp',
40
 
                  '*~',
41
 
                  '.#*',
42
 
                  '.*.sw[nop]',
43
 
                  '.sw[nop]',    # vim editing nameless file
44
 
                  '.DS_Store',
45
 
                  '.arch-ids',
46
 
                  '.arch-inventory',
47
 
                  '.bzr.log',
48
 
                  '.del-*',
49
 
                  '.git',
50
 
                  '.jamdeps'
51
 
                  '.libs',
52
 
                  '.make.state',
53
 
                  '.sconsign*',
54
 
                  '.svn',
55
 
                  '.tmp*',
56
 
                  'BitKeeper',
57
 
                  'CVS',
58
 
                  'CVS.adm',
59
 
                  'RCS',
60
 
                  'SCCS',
61
 
                  'TAGS',
62
 
                  '_darcs',
63
 
                  'aclocal.m4',
64
 
                  'autom4te*',
65
 
                  'config.h',
66
 
                  'config.h.in',
67
 
                  'config.log',
68
 
                  'config.status',
69
 
                  'config.sub',
70
 
                  'stamp-h',
71
 
                  'stamp-h.in',
72
 
                  'stamp-h1',
73
 
                  '{arch}',
74
 
                  ]
75
 
 
76
 
IGNORE_FILENAME = ".bzrignore"
77
 
 
78
 
import os
 
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
from __future__ import absolute_import
 
33
 
 
34
import time
 
35
 
 
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.
 
38
_start_time = time.time()
 
39
 
 
40
import codecs
79
41
import sys
80
 
if sys.platform == 'darwin':
81
 
    # work around egregious python 2.4 bug
82
 
    sys.platform = 'posix'
83
 
    import locale
84
 
    sys.platform = 'darwin'
 
42
 
 
43
 
 
44
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
 
45
 
 
46
# same format as sys.version_info: "A tuple containing the five components of
 
47
# the version number: major, minor, micro, releaselevel, and serial. All
 
48
# values except releaselevel are integers; the release level is 'alpha',
 
49
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
 
50
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
51
# releaselevel of 'dev' for unreleased under-development code.
 
52
 
 
53
version_info = (3, 0, 0, 'alpha', 2)
 
54
 
 
55
 
 
56
def _format_version_tuple(version_info):
 
57
    """Turn a version number 2, 3 or 5-tuple into a short string.
 
58
 
 
59
    This format matches <http://docs.python.org/dist/meta-data.html>
 
60
    and the typical presentation used in Python output.
 
61
 
 
62
    This also checks that the version is reasonable: the sub-release must be
 
63
    zero for final releases.
 
64
 
 
65
    >>> print(_format_version_tuple((1, 0, 0, 'final', 0)))
 
66
    1.0.0
 
67
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 0)))
 
68
    1.2.0dev
 
69
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 1)))
 
70
    1.2.0dev1
 
71
    >>> print(_format_version_tuple((1, 1, 1, 'candidate', 2)))
 
72
    1.1.1rc2
 
73
    >>> print(_format_version_tuple((2, 1, 0, 'beta', 1)))
 
74
    2.1b1
 
75
    >>> print(_format_version_tuple((1, 4, 0)))
 
76
    1.4.0
 
77
    >>> print(_format_version_tuple((1, 4)))
 
78
    1.4
 
79
    >>> print(_format_version_tuple((2, 1, 0, 'final', 42)))
 
80
    2.1.0.42
 
81
    >>> print(_format_version_tuple((1, 4, 0, 'wibble', 0)))
 
82
    1.4.0.wibble.0
 
83
    """
 
84
    if len(version_info) == 2:
 
85
        main_version = '%d.%d' % version_info[:2]
 
86
    else:
 
87
        main_version = '%d.%d.%d' % version_info[:3]
 
88
    if len(version_info) <= 3:
 
89
        return main_version
 
90
 
 
91
    release_type = version_info[3]
 
92
    sub = version_info[4]
 
93
 
 
94
    if release_type == 'final' and sub == 0:
 
95
        sub_string = ''
 
96
    elif release_type == 'final':
 
97
        sub_string = '.' + str(sub)
 
98
    elif release_type == 'dev' and sub == 0:
 
99
        sub_string = 'dev'
 
100
    elif release_type == 'dev':
 
101
        sub_string = 'dev' + str(sub)
 
102
    elif release_type in ('alpha', 'beta'):
 
103
        if version_info[2] == 0:
 
104
            main_version = '%d.%d' % version_info[:2]
 
105
        sub_string = release_type[0] + str(sub)
 
106
    elif release_type == 'candidate':
 
107
        sub_string = 'rc' + str(sub)
 
108
    else:
 
109
        return '.'.join(map(str, version_info))
 
110
 
 
111
    return main_version + sub_string
 
112
 
 
113
 
 
114
__version__ = _format_version_tuple(version_info)
 
115
version_string = __version__
 
116
 
 
117
 
 
118
def _patch_filesystem_default_encoding(new_enc):
 
119
    """Change the Python process global encoding for filesystem names
 
120
 
 
121
    The effect is to change how open() and other builtin functions handle
 
122
    unicode filenames on posix systems. This should only be done near startup.
 
123
 
 
124
    The new encoding string passed to this function must survive until process
 
125
    termination, otherwise the interpreter may access uninitialized memory.
 
126
    The use of intern() may defer breakage is but is not enough, the string
 
127
    object should be secure against module reloading and during teardown.
 
128
    """
 
129
    is_py3 = sys.version_info > (3,)
 
130
    try:
 
131
        import ctypes
 
132
        old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
 
133
                                         "Py_FileSystemDefaultEncoding")
 
134
        if is_py3:
 
135
            has_enc = ctypes.c_int.in_dll(ctypes.pythonapi,
 
136
                                          "Py_HasFileSystemDefaultEncoding")
 
137
            as_utf8 = ctypes.PYFUNCTYPE(
 
138
                ctypes.POINTER(ctypes.c_char), ctypes.py_object)(
 
139
                    ("PyUnicode_AsUTF8", ctypes.pythonapi))
 
140
    except (ImportError, ValueError):
 
141
        return  # No ctypes or not CPython implementation, do nothing
 
142
    if is_py3:
 
143
        new_enc = sys.intern(new_enc)
 
144
        enc_ptr = as_utf8(new_enc)
 
145
        has_enc.value = 1
 
146
    else:
 
147
        new_enc = intern(new_enc)
 
148
        enc_ptr = ctypes.c_char_p(new_enc)
 
149
    old_ptr.value = ctypes.cast(enc_ptr, ctypes.c_void_p).value
 
150
    if sys.getfilesystemencoding() != new_enc:
 
151
        raise RuntimeError("Failed to change the filesystem default encoding")
 
152
    return new_enc
 
153
 
 
154
 
 
155
# When running under the brz script, override bad filesystem default encoding.
 
156
# This is not safe to do for all users of breezy, other scripts should instead
 
157
# just ensure a usable locale is set via the $LANG variable on posix systems.
 
158
_fs_enc = sys.getfilesystemencoding()
 
159
if getattr(sys, "_brz_default_fs_enc", None) is not None:
 
160
    if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
 
161
        _fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
 
162
if _fs_enc is None:
 
163
    _fs_enc = "ascii"
85
164
else:
86
 
    import locale
87
 
user_encoding = locale.getpreferredencoding() or 'ascii'
88
 
del locale
89
 
 
90
 
__copyright__ = "Copyright 2005,06 Canonical Development Ltd."
91
 
__version__ = version_string = '0.8pre'
92
 
# same format as sys.version_info
93
 
version_info = (0, 8, 0, 'pre', 0)
94
 
 
95
 
 
96
 
from bzrlib.symbol_versioning import deprecated_function, zero_seven
97
 
 
98
 
@deprecated_function(zero_seven)
99
 
def get_bzr_revision():
100
 
    """If bzr is run from a branch, return (revno,revid) or None."""
101
 
    import bzrlib.errors
102
 
    from bzrlib.branch import Branch
103
 
    
104
 
    try:
105
 
        branch = Branch.open(os.path.dirname(__path__[0]))
106
 
        rh = branch.revision_history()
107
 
        if rh:
108
 
            return len(rh), rh[-1]
109
 
        else:
110
 
            return None
111
 
    except bzrlib.errors.BzrError:
112
 
        return None
113
 
    
 
165
    _fs_enc = codecs.lookup(_fs_enc).name
 
166
 
 
167
 
 
168
# brz has various bits of global state that are slowly being eliminated.
 
169
# This variable is intended to permit any new state-like things to be attached
 
170
# to a library_state.BzrLibraryState object rather than getting new global
 
171
# variables that need to be hunted down. Accessing the current BzrLibraryState
 
172
# through this variable is not encouraged: it is better to pass it around as
 
173
# part of the context of an operation than to look it up directly, but when
 
174
# that is too hard, it is better to use this variable than to make a brand new
 
175
# global variable.
 
176
# If using this variable by looking it up (because it can't be easily obtained)
 
177
# it is important to store the reference you get, rather than looking it up
 
178
# repeatedly; that way your code will behave properly in the breezy test suite
 
179
# and from programs that do use multiple library contexts.
 
180
_global_state = None
 
181
 
 
182
 
 
183
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
 
184
    """Set up everything needed for normal use of breezy.
 
185
 
 
186
    Most applications that embed breezy, including brz itself, should call
 
187
    this function to initialize various subsystems.
 
188
 
 
189
    More options may be added in future so callers should use named arguments.
 
190
 
 
191
    The object returned by this function can be used as a contex manager
 
192
    through the 'with' statement to automatically shut down when the process
 
193
    is finished with breezy.  However it's not necessary to
 
194
    separately enter the context as well as starting brz: breezy is ready to
 
195
    go when this function returns.
 
196
 
 
197
    :param setup_ui: If true (default) use a terminal UI; otherwise
 
198
        some other ui_factory must be assigned to `breezy.ui.ui_factory` by
 
199
        the caller.
 
200
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
 
201
        otherwise use the files in `sys`.
 
202
    :return: A context manager for the use of breezy. The __exit__
 
203
        should be called by the caller before exiting their process or
 
204
        otherwise stopping use of breezy. Advanced callers can use
 
205
        BzrLibraryState directly.
 
206
    """
 
207
    from breezy import library_state, trace
 
208
    if setup_ui:
 
209
        import breezy.ui
 
210
        stdin = stdin or sys.stdin
 
211
        stdout = stdout or sys.stdout
 
212
        stderr = stderr or sys.stderr
 
213
        ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
214
    else:
 
215
        ui_factory = None
 
216
    tracer = trace.DefaultConfig()
 
217
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
 
218
    # Start automatically in case people don't realize this returns a context.
 
219
    state._start()
 
220
    return state
 
221
 
 
222
 
 
223
def get_global_state():
 
224
    if _global_state is None:
 
225
        return initialize()
 
226
    return _global_state
 
227
 
 
228
 
114
229
def test_suite():
115
230
    import tests
116
231
    return tests.test_suite()