← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 02:16:42 UTC
  • mfrom: (5017.1.2 initialize)
  • Revision ID: pqm@pqm.ubuntu.com-20100211021642-eitum30b2e09oalf
(mbp) Add bzrlib.initialize

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/__init__.py
105
105
 
106
106
    This tells the library how to display things to the user.  Through this
107
107
    layer different applications can choose the style of UI.
108
 
 
109
 
    UI Factories are also context managers, for some syntactic sugar some users
110
 
    need.
111
 
 
112
 
    :ivar suppressed_warnings: Identifiers for user warnings that should 
113
 
        no be emitted.
114
108
    """
115
109
 
116
 
    _user_warning_templates = dict(
117
 
        cross_format_fetch=("Doing on-the-fly conversion from "
118
 
            "%(from_format)s to %(to_format)s.\n"
119
 
            "This may take some time. Upgrade the repositories to the "
120
 
            "same format for better performance."
121
 
            )
122
 
        )
123
 
 
124
110
    def __init__(self):
125
111
        self._task_stack = []
126
 
        self.suppressed_warnings = set()
127
112
        self._quiet = False
128
113
 
129
 
    def __enter__(self):
130
 
        """Context manager entry support.
131
 
 
132
 
        Override in a concrete factory class if initialisation before use is
133
 
        needed.
134
 
        """
135
 
        return self # This is bound to the 'as' clause in a with statement.
136
 
 
137
 
    def __exit__(self, exc_type, exc_val, exc_tb):
138
 
        """Context manager exit support.
139
 
 
140
 
        Override in a concrete factory class if more cleanup than a simple
141
 
        self.clear_term() is needed when the UIFactory is finished with.
142
 
        """
143
 
        self.clear_term()
144
 
        return False # propogate exceptions.
145
 
 
146
114
    def be_quiet(self, state):
147
115
        """Tell the UI to be more quiet, or not.
148
116
 
178
146
        version of stdout, but in a GUI it might be appropriate to send it to a 
179
147
        window displaying the text.
180
148
     
181
 
        :param encoding: Unicode encoding for output; if not specified 
182
 
            uses the configured 'output_encoding' if any; otherwise the 
183
 
            terminal encoding. 
 
149
        :param encoding: Unicode encoding for output; default is the 
 
150
            terminal encoding, which may be different from the user encoding.
184
151
            (See get_terminal_encoding.)
185
152
 
186
153
        :param encoding_type: How to handle encoding errors:
188
155
        """
189
156
        # XXX: is the caller supposed to close the resulting object?
190
157
        if encoding is None:
191
 
            from bzrlib import config
192
 
            encoding = config.GlobalConfig().get_user_option(
193
 
                'output_encoding')
194
 
        if encoding is None:
195
 
            encoding = osutils.get_terminal_encoding(trace=True)
 
158
            encoding = osutils.get_terminal_encoding()
196
159
        if encoding_type is None:
197
160
            encoding_type = 'replace'
198
161
        out_stream = self._make_output_stream_explicit(encoding, encoding_type)
247
210
        """
248
211
        pass
249
212
 
250
 
    def format_user_warning(self, warning_id, message_args):
251
 
        try:
252
 
            template = self._user_warning_templates[warning_id]
253
 
        except KeyError:
254
 
            fail = "failed to format warning %r, %r" % (warning_id, message_args)
255
 
            warnings.warn(fail)   # so tests will fail etc
256
 
            return fail
257
 
        try:
258
 
            return template % message_args
259
 
        except ValueError, e:
260
 
            fail = "failed to format warning %r, %r: %s" % (
261
 
                warning_id, message_args, e)
262
 
            warnings.warn(fail)   # so tests will fail etc
263
 
            return fail
264
 
 
265
213
    def get_boolean(self, prompt):
266
214
        """Get a boolean question answered from the user.
267
215
 
292
240
    def recommend_upgrade(self,
293
241
        current_format_name,
294
242
        basedir):
295
 
        # XXX: this should perhaps be in the TextUIFactory and the default can do
 
243
        # this should perhaps be in the TextUIFactory and the default can do
296
244
        # nothing
297
 
        #
298
 
        # XXX: Change to show_user_warning - that will accomplish the previous
299
 
        # xxx. -- mbp 2010-02-25
300
245
        trace.warning("%s is deprecated "
301
246
            "and a better format is available.\n"
302
247
            "It is recommended that you upgrade by "
326
271
        # Default implementation just does nothing
327
272
        pass
328
273
 
329
 
    def show_user_warning(self, warning_id, **message_args):
330
 
        """Show a warning to the user.
331
 
 
332
 
        This is specifically for things that are under the user's control (eg
333
 
        outdated formats), not for internal program warnings like deprecated
334
 
        APIs.
335
 
 
336
 
        This can be overridden by UIFactory subclasses to show it in some 
337
 
        appropriate way; the default UIFactory is noninteractive and does
338
 
        nothing.  format_user_warning maps it to a string, though other
339
 
        presentations can be used for particular UIs.
340
 
 
341
 
        :param warning_id: An identifier like 'cross_format_fetch' used to 
342
 
            check if the message is suppressed and to look up the string.
343
 
        :param message_args: Arguments to be interpolated into the message.
344
 
        """
345
 
        pass
346
 
 
347
274
    def show_error(self, msg):
348
275
        """Show an error message (not an exception) to the user.
349
276
        
361
288
        raise NotImplementedError(self.show_warning)
362
289
 
363
290
    def warn_cross_format_fetch(self, from_format, to_format):
364
 
        """Warn about a potentially slow cross-format transfer.
365
 
        
366
 
        This is deprecated in favor of show_user_warning, but retained for api
367
 
        compatibility in 2.0 and 2.1.
368
 
        """
369
 
        self.show_user_warning('cross_format_fetch', from_format=from_format,
370
 
            to_format=to_format)
 
291
        """Warn about a potentially slow cross-format transfer"""
 
292
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
293
        trace.warning("Doing on-the-fly conversion from %s to %s.\n"
 
294
            "This may take some time. Upgrade the repositories to the "
 
295
            "same format for better performance.\n" %
 
296
            (from_format, to_format))
371
297
 
372
298
    def warn_experimental_format_fetch(self, inter):
373
299
        """Warn about fetching into experimental repository formats."""
377
303
                "without an upgrade path.\n" % (inter.target._format,))
378
304
 
379
305
 
 
306
 
380
307
class SilentUIFactory(UIFactory):
381
308
    """A UI Factory which never prints anything.
382
309