/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 breezy/library_state.py

  • Committer: Jelmer Vernooij
  • Date: 2018-10-28 11:33:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7142.
  • Revision ID: jelmer@jelmer.uk-20181028113330-aexu0nqkdti4p2pc
Use sys.executable rather than python for ad-hoc tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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
from __future__ import absolute_import
 
20
 
 
21
__all__ = [
 
22
    'BzrLibraryState',
 
23
    ]
 
24
 
 
25
 
 
26
import breezy
 
27
from .lazy_import import lazy_import
 
28
lazy_import(globals(), """
 
29
from breezy import (
 
30
    cleanup,
 
31
    config,
 
32
    osutils,
 
33
    symbol_versioning,
 
34
    trace,
 
35
    ui,
 
36
    )
 
37
""")
 
38
 
 
39
 
 
40
class BzrLibraryState(object):
 
41
    """The state about how breezy has been configured.
 
42
 
 
43
    This is the core state needed to make use of bzr. The current instance is
 
44
    currently always exposed as breezy._global_state, but we desired to move
 
45
    to a point where no global state is needed at all.
 
46
 
 
47
    :ivar cleanups: An ObjectWithCleanups which can be used for cleanups that
 
48
        should occur when the use of breezy is completed. This is initialised
 
49
        in __enter__ and executed in __exit__.
 
50
    """
 
51
 
 
52
    def __init__(self, ui, trace):
 
53
        """Create library start for normal use of breezy.
 
54
 
 
55
        Most applications that embed breezy, including bzr itself, should just
 
56
        call breezy.initialize(), but it is possible to use the state class
 
57
        directly. The initialize() function provides sensible defaults for a
 
58
        CLI program, such as a text UI factory.
 
59
 
 
60
        More options may be added in future so callers should use named
 
61
        arguments.
 
62
 
 
63
        BzrLibraryState implements the Python 2.5 Context Manager protocol
 
64
        PEP343, and can be used with the with statement. Upon __enter__ the
 
65
        global variables in use by bzr are set, and they are cleared on
 
66
        __exit__.
 
67
 
 
68
        :param ui: A breezy.ui.ui_factory to use.
 
69
        :param trace: A breezy.trace.Config context manager to use, perhaps
 
70
            breezy.trace.DefaultConfig.
 
71
        """
 
72
        self._ui = ui
 
73
        self._trace = trace
 
74
        # There is no overrides by default, they are set later when the command
 
75
        # arguments are parsed.
 
76
        self.cmdline_overrides = config.CommandLineStore()
 
77
        # No config stores are cached to start with
 
78
        self.config_stores = {} # By url
 
79
        self.started = False
 
80
 
 
81
    def __enter__(self):
 
82
        if not self.started:
 
83
            self._start()
 
84
        return self # This is bound to the 'as' clause in a with statement.
 
85
 
 
86
    def _start(self):
 
87
        """Do all initialization."""
 
88
        # NB: This function tweaks so much global state it's hard to test it in
 
89
        # isolation within the same interpreter.  It's not reached on normal
 
90
        # in-process run_bzr calls.  If it's broken, we expect that
 
91
        # TestRunBzrSubprocess may fail.
 
92
        self.cleanups = cleanup.ObjectWithCleanups()
 
93
 
 
94
        if breezy.version_info[3] == 'final':
 
95
            self.cleanups.add_cleanup(
 
96
                symbol_versioning.suppress_deprecation_warnings(override=True))
 
97
 
 
98
        self._trace.__enter__()
 
99
 
 
100
        self._orig_ui = breezy.ui.ui_factory
 
101
        breezy.ui.ui_factory = self._ui
 
102
        self._ui.__enter__()
 
103
 
 
104
        if breezy._global_state is not None:
 
105
            raise RuntimeError("Breezy already initialized")
 
106
        breezy._global_state = self
 
107
        self.started = True
 
108
 
 
109
    def __exit__(self, exc_type, exc_val, exc_tb):
 
110
        if exc_type is None:
 
111
            # Save config changes
 
112
            for k, store in self.config_stores.items():
 
113
                store.save_changes()
 
114
        self.cleanups.cleanup_now()
 
115
        trace._flush_stdout_stderr()
 
116
        trace._flush_trace()
 
117
        osutils.report_extension_load_failures()
 
118
        self._ui.__exit__(None, None, None)
 
119
        self._trace.__exit__(None, None, None)
 
120
        ui.ui_factory = self._orig_ui
 
121
        breezy._global_state = None
 
122
        return False # propogate exceptions.