/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 bzrlib/__init__.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2013, 2016, 2017 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
17
17
"""All of bzr.
18
18
 
19
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
 
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
28
30
 
29
31
We hope you enjoy this library.
30
32
"""
31
33
 
32
 
from __future__ import absolute_import
33
 
 
34
34
import time
35
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.
 
36
# Keep track of when bzrlib was first imported, so that we can give rough
 
37
# timestamps relative to program start in the log file kept by bzrlib.trace.
38
38
_start_time = time.time()
39
39
 
40
 
import codecs
41
40
import sys
42
41
 
43
42
 
44
 
__copyright__ = (
45
 
    "Copyright 2005-2012 Canonical Ltd.\n"
46
 
    "Copyright 2017-2019 Breezy developers"
47
 
)
 
43
IGNORE_FILENAME = ".bzrignore"
 
44
 
 
45
 
 
46
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
48
47
 
49
48
# same format as sys.version_info: "A tuple containing the five components of
50
49
# the version number: major, minor, micro, releaselevel, and serial. All
53
52
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
54
53
# releaselevel of 'dev' for unreleased under-development code.
55
54
 
56
 
version_info = (3, 1, 0, 'dev', 0)
 
55
version_info = (2, 2, 0, 'beta', 3)
 
56
 
 
57
# API compatibility version
 
58
api_minimum_version = (2, 2, 0)
57
59
 
58
60
 
59
61
def _format_version_tuple(version_info):
65
67
    This also checks that the version is reasonable: the sub-release must be
66
68
    zero for final releases.
67
69
 
68
 
    >>> print(_format_version_tuple((1, 0, 0, 'final', 0)))
 
70
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
69
71
    1.0.0
70
 
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 0)))
 
72
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
71
73
    1.2.0dev
72
 
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 1)))
 
74
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
73
75
    1.2.0dev1
74
 
    >>> print(_format_version_tuple((1, 1, 1, 'candidate', 2)))
 
76
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
75
77
    1.1.1rc2
76
 
    >>> print(_format_version_tuple((2, 1, 0, 'beta', 1)))
 
78
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
77
79
    2.1b1
78
 
    >>> print(_format_version_tuple((1, 4, 0)))
 
80
    >>> print _format_version_tuple((1, 4, 0))
79
81
    1.4.0
80
 
    >>> print(_format_version_tuple((1, 4)))
 
82
    >>> print _format_version_tuple((1, 4))
81
83
    1.4
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
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
 
85
    Traceback (most recent call last):
 
86
    ...
 
87
    ValueError: version_info (2, 1, 0, 'final', 1) not valid
 
88
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
 
89
    Traceback (most recent call last):
 
90
    ...
 
91
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
86
92
    """
87
93
    if len(version_info) == 2:
88
94
        main_version = '%d.%d' % version_info[:2]
94
100
    release_type = version_info[3]
95
101
    sub = version_info[4]
96
102
 
 
103
    # check they're consistent
97
104
    if release_type == 'final' and sub == 0:
98
105
        sub_string = ''
99
 
    elif release_type == 'final':
100
 
        sub_string = '.' + str(sub)
101
106
    elif release_type == 'dev' and sub == 0:
102
107
        sub_string = 'dev'
103
108
    elif release_type == 'dev':
109
114
    elif release_type == 'candidate':
110
115
        sub_string = 'rc' + str(sub)
111
116
    else:
112
 
        return '.'.join(map(str, version_info))
 
117
        raise ValueError("version_info %r not valid" % (version_info,))
113
118
 
114
119
    return main_version + sub_string
115
120
 
116
121
 
 
122
# lazy_regex import must be done after _format_version_tuple definition
 
123
# to avoid "no attribute '_format_version_tuple'" error when using
 
124
# deprecated_function in the lazy_regex module.
 
125
if getattr(sys, '_bzr_lazy_regex', False):
 
126
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
 
127
    # hack as soon as possible so that as much of the standard library can
 
128
    # benefit, including the 'string' module.
 
129
    del sys._bzr_lazy_regex
 
130
    import bzrlib.lazy_regex
 
131
    bzrlib.lazy_regex.install_lazy_compile()
 
132
 
 
133
 
117
134
__version__ = _format_version_tuple(version_info)
118
135
version_string = __version__
119
136
 
120
 
 
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.
 
137
# bzr has various bits of global state that are slowly being eliminated.
172
138
# This variable is intended to permit any new state-like things to be attached
173
139
# to a library_state.BzrLibraryState object rather than getting new global
174
140
# variables that need to be hunted down. Accessing the current BzrLibraryState
175
141
# through this variable is not encouraged: it is better to pass it around as
176
142
# 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
 
143
# that is too hard, it is better to use this variable than to make a branch new
178
144
# global variable.
179
145
# If using this variable by looking it up (because it can't be easily obtained)
180
146
# 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
 
147
# repeatedly; that way your code will behave properly in the bzrlib test suite
182
148
# and from programs that do use multiple library contexts.
183
 
_global_state = None
 
149
global_state = None
184
150
 
185
151
 
186
152
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
187
 
    """Set up everything needed for normal use of breezy.
 
153
    """Set up everything needed for normal use of bzrlib.
188
154
 
189
 
    Most applications that embed breezy, including brz itself, should call
190
 
    this function to initialize various subsystems.
 
155
    Most applications that embed bzrlib, including bzr itself, should call
 
156
    this function to initialize various subsystems.  
191
157
 
192
158
    More options may be added in future so callers should use named arguments.
193
159
 
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
 
160
    :param setup_ui: If true (default) use a terminal UI; otherwise 
 
161
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
202
162
        the caller.
203
163
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
204
164
        otherwise use the files in `sys`.
205
 
    :return: A context manager for the use of breezy. The __exit__
 
165
    :return: A context manager for the use of bzrlib. The __enter__ method of
 
166
        this context needs to be called before it takes effect, and the __exit__
206
167
        should be called by the caller before exiting their process or
207
 
        otherwise stopping use of breezy. Advanced callers can use
 
168
        otherwise stopping use of bzrlib. Advanced callers can use
208
169
        BzrLibraryState directly.
209
170
    """
210
 
    from breezy import library_state, trace
 
171
    from bzrlib import library_state, trace
211
172
    if setup_ui:
212
 
        import breezy.ui
 
173
        import bzrlib.ui
213
174
        stdin = stdin or sys.stdin
214
175
        stdout = stdout or sys.stdout
215
176
        stderr = stderr or sys.stderr
216
 
        ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
177
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
217
178
    else:
218
179
        ui_factory = None
219
180
    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
 
181
    return library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
230
182
 
231
183
 
232
184
def test_suite():