~bzr-pqm/bzr/bzr.dev

6614.2.2 by Vincent Ladeuil
Release 2.7.0
1
# Copyright (C) 2005-2013, 2016 Canonical Ltd
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
2
#
1 by mbp at sourcefrog
import from baz patch-364
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.
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
7
#
1 by mbp at sourcefrog
import from baz patch-364
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.
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
12
#
1 by mbp at sourcefrog
import from baz patch-364
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1 by mbp at sourcefrog
import from baz patch-364
16
5222.2.9 by Robert Collins
Write up some doc about bzrlib.initialize.
17
"""All of bzr.
18
19
Developer documentation is available at
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
30
31
We hope you enjoy this library.
32
"""
1 by mbp at sourcefrog
import from baz patch-364
33
6379.6.7 by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear.
34
from __future__ import absolute_import
35
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
36
import time
37
38
# Keep track of when bzrlib was first imported, so that we can give rough
39
# timestamps relative to program start in the log file kept by bzrlib.trace.
40
_start_time = time.time()
41
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
42
import codecs
3224.5.29 by Andrew Bennetts
Install lazy_regex code sooner, so that it is there before the stdlib gets a chance to 'import string', which compiles regexes.
43
import sys
1 by mbp at sourcefrog
import from baz patch-364
44
3224.5.37 by Andrew Bennetts
Reinstate bzrlib.user_encoding because plugins may still use it, and we don't (yet) have a good way to mark it as deprecated.
45
5 by mbp at sourcefrog
.bzrignore support
46
IGNORE_FILENAME = ".bzrignore"
47
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
48
6437.1.1 by Vincent Ladeuil
Open trunk as 2.6dev1
49
__copyright__ = "Copyright 2005-2012 Canonical Ltd."
1702.1.2 by Martin Pool
Prepare for 0.8 release
50
1704.2.8 by Martin Pool
Bump version to 0.9.0
51
# same format as sys.version_info: "A tuple containing the five components of
1702.1.2 by Martin Pool
Prepare for 0.8 release
52
# the version number: major, minor, micro, releaselevel, and serial. All
53
# values except releaselevel are integers; the release level is 'alpha',
54
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
1704.2.8 by Martin Pool
Bump version to 0.9.0
55
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
56
# releaselevel of 'dev' for unreleased under-development code.
57
6614.2.2 by Vincent Ladeuil
Release 2.7.0
58
version_info = (2, 7, 0, 'final', 0)
1704.2.8 by Martin Pool
Bump version to 0.9.0
59
5036.1.1 by Martin Pool
merge 2.1 back to trunk
60
# API compatibility version
5609.3.2 by Vincent Ladeuil
Open trunk as 2.4dev1, bumping api_minimum_version to 2.4.0.
61
api_minimum_version = (2, 4, 0)
2550.2.2 by Robert Collins
Add helpers to get api versions from objects.
62
4574.3.1 by Martin Pool
Give a warning when failing to load _chunks_to_lines_pyx
63
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
64
def _format_version_tuple(version_info):
4098.2.1 by Robert Collins
Allow self documenting hooks.
65
    """Turn a version number 2, 3 or 5-tuple into a short string.
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
66
67
    This format matches <http://docs.python.org/dist/meta-data.html>
68
    and the typical presentation used in Python output.
69
70
    This also checks that the version is reasonable: the sub-release must be
3847.1.1 by Matt Nordhoff
Let _format_version_tuple accept alphas/betas/rcs with a subrelease of 0.
71
    zero for final releases.
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
72
3185.1.13 by Martin Pool
Fix doctest syntax
73
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
4634.50.2 by John Arbash Meinel
Fix the tests.
74
    1.0.0
3185.1.13 by Martin Pool
Fix doctest syntax
75
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
4634.50.2 by John Arbash Meinel
Fix the tests.
76
    1.2.0dev
5485.3.1 by Martin
Don't rely on bzrlib importing itself in _format_version_tuple doctest
77
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
4634.50.2 by John Arbash Meinel
Fix the tests.
78
    1.2.0dev1
3185.1.13 by Martin Pool
Fix doctest syntax
79
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
80
    1.1.1rc2
5485.3.1 by Martin
Don't rely on bzrlib importing itself in _format_version_tuple doctest
81
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
5160.1.1 by Martin Pool
Show beta versions as 2.2b1
82
    2.1b1
3388.1.1 by Martin Pool
_format_version_tuple can take a 3-tuple
83
    >>> print _format_version_tuple((1, 4, 0))
4634.50.2 by John Arbash Meinel
Fix the tests.
84
    1.4.0
4098.2.1 by Robert Collins
Allow self documenting hooks.
85
    >>> print _format_version_tuple((1, 4))
86
    1.4
5851.2.1 by Martin Pool
_format_version_tuple tolerates more different tuples
87
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
88
    2.1.0.42
3726.1.1 by Martin Pool
Correct exception expression in _format_version_tuple (Mark Hammond)
89
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
5851.2.1 by Martin Pool
_format_version_tuple tolerates more different tuples
90
    1.4.0.wibble.0
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
91
    """
4634.50.1 by John Arbash Meinel
Change 'bzr --version' to always give the major.minor.micro version
92
    if len(version_info) == 2:
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
93
        main_version = '%d.%d' % version_info[:2]
94
    else:
95
        main_version = '%d.%d.%d' % version_info[:3]
3388.1.1 by Martin Pool
_format_version_tuple can take a 3-tuple
96
    if len(version_info) <= 3:
97
        return main_version
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
98
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
99
    release_type = version_info[3]
100
    sub = version_info[4]
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
101
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
102
    if release_type == 'final' and sub == 0:
103
        sub_string = ''
5851.2.1 by Martin Pool
_format_version_tuple tolerates more different tuples
104
    elif release_type == 'final':
105
        sub_string = '.' + str(sub)
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
106
    elif release_type == 'dev' and sub == 0:
107
        sub_string = 'dev'
4634.50.2 by John Arbash Meinel
Fix the tests.
108
    elif release_type == 'dev':
109
        sub_string = 'dev' + str(sub)
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
110
    elif release_type in ('alpha', 'beta'):
5160.1.1 by Martin Pool
Show beta versions as 2.2b1
111
        if version_info[2] == 0:
112
            main_version = '%d.%d' % version_info[:2]
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
113
        sub_string = release_type[0] + str(sub)
114
    elif release_type == 'candidate':
115
        sub_string = 'rc' + str(sub)
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
116
    else:
5851.2.1 by Martin Pool
_format_version_tuple tolerates more different tuples
117
        return '.'.join(map(str, version_info))
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
118
3849.2.1 by John Arbash Meinel
Cleanup variable names inside a function.
119
    return main_version + sub_string
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
120
4122.1.1 by Martin Pool
Merge back 1.13 and bump version to 1.14dev
121
5327.1.1 by Parth Malwankar
fixed import order of lazy_regex w.r.t _format_version_tuple definition in bzrlib
122
# lazy_regex import must be done after _format_version_tuple definition
5327.1.2 by Parth Malwankar
fixed comment
123
# to avoid "no attribute '_format_version_tuple'" error when using
124
# deprecated_function in the lazy_regex module.
5327.1.1 by Parth Malwankar
fixed import order of lazy_regex w.r.t _format_version_tuple definition in bzrlib
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
3185.1.9 by Martin Pool
Show short version in a more terse form, like "1.2dev"
134
__version__ = _format_version_tuple(version_info)
3185.1.12 by Martin Pool
Restore bzrlib.version_string variable
135
version_string = __version__
3185.1.5 by Martin Pool
Use a shorter version number, and check that it makes sense.
136
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
137
138
def _patch_filesystem_default_encoding(new_enc):
139
    """Change the Python process global encoding for filesystem names
140
    
6352.3.5 by Martin Packman
Add to docstring as suggested by vila in review
141
    The effect is to change how open() and other builtin functions handle
142
    unicode filenames on posix systems. This should only be done near startup.
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
143
144
    The new encoding string passed to this function must survive until process
145
    termination, otherwise the interpreter may access uninitialized memory.
146
    The use of intern() may defer breakage is but is not enough, the string
147
    object should be secure against module reloading and during teardown.
148
    """
149
    try:
150
        import ctypes
6437.13.1 by Martin Packman
Catch ValueError from ctypes to detect lack of CPython api for filesystemencoding patch
151
        old_ptr = ctypes.c_void_p.in_dll(ctypes.pythonapi,
152
            "Py_FileSystemDefaultEncoding")
153
    except (ImportError, ValueError):
154
        return # No ctypes or not CPython implementation, do nothing
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
155
    new_ptr = ctypes.cast(ctypes.c_char_p(intern(new_enc)), ctypes.c_void_p)
156
    old_ptr.value = new_ptr.value
6352.3.4 by Martin Packman
Minor tweaks including normalising _fs_enc value
157
    if sys.getfilesystemencoding() != new_enc:
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
158
        raise RuntimeError("Failed to change the filesystem default encoding")
159
    return new_enc
160
161
162
# When running under the bzr script, override bad filesystem default encoding.
163
# This is not safe to do for all users of bzrlib, other scripts should instead
164
# just ensure a usable locale is set via the $LANG variable on posix systems.
165
_fs_enc = sys.getfilesystemencoding()
6352.3.8 by Martin Packman
Fix getattr error caught by PQM testing
166
if getattr(sys, "_bzr_default_fs_enc", None) is not None:
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
167
    if (_fs_enc is None or codecs.lookup(_fs_enc).name == "ascii"):
168
        _fs_enc = _patch_filesystem_default_encoding(sys._bzr_default_fs_enc)
169
if _fs_enc is None:
170
    _fs_enc = "ascii"
6352.3.4 by Martin Packman
Minor tweaks including normalising _fs_enc value
171
else:
172
    _fs_enc = codecs.lookup(_fs_enc).name
6352.3.2 by Martin Packman
Add mechanism for changing Py_FileSystemDefaultEncoding with ctypes
173
174
5222.2.8 by Robert Collins
Store the library state as a global variable so that code with no other way of finding the BzrLibraryState can access it.
175
# bzr has various bits of global state that are slowly being eliminated.
176
# This variable is intended to permit any new state-like things to be attached
5320.2.2 by Robert Collins
Move BzrLibraryState to its own module and prepare to start testing it.
177
# to a library_state.BzrLibraryState object rather than getting new global
178
# variables that need to be hunted down. Accessing the current BzrLibraryState
179
# through this variable is not encouraged: it is better to pass it around as
180
# part of the context of an operation than to look it up directly, but when
6161.1.1 by Vincent Ladeuil
Allow config options to be overridden from the command line
181
# that is too hard, it is better to use this variable than to make a brand new
5320.2.2 by Robert Collins
Move BzrLibraryState to its own module and prepare to start testing it.
182
# global variable.
5222.2.10 by Robert Collins
More NEWS about the bzrlib.initialize contract change, and typographical error fixes for __init__.py.
183
# If using this variable by looking it up (because it can't be easily obtained)
5222.2.8 by Robert Collins
Store the library state as a global variable so that code with no other way of finding the BzrLibraryState can access it.
184
# it is important to store the reference you get, rather than looking it up
185
# repeatedly; that way your code will behave properly in the bzrlib test suite
186
# and from programs that do use multiple library contexts.
187
global_state = None
5017.1.1 by Martin Pool
Add bzrlib.initialize
188
189
5222.2.4 by Robert Collins
Rather than adding another global thing, use a context manager to represent all the global state.
190
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
5017.1.1 by Martin Pool
Add bzrlib.initialize
191
    """Set up everything needed for normal use of bzrlib.
192
193
    Most applications that embed bzrlib, including bzr itself, should call
194
    this function to initialize various subsystems.  
195
196
    More options may be added in future so callers should use named arguments.
197
5728.4.1 by Martin Pool
bzrlib.initialize now does what you'd expect
198
    The object returned by this function can be used as a contex manager
199
    through the 'with' statement to automatically shut down when the process
200
    is finished with bzrlib.  However (from bzr 2.4) it's not necessary to
201
    separately enter the context as well as starting bzr: bzrlib is ready to
202
    go when this function returns.
203
5017.1.1 by Martin Pool
Add bzrlib.initialize
204
    :param setup_ui: If true (default) use a terminal UI; otherwise 
5222.2.4 by Robert Collins
Rather than adding another global thing, use a context manager to represent all the global state.
205
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
206
        the caller.
5017.1.1 by Martin Pool
Add bzrlib.initialize
207
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
208
        otherwise use the files in `sys`.
5728.4.1 by Martin Pool
bzrlib.initialize now does what you'd expect
209
    :return: A context manager for the use of bzrlib. The __exit__
5222.2.9 by Robert Collins
Write up some doc about bzrlib.initialize.
210
        should be called by the caller before exiting their process or
211
        otherwise stopping use of bzrlib. Advanced callers can use
212
        BzrLibraryState directly.
5017.1.1 by Martin Pool
Add bzrlib.initialize
213
    """
5327.2.4 by Parth Malwankar
single import line for library_state and trace
214
    from bzrlib import library_state, trace
5320.2.3 by Robert Collins
Restore the original ui_factory when existing BzrLibraryState.
215
    if setup_ui:
216
        import bzrlib.ui
217
        stdin = stdin or sys.stdin
218
        stdout = stdout or sys.stdout
219
        stderr = stderr or sys.stderr
220
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
221
    else:
222
        ui_factory = None
5327.2.3 by Parth Malwankar
updated te import style for bzrlib.trace
223
    tracer = trace.DefaultConfig()
5728.4.1 by Martin Pool
bzrlib.initialize now does what you'd expect
224
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
225
    # Start automatically in case people don't realize this returns a context.
226
    state._start()
227
    return state
5222.2.8 by Robert Collins
Store the library state as a global variable so that code with no other way of finding the BzrLibraryState can access it.
228
229
230
def test_suite():
231
    import tests
232
    return tests.test_suite()