← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/library_state.py

Merge bzr.dev into cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/library_state.py
1
 
# Copyright (C) 2010 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""The core state needed to make use of bzr is managed here."""
18
 
 
19
 
__all__ = [
20
 
    'BzrLibraryState',
21
 
    ]
22
 
 
23
 
import sys
24
 
 
25
 
import bzrlib
26
 
 
27
 
 
28
 
class BzrLibraryState(object):
29
 
    """The state about how bzrlib has been configured.
30
 
 
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.
34
 
 
35
 
    :ivar saved_state: The bzrlib.global_state at the time __enter__ was
36
 
        called.
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__.
40
 
    """
41
 
 
42
 
    def __init__(self, ui, trace):
43
 
        """Create library start for normal use of bzrlib.
44
 
 
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.
49
 
 
50
 
        More options may be added in future so callers should use named
51
 
        arguments.
52
 
 
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
56
 
        __exit__.
57
 
 
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.
61
 
        """
62
 
        self._ui = ui
63
 
        self._trace = trace
64
 
        self.started = False
65
 
 
66
 
    def __enter__(self):
67
 
        if not self.started:
68
 
            self._start()
69
 
        return self # This is bound to the 'as' clause in a with statement.
70
 
 
71
 
    def _start(self):
72
 
        """Do all initialization.
73
 
        """        
74
 
        # NB: This function tweaks so much global state it's hard to test it in
75
 
        # isolation within the same interpreter.  It's not reached on normal
76
 
        # in-process run_bzr calls.  If it's broken, we expect that
77
 
        # TestRunBzrSubprocess may fail.
78
 
        import bzrlib
79
 
        if bzrlib.version_info[3] == 'final':
80
 
            from bzrlib.symbol_versioning import suppress_deprecation_warnings
81
 
            warning_cleanup = suppress_deprecation_warnings(override=True)
82
 
        else:
83
 
            warning_cleanup = None
84
 
 
85
 
        import bzrlib.cleanup
86
 
        self.cleanups = bzrlib.cleanup.ObjectWithCleanups()
87
 
        if warning_cleanup:
88
 
            self.cleanups.add_cleanup(warning_cleanup)
89
 
        self._trace.__enter__()
90
 
 
91
 
        self._orig_ui = bzrlib.ui.ui_factory
92
 
        bzrlib.ui.ui_factory = self._ui
93
 
        self._ui.__enter__()
94
 
 
95
 
        self.saved_state = bzrlib.global_state
96
 
        bzrlib.global_state = self
97
 
        self.started = True
98
 
 
99
 
    def __exit__(self, exc_type, exc_val, exc_tb):
100
 
        self.cleanups.cleanup_now()
101
 
        import bzrlib.ui
102
 
        bzrlib.trace._flush_stdout_stderr()
103
 
        bzrlib.trace._flush_trace()
104
 
        import bzrlib.osutils
105
 
        bzrlib.osutils.report_extension_load_failures()
106
 
        self._ui.__exit__(None, None, None)
107
 
        self._trace.__exit__(None, None, None)
108
 
        bzrlib.ui.ui_factory = self._orig_ui
109
 
        global global_state
110
 
        global_state = self.saved_state
111
 
        return False # propogate exceptions.