~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Martin Pool
  • Date: 2005-07-22 22:37:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050722223753-7dced4e32d3ce21d
- add the start of a test for inventory file-id matching

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-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
 
"""Abstraction for interacting with the user.
18
 
 
19
 
Applications can choose different types of UI, and they deal with displaying
20
 
messages or progress to the user, and with gathering different types of input.
21
 
 
22
 
Several levels are supported, and you can also register new factories such as
23
 
for a GUI.
24
 
 
25
 
bzrlib.ui.UIFactory
26
 
    Semi-abstract base class
27
 
 
28
 
bzrlib.ui.SilentUIFactory
29
 
    Produces no output and cannot take any input; useful for programs using
30
 
    bzrlib in batch mode or for programs such as loggerhead.
31
 
 
32
 
bzrlib.ui.CannedInputUIFactory
33
 
    For use in testing; the input values to be returned are provided 
34
 
    at construction.
35
 
 
36
 
bzrlib.ui.text.TextUIFactory
37
 
    Standard text command-line interface, with stdin, stdout, stderr.
38
 
    May make more or less advanced use of them, eg in drawing progress bars,
39
 
    depending on the detected capabilities of the terminal.
40
 
    GUIs may choose to subclass this so that unimplemented methods fall
41
 
    back to working through the terminal.
42
 
"""
43
 
 
44
 
 
45
 
import os
46
 
import sys
47
 
import warnings
48
 
 
49
 
from bzrlib.lazy_import import lazy_import
50
 
lazy_import(globals(), """
51
 
import getpass
52
 
 
53
 
from bzrlib import (
54
 
    errors,
55
 
    osutils,
56
 
    progress,
57
 
    trace,
58
 
    )
59
 
""")
60
 
from bzrlib.symbol_versioning import (
61
 
    deprecated_function,
62
 
    deprecated_in,
63
 
    deprecated_method,
64
 
    )
65
 
 
66
 
 
67
 
_valid_boolean_strings = dict(yes=True, no=False,
68
 
                              y=True, n=False,
69
 
                              on=True, off=False,
70
 
                              true=True, false=False)
71
 
_valid_boolean_strings['1'] = True
72
 
_valid_boolean_strings['0'] = False
73
 
 
74
 
 
75
 
def bool_from_string(s, accepted_values=None):
76
 
    """Returns a boolean if the string can be interpreted as such.
77
 
 
78
 
    Interpret case insensitive strings as booleans. The default values
79
 
    includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
80
 
    'off'. Alternative values can be provided with the 'accepted_values'
81
 
    parameter.
82
 
 
83
 
    :param s: A string that should be interpreted as a boolean. It should be of
84
 
        type string or unicode.
85
 
 
86
 
    :param accepted_values: An optional dict with accepted strings as keys and
87
 
        True/False as values. The strings will be tested against a lowered
88
 
        version of 's'.
89
 
 
90
 
    :return: True or False for accepted strings, None otherwise.
91
 
    """
92
 
    if accepted_values is None:
93
 
        accepted_values = _valid_boolean_strings
94
 
    val = None
95
 
    if type(s) in (str, unicode):
96
 
        try:
97
 
            val = accepted_values[s.lower()]
98
 
        except KeyError:
99
 
            pass
100
 
    return val
101
 
 
102
 
 
103
 
class ConfirmationUserInterfacePolicy(object):
104
 
    """Wrapper for a UIFactory that allows or denies all confirmed actions."""
105
 
 
106
 
    def __init__(self, wrapped_ui, default_answer, specific_answers):
107
 
        """Generate a proxy UI that does no confirmations.
108
 
 
109
 
        :param wrapped_ui: Underlying UIFactory.
110
 
        :param default_answer: Bool for whether requests for
111
 
            confirmation from the user should be noninteractively accepted or
112
 
            denied.
113
 
        :param specific_answers: Map from confirmation_id to bool answer.
114
 
        """
115
 
        self.wrapped_ui = wrapped_ui
116
 
        self.default_answer = default_answer
117
 
        self.specific_answers = specific_answers
118
 
 
119
 
    def __getattr__(self, name):
120
 
        return getattr(self.wrapped_ui, name)
121
 
 
122
 
    def __repr__(self):
123
 
        return '%s(%r, %r, %r)' % (
124
 
            self.__class__.__name__,
125
 
            self.wrapped_ui,
126
 
            self.default_answer, 
127
 
            self.specific_answers)
128
 
 
129
 
    def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
130
 
        if confirmation_id in self.specific_answers:
131
 
            return self.specific_answers[confirmation_id]
132
 
        elif self.default_answer is not None:
133
 
            return self.default_answer
134
 
        else:
135
 
            return self.wrapped_ui.confirm_action(
136
 
                prompt, confirmation_id, prompt_kwargs)
137
 
 
138
 
 
139
 
class UIFactory(object):
140
 
    """UI abstraction.
141
 
 
142
 
    This tells the library how to display things to the user.  Through this
143
 
    layer different applications can choose the style of UI.
144
 
 
145
 
    UI Factories are also context managers, for some syntactic sugar some users
146
 
    need.
147
 
 
148
 
    :ivar suppressed_warnings: Identifiers for user warnings that should 
149
 
        no be emitted.
150
 
    """
151
 
 
152
 
    _user_warning_templates = dict(
153
 
        cross_format_fetch=("Doing on-the-fly conversion from "
154
 
            "%(from_format)s to %(to_format)s.\n"
155
 
            "This may take some time. Upgrade the repositories to the "
156
 
            "same format for better performance."
157
 
            )
158
 
        )
159
 
 
160
 
    def __init__(self):
161
 
        self._task_stack = []
162
 
        self.suppressed_warnings = set()
163
 
        self._quiet = False
164
 
 
165
 
    def __enter__(self):
166
 
        """Context manager entry support.
167
 
 
168
 
        Override in a concrete factory class if initialisation before use is
169
 
        needed.
170
 
        """
171
 
        return self # This is bound to the 'as' clause in a with statement.
172
 
 
173
 
    def __exit__(self, exc_type, exc_val, exc_tb):
174
 
        """Context manager exit support.
175
 
 
176
 
        Override in a concrete factory class if more cleanup than a simple
177
 
        self.clear_term() is needed when the UIFactory is finished with.
178
 
        """
179
 
        self.clear_term()
180
 
        return False # propogate exceptions.
181
 
 
182
 
    def be_quiet(self, state):
183
 
        """Tell the UI to be more quiet, or not.
184
 
 
185
 
        Typically this suppresses progress bars; the application may also look
186
 
        at ui_factory.is_quiet().
187
 
        """
188
 
        self._quiet = state
189
 
 
190
 
    def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
191
 
        """Seek user confirmation for an action.
192
 
 
193
 
        If the UI is noninteractive, or the user does not want to be asked
194
 
        about this action, True is returned, indicating bzr should just
195
 
        proceed.
196
 
 
197
 
        The confirmation id allows the user to configure certain actions to
198
 
        always be confirmed or always denied, and for UIs to specialize the
199
 
        display of particular confirmations.
200
 
 
201
 
        :param prompt: Suggested text to display to the user.
202
 
        :param prompt_kwargs: A dictionary of arguments that can be
203
 
            string-interpolated into the prompt.
204
 
        :param confirmation_id: Unique string identifier for the confirmation.
205
 
        """
206
 
        return self.get_boolean(prompt % prompt_kwargs)
207
 
 
208
 
    def get_password(self, prompt='', **kwargs):
209
 
        """Prompt the user for a password.
210
 
 
211
 
        :param prompt: The prompt to present the user
212
 
        :param kwargs: Arguments which will be expanded into the prompt.
213
 
                       This lets front ends display different things if
214
 
                       they so choose.
215
 
 
216
 
        :return: The password string, return None if the user canceled the
217
 
                 request. Note that we do not touch the encoding, users may
218
 
                 have whatever they see fit and the password should be
219
 
                 transported as is.
220
 
        """
221
 
        raise NotImplementedError(self.get_password)
222
 
 
223
 
    def is_quiet(self):
224
 
        return self._quiet
225
 
 
226
 
    def make_output_stream(self, encoding=None, encoding_type=None):
227
 
        """Get a stream for sending out bulk text data.
228
 
 
229
 
        This is used for commands that produce bulk text, such as log or diff
230
 
        output, as opposed to user interaction.  This should work even for
231
 
        non-interactive user interfaces.  Typically this goes to a decorated
232
 
        version of stdout, but in a GUI it might be appropriate to send it to a 
233
 
        window displaying the text.
234
 
     
235
 
        :param encoding: Unicode encoding for output; if not specified 
236
 
            uses the configured 'output_encoding' if any; otherwise the 
237
 
            terminal encoding. 
238
 
            (See get_terminal_encoding.)
239
 
 
240
 
        :param encoding_type: How to handle encoding errors:
241
 
            replace/strict/escape/exact.  Default is replace.
242
 
        """
243
 
        # XXX: is the caller supposed to close the resulting object?
244
 
        if encoding is None:
245
 
            from bzrlib import config
246
 
            encoding = config.GlobalConfig().get_user_option(
247
 
                'output_encoding')
248
 
        if encoding is None:
249
 
            encoding = osutils.get_terminal_encoding(trace=True)
250
 
        if encoding_type is None:
251
 
            encoding_type = 'replace'
252
 
        out_stream = self._make_output_stream_explicit(encoding, encoding_type)
253
 
        return out_stream
254
 
 
255
 
    def _make_output_stream_explicit(self, encoding, encoding_type):
256
 
        raise NotImplementedError("%s doesn't support make_output_stream"
257
 
            % (self.__class__.__name__))
258
 
 
259
 
    def nested_progress_bar(self):
260
 
        """Return a nested progress bar.
261
 
 
262
 
        When the bar has been finished with, it should be released by calling
263
 
        bar.finished().
264
 
        """
265
 
        if self._task_stack:
266
 
            t = progress.ProgressTask(self._task_stack[-1], self)
267
 
        else:
268
 
            t = progress.ProgressTask(None, self)
269
 
        self._task_stack.append(t)
270
 
        return t
271
 
 
272
 
    def _progress_finished(self, task):
273
 
        """Called by the ProgressTask when it finishes"""
274
 
        if not self._task_stack:
275
 
            warnings.warn("%r finished but nothing is active"
276
 
                % (task,))
277
 
        if task in self._task_stack:
278
 
            self._task_stack.remove(task)
279
 
        else:
280
 
            warnings.warn("%r is not in active stack %r"
281
 
                % (task, self._task_stack))
282
 
        if not self._task_stack:
283
 
            self._progress_all_finished()
284
 
 
285
 
    def _progress_all_finished(self):
286
 
        """Called when the top-level progress task finished"""
287
 
        pass
288
 
 
289
 
    def _progress_updated(self, task):
290
 
        """Called by the ProgressTask when it changes.
291
 
 
292
 
        Should be specialized to draw the progress.
293
 
        """
294
 
        pass
295
 
 
296
 
    def clear_term(self):
297
 
        """Prepare the terminal for output.
298
 
 
299
 
        This will, for example, clear text progress bars, and leave the
300
 
        cursor at the leftmost position.
301
 
        """
302
 
        pass
303
 
 
304
 
    def format_user_warning(self, warning_id, message_args):
305
 
        try:
306
 
            template = self._user_warning_templates[warning_id]
307
 
        except KeyError:
308
 
            fail = "failed to format warning %r, %r" % (warning_id, message_args)
309
 
            warnings.warn(fail)   # so tests will fail etc
310
 
            return fail
311
 
        try:
312
 
            return template % message_args
313
 
        except ValueError, e:
314
 
            fail = "failed to format warning %r, %r: %s" % (
315
 
                warning_id, message_args, e)
316
 
            warnings.warn(fail)   # so tests will fail etc
317
 
            return fail
318
 
 
319
 
    def get_boolean(self, prompt):
320
 
        """Get a boolean question answered from the user.
321
 
 
322
 
        :param prompt: a message to prompt the user with. Should be a single
323
 
        line without terminating \n.
324
 
        :return: True or False for y/yes or n/no.
325
 
        """
326
 
        raise NotImplementedError(self.get_boolean)
327
 
 
328
 
    def get_integer(self, prompt):
329
 
        """Get an integer from the user.
330
 
 
331
 
        :param prompt: a message to prompt the user with. Could be a multi-line
332
 
            prompt but without a terminating \n.
333
 
 
334
 
        :return: A signed integer.
335
 
        """
336
 
        raise NotImplementedError(self.get_integer)
337
 
 
338
 
    def make_progress_view(self):
339
 
        """Construct a new ProgressView object for this UI.
340
 
 
341
 
        Application code should normally not call this but instead
342
 
        nested_progress_bar().
343
 
        """
344
 
        return NullProgressView()
345
 
 
346
 
    def recommend_upgrade(self,
347
 
        current_format_name,
348
 
        basedir):
349
 
        # XXX: this should perhaps be in the TextUIFactory and the default can do
350
 
        # nothing
351
 
        #
352
 
        # XXX: Change to show_user_warning - that will accomplish the previous
353
 
        # xxx. -- mbp 2010-02-25
354
 
        trace.warning("%s is deprecated "
355
 
            "and a better format is available.\n"
356
 
            "It is recommended that you upgrade by "
357
 
            "running the command\n"
358
 
            "  bzr upgrade %s",
359
 
            current_format_name,
360
 
            basedir)
361
 
 
362
 
    def report_transport_activity(self, transport, byte_count, direction):
363
 
        """Called by transports as they do IO.
364
 
 
365
 
        This may update a progress bar, spinner, or similar display.
366
 
        By default it does nothing.
367
 
        """
368
 
        pass
369
 
 
370
 
    def log_transport_activity(self, display=False):
371
 
        """Write out whatever transport activity has been measured.
372
 
 
373
 
        Implementations are allowed to do nothing, but it is useful if they can
374
 
        write a line to the log file.
375
 
 
376
 
        :param display: If False, only log to disk, if True also try to display
377
 
            a message to the user.
378
 
        :return: None
379
 
        """
380
 
        # Default implementation just does nothing
381
 
        pass
382
 
 
383
 
    def show_user_warning(self, warning_id, **message_args):
384
 
        """Show a warning to the user.
385
 
 
386
 
        This is specifically for things that are under the user's control (eg
387
 
        outdated formats), not for internal program warnings like deprecated
388
 
        APIs.
389
 
 
390
 
        This can be overridden by UIFactory subclasses to show it in some 
391
 
        appropriate way; the default UIFactory is noninteractive and does
392
 
        nothing.  format_user_warning maps it to a string, though other
393
 
        presentations can be used for particular UIs.
394
 
 
395
 
        :param warning_id: An identifier like 'cross_format_fetch' used to 
396
 
            check if the message is suppressed and to look up the string.
397
 
        :param message_args: Arguments to be interpolated into the message.
398
 
        """
399
 
        pass
400
 
 
401
 
    def show_error(self, msg):
402
 
        """Show an error message (not an exception) to the user.
403
 
        
404
 
        The message should not have an error prefix or trailing newline.  That
405
 
        will be added by the factory if appropriate.
406
 
        """
407
 
        raise NotImplementedError(self.show_error)
408
 
 
409
 
    def show_message(self, msg):
410
 
        """Show a message to the user."""
411
 
        raise NotImplementedError(self.show_message)
412
 
 
413
 
    def show_warning(self, msg):
414
 
        """Show a warning to the user."""
415
 
        raise NotImplementedError(self.show_warning)
416
 
 
417
 
    def warn_cross_format_fetch(self, from_format, to_format):
418
 
        """Warn about a potentially slow cross-format transfer.
419
 
        
420
 
        This is deprecated in favor of show_user_warning, but retained for api
421
 
        compatibility in 2.0 and 2.1.
422
 
        """
423
 
        self.show_user_warning('cross_format_fetch', from_format=from_format,
424
 
            to_format=to_format)
425
 
 
426
 
    def warn_experimental_format_fetch(self, inter):
427
 
        """Warn about fetching into experimental repository formats."""
428
 
        if inter.target._format.experimental:
429
 
            trace.warning("Fetching into experimental format %s.\n"
430
 
                "This format may be unreliable or change in the future "
431
 
                "without an upgrade path.\n" % (inter.target._format,))
432
 
 
433
 
 
434
 
class NoninteractiveUIFactory(UIFactory):
435
 
    """Base class for UIs with no user."""
436
 
 
437
 
    def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
438
 
        return True
439
 
 
440
 
    def __repr__(self):
441
 
        return '%s()' % (self.__class__.__name__, )
442
 
 
443
 
 
444
 
class SilentUIFactory(NoninteractiveUIFactory):
445
 
    """A UI Factory which never prints anything.
446
 
 
447
 
    This is the default UI, if another one is never registered by a program
448
 
    using bzrlib, and it's also active for example inside 'bzr serve'.
449
 
 
450
 
    Methods that try to read from the user raise an error; methods that do
451
 
    output do nothing.
452
 
    """
453
 
 
454
 
    def __init__(self):
455
 
        UIFactory.__init__(self)
456
 
 
457
 
    def note(self, msg):
458
 
        pass
459
 
 
460
 
    def get_username(self, prompt, **kwargs):
461
 
        return None
462
 
 
463
 
    def _make_output_stream_explicit(self, encoding, encoding_type):
464
 
        return NullOutputStream(encoding)
465
 
 
466
 
    def show_error(self, msg):
467
 
        pass
468
 
 
469
 
    def show_message(self, msg):
470
 
        pass
471
 
 
472
 
    def show_warning(self, msg):
473
 
        pass
474
 
 
475
 
 
476
 
class CannedInputUIFactory(SilentUIFactory):
477
 
    """A silent UI that return canned input."""
478
 
 
479
 
    def __init__(self, responses):
480
 
        self.responses = responses
481
 
 
482
 
    def __repr__(self):
483
 
        return "%s(%r)" % (self.__class__.__name__, self.responses)
484
 
 
485
 
    def confirm_action(self, prompt, confirmation_id, args):
486
 
        return self.get_boolean(prompt % args)
487
 
 
488
 
    def get_boolean(self, prompt):
489
 
        return self.responses.pop(0)
490
 
 
491
 
    def get_integer(self, prompt):
492
 
        return self.responses.pop(0)
493
 
 
494
 
    def get_password(self, prompt='', **kwargs):
495
 
        return self.responses.pop(0)
496
 
 
497
 
    def get_username(self, prompt, **kwargs):
498
 
        return self.responses.pop(0)
499
 
 
500
 
    def assert_all_input_consumed(self):
501
 
        if self.responses:
502
 
            raise AssertionError("expected all input in %r to be consumed"
503
 
                % (self,))
504
 
 
505
 
 
506
 
ui_factory = SilentUIFactory()
507
 
# IMPORTANT: never import this symbol directly. ONLY ever access it as
508
 
# ui.ui_factory, so that you refer to the current value.
509
 
 
510
 
 
511
 
def make_ui_for_terminal(stdin, stdout, stderr):
512
 
    """Construct and return a suitable UIFactory for a text mode program.
513
 
    """
514
 
    # this is now always TextUIFactory, which in turn decides whether it
515
 
    # should display progress bars etc
516
 
    from bzrlib.ui.text import TextUIFactory
517
 
    return TextUIFactory(stdin, stdout, stderr)
518
 
 
519
 
 
520
 
class NullProgressView(object):
521
 
    """Soak up and ignore progress information."""
522
 
 
523
 
    def clear(self):
524
 
        pass
525
 
 
526
 
    def show_progress(self, task):
527
 
        pass
528
 
 
529
 
    def show_transport_activity(self, transport, direction, byte_count):
530
 
        pass
531
 
 
532
 
    def log_transport_activity(self, display=False):
533
 
        pass
534
 
 
535
 
 
536
 
class NullOutputStream(object):
537
 
    """Acts like a file, but discard all output."""
538
 
 
539
 
    def __init__(self, encoding):
540
 
        self.encoding = encoding
541
 
 
542
 
    def write(self, data):
543
 
        pass
544
 
 
545
 
    def writelines(self, data):
546
 
        pass
547
 
 
548
 
    def close(self):
549
 
        pass