← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-09-24 09:45:23 UTC
  • mfrom: (4712.1.4 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090924094523-nsz6mp3qwor3xpp3
(mbp) deprecate ProgressTask.note

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
34
34
from bzrlib.symbol_versioning import (
35
35
    deprecated_function,
36
36
    deprecated_in,
 
37
    deprecated_method,
37
38
    )
38
39
 
39
40
 
156
157
                own_fraction = 0.0
157
158
            return self._parent_task._overall_completion_fraction(own_fraction)
158
159
 
 
160
    @deprecated_method(deprecated_in((2, 1, 0)))
159
161
    def note(self, fmt_string, *args):
160
 
        """Record a note without disrupting the progress bar."""
161
 
        # XXX: shouldn't be here; put it in mutter or the ui instead
 
162
        """Record a note without disrupting the progress bar.
 
163
        
 
164
        Deprecated: use ui_factory.note() instead or bzrlib.trace.  Note that
 
165
        ui_factory.note takes just one string as the argument, not a format
 
166
        string and arguments.
 
167
        """
162
168
        if args:
163
169
            self.ui_factory.note(fmt_string % args)
164
170
        else:
165
171
            self.ui_factory.note(fmt_string)
166
172
 
167
173
    def clear(self):
168
 
        # XXX: shouldn't be here; put it in mutter or the ui instead
 
174
        # TODO: deprecate this method; the model object shouldn't be concerned
 
175
        # with whether it's shown or not.  Most callers use this because they
 
176
        # want to write some different non-progress output to the screen, but
 
177
        # they should probably instead use a stream that's synchronized with
 
178
        # the progress output.  It may be there is a model-level use for
 
179
        # saying "this task's not active at the moment" but I don't see it. --
 
180
        # mbp 20090623
169
181
        if self.progress_view:
170
182
            self.progress_view.clear()
171
183
        else: