← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-10-10 07:09:12 UTC
  • mfrom: (2063.4.5 lazy_regex)
  • Revision ID: pqm@pqm.ubuntu.com-20061010070912-10e1b070dacb4c40
(John Arbash Meinel) bzrlib.lazy_regex.lazy_compile creates regex objects that are compiled on demand

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Development 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
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
 
"""
33
 
 
34
 
import time
35
 
 
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
 
_start_time = time.time()
39
 
 
40
 
import sys
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""bzr library"""
 
18
 
 
19
from bzrlib.osutils import get_user_encoding
41
20
 
42
21
 
43
22
IGNORE_FILENAME = ".bzrignore"
44
23
 
45
24
 
46
 
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
 
25
# XXX: Compatibility. This should probably be deprecated
 
26
user_encoding = get_user_encoding()
 
27
 
 
28
 
 
29
__copyright__ = "Copyright 2005, 2006 Canonical Development Ltd."
47
30
 
48
31
# same format as sys.version_info: "A tuple containing the five components of
49
32
# the version number: major, minor, micro, releaselevel, and serial. All
52
35
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
53
36
# releaselevel of 'dev' for unreleased under-development code.
54
37
 
55
 
version_info = (2, 2, 0, 'beta', 4)
56
 
 
57
 
# API compatibility version
58
 
api_minimum_version = (2, 2, 0)
59
 
 
60
 
 
61
 
def _format_version_tuple(version_info):
62
 
    """Turn a version number 2, 3 or 5-tuple into a short string.
63
 
 
64
 
    This format matches <http://docs.python.org/dist/meta-data.html>
65
 
    and the typical presentation used in Python output.
66
 
 
67
 
    This also checks that the version is reasonable: the sub-release must be
68
 
    zero for final releases.
69
 
 
70
 
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
71
 
    1.0.0
72
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
73
 
    1.2.0dev
74
 
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
75
 
    1.2.0dev1
76
 
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
77
 
    1.1.1rc2
78
 
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
79
 
    2.1b1
80
 
    >>> print _format_version_tuple((1, 4, 0))
81
 
    1.4.0
82
 
    >>> print _format_version_tuple((1, 4))
83
 
    1.4
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
92
 
    """
93
 
    if len(version_info) == 2:
94
 
        main_version = '%d.%d' % version_info[:2]
95
 
    else:
96
 
        main_version = '%d.%d.%d' % version_info[:3]
97
 
    if len(version_info) <= 3:
98
 
        return main_version
99
 
 
100
 
    release_type = version_info[3]
101
 
    sub = version_info[4]
102
 
 
103
 
    # check they're consistent
104
 
    if release_type == 'final' and sub == 0:
105
 
        sub_string = ''
106
 
    elif release_type == 'dev' and sub == 0:
107
 
        sub_string = 'dev'
108
 
    elif release_type == 'dev':
109
 
        sub_string = 'dev' + str(sub)
110
 
    elif release_type in ('alpha', 'beta'):
111
 
        if version_info[2] == 0:
112
 
            main_version = '%d.%d' % version_info[:2]
113
 
        sub_string = release_type[0] + str(sub)
114
 
    elif release_type == 'candidate':
115
 
        sub_string = 'rc' + str(sub)
116
 
    else:
117
 
        raise ValueError("version_info %r not valid" % (version_info,))
118
 
 
119
 
    return main_version + sub_string
120
 
 
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
 
 
134
 
__version__ = _format_version_tuple(version_info)
135
 
version_string = __version__
136
 
 
137
 
# bzr has various bits of global state that are slowly being eliminated.
138
 
# This variable is intended to permit any new state-like things to be attached
139
 
# to a library_state.BzrLibraryState object rather than getting new global
140
 
# variables that need to be hunted down. Accessing the current BzrLibraryState
141
 
# through this variable is not encouraged: it is better to pass it around as
142
 
# part of the context of an operation than to look it up directly, but when
143
 
# that is too hard, it is better to use this variable than to make a branch new
144
 
# global variable.
145
 
# If using this variable by looking it up (because it can't be easily obtained)
146
 
# it is important to store the reference you get, rather than looking it up
147
 
# repeatedly; that way your code will behave properly in the bzrlib test suite
148
 
# and from programs that do use multiple library contexts.
149
 
global_state = None
150
 
 
151
 
 
152
 
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
153
 
    """Set up everything needed for normal use of bzrlib.
154
 
 
155
 
    Most applications that embed bzrlib, including bzr itself, should call
156
 
    this function to initialize various subsystems.  
157
 
 
158
 
    More options may be added in future so callers should use named arguments.
159
 
 
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
162
 
        the caller.
163
 
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
164
 
        otherwise use the files in `sys`.
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__
167
 
        should be called by the caller before exiting their process or
168
 
        otherwise stopping use of bzrlib. Advanced callers can use
169
 
        BzrLibraryState directly.
170
 
    """
171
 
    from bzrlib import library_state, trace
172
 
    if setup_ui:
173
 
        import bzrlib.ui
174
 
        stdin = stdin or sys.stdin
175
 
        stdout = stdout or sys.stdout
176
 
        stderr = stderr or sys.stderr
177
 
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
178
 
    else:
179
 
        ui_factory = None
180
 
    tracer = trace.DefaultConfig()
181
 
    return library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
182
 
 
 
38
version_info = (0, 12, 0, 'dev', 0)
 
39
 
 
40
if version_info[3] == 'final':
 
41
    version_string = '%d.%d.%d' % version_info[:3]
 
42
else:
 
43
    version_string = '%d.%d.%d%s%d' % version_info
 
44
__version__ = version_string
 
45
 
 
46
from bzrlib.symbol_versioning import (deprecated_function,
 
47
                                      zero_seven,
 
48
                                      zero_nine,
 
49
                                      deprecated_list,
 
50
                                     )
 
51
 
 
52
# Kept for compatibility with 0.8, it is considered deprecated to modify it
 
53
DEFAULT_IGNORE = deprecated_list(zero_nine, 'DEFAULT_IGNORE', [],
 
54
                    'Consider using bzrlib.ignores.add_unique_user_ignores'
 
55
                    ' or bzrlib.ignores.add_runtime_ignores')
183
56
 
184
57
def test_suite():
185
58
    import tests