← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Martin Pool
  • Date: 2009-09-14 02:30:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: mbp@sourcefrog.net-20090914023023-ros0f3ndo04j3bww
https://launchpad.net/bugs/429151
Clearer docs about bzr help.  (Thanks to Naoki)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
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
 
"""
 
17
"""bzr library"""
33
18
 
34
19
import time
35
20
 
38
23
_start_time = time.time()
39
24
 
40
25
import sys
 
26
if getattr(sys, '_bzr_lazy_regex', False):
 
27
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
 
28
    # hack as soon as possible so that as much of the standard library can
 
29
    # benefit, including the 'string' module.
 
30
    del sys._bzr_lazy_regex
 
31
    import bzrlib.lazy_regex
 
32
    bzrlib.lazy_regex.install_lazy_compile()
 
33
 
 
34
from bzrlib.osutils import get_user_encoding
41
35
 
42
36
 
43
37
IGNORE_FILENAME = ".bzrignore"
44
38
 
45
39
 
46
 
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
 
40
# XXX: Deprecated as of bzr-1.17 use osutils.get_user_encoding() directly
 
41
user_encoding = get_user_encoding()
 
42
 
 
43
 
 
44
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
47
45
 
48
46
# same format as sys.version_info: "A tuple containing the five components of
49
47
# the version number: major, minor, micro, releaselevel, and serial. All
52
50
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
53
51
# releaselevel of 'dev' for unreleased under-development code.
54
52
 
55
 
version_info = (2, 3, 0, 'dev', 2)
56
 
 
57
 
# API compatibility version
58
 
api_minimum_version = (2, 2, 0)
59
 
 
 
53
version_info = (2, 1, 0, 'dev', 0)
 
54
 
 
55
# API compatibility version: bzrlib is currently API compatible with 1.15.
 
56
api_minimum_version = (1, 17, 0)
60
57
 
61
58
def _format_version_tuple(version_info):
62
59
    """Turn a version number 2, 3 or 5-tuple into a short string.
68
65
    zero for final releases.
69
66
 
70
67
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
71
 
    1.0.0
 
68
    1.0
72
69
    >>> 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
 
70
    1.2dev
76
71
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
77
72
    1.1.1rc2
78
73
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
79
74
    2.1b1
80
75
    >>> print _format_version_tuple((1, 4, 0))
81
 
    1.4.0
 
76
    1.4
82
77
    >>> print _format_version_tuple((1, 4))
83
78
    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
79
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
89
80
    Traceback (most recent call last):
90
81
    ...
91
82
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
92
83
    """
93
 
    if len(version_info) == 2:
 
84
    if len(version_info) == 2 or version_info[2] == 0:
94
85
        main_version = '%d.%d' % version_info[:2]
95
86
    else:
96
87
        main_version = '%d.%d.%d' % version_info[:3]
105
96
        sub_string = ''
106
97
    elif release_type == 'dev' and sub == 0:
107
98
        sub_string = 'dev'
108
 
    elif release_type == 'dev':
109
 
        sub_string = 'dev' + str(sub)
110
99
    elif release_type in ('alpha', 'beta'):
111
 
        if version_info[2] == 0:
112
 
            main_version = '%d.%d' % version_info[:2]
113
100
        sub_string = release_type[0] + str(sub)
114
101
    elif release_type == 'candidate':
115
102
        sub_string = 'rc' + str(sub)
116
103
    else:
117
104
        raise ValueError("version_info %r not valid" % (version_info,))
118
105
 
 
106
    version_string = '%d.%d.%d.%s.%d' % tuple(version_info)
119
107
    return main_version + sub_string
120
108
 
121
109
 
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
110
__version__ = _format_version_tuple(version_info)
135
111
version_string = __version__
136
112
 
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
 
 
183
113
 
184
114
def test_suite():
185
115
    import tests