/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: Robert Collins
  • Date: 2010-06-26 01:07:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5324.
  • Revision ID: robertc@robertcollins.net-20100626010716-jowzrldm4ntsaki2
Make bzrlib startup use a trace context manager.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
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
 
"""bzr library"""
 
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
"""
18
33
 
19
34
import time
20
35
 
21
36
# Keep track of when bzrlib was first imported, so that we can give rough
22
37
# timestamps relative to program start in the log file kept by bzrlib.trace.
 
38
# XXX: GLOBAL
23
39
_start_time = time.time()
24
40
 
25
41
import sys
44
60
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
45
61
# releaselevel of 'dev' for unreleased under-development code.
46
62
 
47
 
version_info = (2, 2, 0, 'dev', 1)
 
63
version_info = (2, 2, 0, 'beta', 3)
48
64
 
49
65
# API compatibility version
50
66
api_minimum_version = (2, 2, 0)
114
130
__version__ = _format_version_tuple(version_info)
115
131
version_string = __version__
116
132
 
117
 
 
118
 
def test_suite():
119
 
    import tests
120
 
    return tests.test_suite()
121
 
 
122
 
 
123
 
def initialize(
124
 
    setup_ui=True,
125
 
    stdin=None, stdout=None, stderr=None):
 
133
# bzr has various bits of global state that are slowly being eliminated.
 
134
# This variable is intended to permit any new state-like things to be attached
 
135
# to a library_state.BzrLibraryState object rather than getting new global
 
136
# variables that need to be hunted down. Accessing the current BzrLibraryState
 
137
# through this variable is not encouraged: it is better to pass it around as
 
138
# part of the context of an operation than to look it up directly, but when
 
139
# that is too hard, it is better to use this variable than to make a branch new
 
140
# global variable.
 
141
# If using this variable by looking it up (because it can't be easily obtained)
 
142
# it is important to store the reference you get, rather than looking it up
 
143
# repeatedly; that way your code will behave properly in the bzrlib test suite
 
144
# and from programs that do use multiple library contexts.
 
145
global_state = None
 
146
 
 
147
 
 
148
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
126
149
    """Set up everything needed for normal use of bzrlib.
127
150
 
128
151
    Most applications that embed bzrlib, including bzr itself, should call
131
154
    More options may be added in future so callers should use named arguments.
132
155
 
133
156
    :param setup_ui: If true (default) use a terminal UI; otherwise 
134
 
        something else must be put into `bzrlib.ui.ui_factory`.
 
157
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
 
158
        the caller.
135
159
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
136
160
        otherwise use the files in `sys`.
 
161
    :return: A context manager for the use of bzrlib. The __enter__ method of
 
162
        this context needs to be called before it takes effect, and the __exit__
 
163
        should be called by the caller before exiting their process or
 
164
        otherwise stopping use of bzrlib. Advanced callers can use
 
165
        BzrLibraryState directly.
137
166
    """
138
 
    # TODO: mention this in a guide to embedding bzrlib
139
 
    #
140
 
    # NB: This function tweaks so much global state it's hard to test it in
141
 
    # isolation within the same interpreter.  It's not reached on normal
142
 
    # in-process run_bzr calls.  If it's broken, we expect that
143
 
    # TestRunBzrSubprocess may fail.
144
 
    
145
 
    import atexit
146
 
    import bzrlib.trace
147
 
 
148
 
    bzrlib.trace.enable_default_logging()
149
 
    atexit.register(bzrlib.trace._flush_stdout_stderr)
150
 
    atexit.register(bzrlib.trace._flush_trace)
151
 
 
152
 
    import bzrlib.ui
153
 
    if stdin is None:
154
 
        stdin = sys.stdin
155
 
    if stdout is None:
156
 
        stdout = sys.stdout
157
 
    if stderr is None:
158
 
        stderr = sys.stderr
159
 
 
 
167
    import bzrlib.library_state
160
168
    if setup_ui:
161
 
        bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
162
 
            stdin, stdout, stderr)
163
 
 
164
 
    if bzrlib.version_info[3] == 'final':
165
 
        from bzrlib.symbol_versioning import suppress_deprecation_warnings
166
 
        suppress_deprecation_warnings(override=True)
167
 
 
168
 
    import bzrlib.osutils
169
 
    atexit.register(osutils.report_extension_load_failures)
 
169
        import bzrlib.ui
 
170
        stdin = stdin or sys.stdin
 
171
        stdout = stdout or sys.stdout
 
172
        stderr = stderr or sys.stderr
 
173
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
 
174
    else:
 
175
        ui_factory = None
 
176
    tracer = bzrlib.trace.DefaultConfig()
 
177
    return bzrlib.library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
 
178
 
 
179
 
 
180
def test_suite():
 
181
    import tests
 
182
    return tests.test_suite()