1
# Copyright (C) 2010 Canonical Ltd
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.
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.
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""The core state needed to make use of bzr is managed here."""
28
class BzrLibraryState(object):
29
"""The state about how bzrlib has been configured.
31
This is the core state needed to make use of bzr. The current instance is
32
currently always exposed as bzrlib.global_state, but we desired to move
33
to a point where no global state is needed at all.
35
:ivar saved_state: The bzrlib.global_state at the time __enter__ was
37
:ivar cleanups: An ObjectWithCleanups which can be used for cleanups that
38
should occur when the use of bzrlib is completed. This is initialised
39
in __enter__ and executed in __exit__.
42
def __init__(self, ui, trace):
43
"""Create library start for normal use of bzrlib.
45
Most applications that embed bzrlib, including bzr itself, should just
46
call bzrlib.initialize(), but it is possible to use the state class
47
directly. The initialize() function provides sensible defaults for a
48
CLI program, such as a text UI factory.
50
More options may be added in future so callers should use named
53
BzrLibraryState implements the Python 2.5 Context Manager protocol
54
PEP343, and can be used with the with statement. Upon __enter__ the
55
global variables in use by bzr are set, and they are cleared on
58
:param ui: A bzrlib.ui.ui_factory to use.
59
:param trace: A bzrlib.trace.Config context manager to use, perhaps
60
bzrlib.trace.DefaultConfig.
66
# NB: This function tweaks so much global state it's hard to test it in
67
# isolation within the same interpreter. It's not reached on normal
68
# in-process run_bzr calls. If it's broken, we expect that
69
# TestRunBzrSubprocess may fail.
71
if bzrlib.version_info[3] == 'final':
72
from bzrlib.symbol_versioning import suppress_deprecation_warnings
73
warning_cleanup = suppress_deprecation_warnings(override=True)
75
warning_cleanup = None
78
self.cleanups = bzrlib.cleanup.ObjectWithCleanups()
80
self.cleanups.add_cleanup(warning_cleanup)
81
self._trace.__enter__()
83
self._orig_ui = bzrlib.ui.ui_factory
84
bzrlib.ui.ui_factory = self._ui
87
self.saved_state = bzrlib.global_state
88
bzrlib.global_state = self
89
return self # This is bound to the 'as' clause in a with statement.
91
def __exit__(self, exc_type, exc_val, exc_tb):
92
self.cleanups.cleanup_now()
94
bzrlib.trace._flush_stdout_stderr()
95
bzrlib.trace._flush_trace()
97
bzrlib.osutils.report_extension_load_failures()
98
self._ui.__exit__(None, None, None)
99
self._trace.__exit__(None, None, None)
100
bzrlib.ui.ui_factory = self._orig_ui
102
global_state = self.saved_state
103
return False # propogate exceptions.
added
removed
bzrlib/library_state.py
