/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
34
import time
33
35
 
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
# 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.
36
38
_start_time = time.time()
37
39
 
38
 
import codecs
39
40
import sys
40
41
 
41
42
 
42
 
__copyright__ = (
43
 
    "Copyright 2005-2012 Canonical Ltd.\n"
44
 
    "Copyright 2017-2020 Breezy developers"
45
 
)
 
43
IGNORE_FILENAME = ".bzrignore"
 
44
 
 
45
 
 
46
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
46
47
 
47
48
# same format as sys.version_info: "A tuple containing the five components of
48
49
# the version number: major, minor, micro, releaselevel, and serial. All
51
52
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
52
53
# releaselevel of 'dev' for unreleased under-development code.
53
54
 
54
 
version_info = (3, 2, 0, 'dev', 0)
 
55
version_info = (2, 2, 0, 'beta', 3)
 
56
 
 
57
# API compatibility version
 
58
api_minimum_version = (2, 2, 0)
55
59
 
56
60
 
57
61
def _format_version_tuple(version_info):
63
67
    This also checks that the version is reasonable: the sub-release must be
64
68
    zero for final releases.
65
69
 
66
 
    >>> print(_format_version_tuple((1, 0, 0, 'final', 0)))
 
70
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
67
71
    1.0.0
68
 
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 0)))
 
72
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
69
73
    1.2.0dev
70
 
    >>> print(_format_version_tuple((1, 2, 0, 'dev', 1)))
 
74
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
71
75
    1.2.0dev1
72
 
    >>> print(_format_version_tuple((1, 1, 1, 'candidate', 2)))
 
76
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
73
77
    1.1.1rc2
74
 
    >>> print(_format_version_tuple((2, 1, 0, 'beta', 1)))
 
78
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
75
79
    2.1b1
76
 
    >>> print(_format_version_tuple((1, 4, 0)))
 
80
    >>> print _format_version_tuple((1, 4, 0))
77
81
    1.4.0
78
 
    >>> print(_format_version_tuple((1, 4)))
 
82
    >>> print _format_version_tuple((1, 4))
79
83
    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
    >>> 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
84
92
    """
85
93
    if len(version_info) == 2:
86
94
        main_version = '%d.%d' % version_info[:2]
92
100
    release_type = version_info[3]
93
101
    sub = version_info[4]
94
102
 
 
103
    # check they're consistent
95
104
    if release_type == 'final' and sub == 0:
96
105
        sub_string = ''
97
 
    elif release_type == 'final':
98
 
        sub_string = '.' + str(sub)
99
106
    elif release_type == 'dev' and sub == 0:
100
107
        sub_string = 'dev'
101
108
    elif release_type == 'dev':
107
114
    elif release_type == 'candidate':
108
115
        sub_string = 'rc' + str(sub)
109
116
    else:
110
 
        return '.'.join(map(str, version_info))
 
117
        raise ValueError("version_info %r not valid" % (version_info,))
111
118
 
112
119
    return main_version + sub_string
113
120
 
114
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
 
115
134
__version__ = _format_version_tuple(version_info)
116
135
version_string = __version__
117
136
 
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
 
        pythonapi = getattr(ctypes, 'pythonapi', None)
133
 
        if pythonapi is not None:
134
 
            old_ptr = ctypes.c_void_p.in_dll(pythonapi,
135
 
                                             "Py_FileSystemDefaultEncoding")
136
 
            has_enc = ctypes.c_int.in_dll(pythonapi,
137
 
                                          "Py_HasFileSystemDefaultEncoding")
138
 
            as_utf8 = ctypes.PYFUNCTYPE(
139
 
                ctypes.POINTER(ctypes.c_char), ctypes.py_object)(
140
 
                    ("PyUnicode_AsUTF8", pythonapi))
141
 
    except (ImportError, ValueError):
142
 
        return  # No ctypes or not CPython implementation, do nothing
143
 
    new_enc = sys.intern(new_enc)
144
 
    enc_ptr = as_utf8(new_enc)
145
 
    has_enc.value = 1
146
 
    old_ptr.value = ctypes.cast(enc_ptr, ctypes.c_void_p).value
147
 
    if sys.getfilesystemencoding() != new_enc:
148
 
        raise RuntimeError("Failed to change the filesystem default encoding")
149
 
    return new_enc
150
 
 
151
 
 
152
 
# When running under the brz script, override bad filesystem default encoding.
153
 
# This is not safe to do for all users of breezy, other scripts should instead
154
 
# just ensure a usable locale is set via the $LANG variable on posix systems.
155
 
_fs_enc = sys.getfilesystemencoding()
156
 
if getattr(sys, "_brz_default_fs_enc", None) is not None:
157
 
    if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
158
 
        _fs_enc = _patch_filesystem_default_encoding(sys._brz_default_fs_enc)
159
 
if _fs_enc is None:
160
 
    _fs_enc = "ascii"
161
 
else:
162
 
    _fs_enc = codecs.lookup(_fs_enc).name
163
 
 
164
 
 
165
 
# 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.
166
138
# This variable is intended to permit any new state-like things to be attached
167
139
# to a library_state.BzrLibraryState object rather than getting new global
168
140
# variables that need to be hunted down. Accessing the current BzrLibraryState
169
141
# through this variable is not encouraged: it is better to pass it around as
170
142
# part of the context of an operation than to look it up directly, but when
171
 
# 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
172
144
# global variable.
173
145
# If using this variable by looking it up (because it can't be easily obtained)
174
146
# it is important to store the reference you get, rather than looking it up
175
 
# 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
176
148
# and from programs that do use multiple library contexts.
177
 
_global_state = None
 
149
global_state = None
178
150
 
179
151
 
180
152
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
181
 
    """Set up everything needed for normal use of breezy.
 
153
    """Set up everything needed for normal use of bzrlib.
182
154
 
183
 
    Most applications that embed breezy, including brz itself, should call
184
 
    this function to initialize various subsystems.
 
155
    Most applications that embed bzrlib, including bzr itself, should call
 
156
    this function to initialize various subsystems.  
185
157
 
186
158
    More options may be added in future so callers should use named arguments.
187
159
 
188
 
    The object returned by this function can be used as a contex manager
189
 
    through the 'with' statement to automatically shut down when the process
190
 
    is finished with breezy.  However it's not necessary to
191
 
    separately enter the context as well as starting brz: breezy is ready to
192
 
    go when this function returns.
193
 
 
194
 
    :param setup_ui: If true (default) use a terminal UI; otherwise
195
 
        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
196
162
        the caller.
197
163
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
198
164
        otherwise use the files in `sys`.
199
 
    :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__
200
167
        should be called by the caller before exiting their process or
201
 
        otherwise stopping use of breezy. Advanced callers can use
 
168
        otherwise stopping use of bzrlib. Advanced callers can use
202
169
        BzrLibraryState directly.
203
170
    """
204
 
    from breezy import library_state, trace
 
171
    from bzrlib import library_state, trace
205
172
    if setup_ui:
206
 
        import breezy.ui
 
173
        import bzrlib.ui
207
174
        stdin = stdin or sys.stdin
208
175
        stdout = stdout or sys.stdout
209
176
        stderr = stderr or sys.stderr
210
 
        ui_factory = breezy.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
177
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
211
178
    else:
212
179
        ui_factory = None
213
180
    tracer = trace.DefaultConfig()
214
 
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
215
 
    # Start automatically in case people don't realize this returns a context.
216
 
    state._start()
217
 
    return state
218
 
 
219
 
 
220
 
def get_global_state():
221
 
    if _global_state is None:
222
 
        return initialize()
223
 
    return _global_state
 
181
    return library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
224
182
 
225
183
 
226
184
def test_suite():