/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 bzrlib/progress.py

Add bzrlib.pyutils, which has get_named_object, a wrapper around __import__.

This is used to replace various ad hoc implementations of the same logic,
notably the version used in registry's _LazyObjectGetter which had a bug when
getting a module without also getting a member.  And of course, this new
function has unit tests, unlike the replaced code.

This also adds a KnownHooksRegistry subclass to provide a more natural home for
some other logic.

I'm not thrilled about the name of the new module or the new functions, but it's
hard to think of good names for such generic functionality.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
152
152
                own_fraction = 0.0
153
153
            return self._parent_task._overall_completion_fraction(own_fraction)
154
154
 
155
 
    @deprecated_method(deprecated_in((2, 1, 0)))
156
 
    def note(self, fmt_string, *args):
157
 
        """Record a note without disrupting the progress bar.
158
 
        
159
 
        Deprecated: use ui_factory.note() instead or bzrlib.trace.  Note that
160
 
        ui_factory.note takes just one string as the argument, not a format
161
 
        string and arguments.
162
 
        """
163
 
        if args:
164
 
            self.ui_factory.note(fmt_string % args)
165
 
        else:
166
 
            self.ui_factory.note(fmt_string)
167
 
 
168
155
    def clear(self):
169
156
        # TODO: deprecate this method; the model object shouldn't be concerned
170
157
        # with whether it's shown or not.  Most callers use this because they
179
166
            self.ui_factory.clear_term()
180
167
 
181
168
 
182
 
# NOTE: This is also deprecated; you should provide a ProgressView instead.
183
 
class _BaseProgressBar(object):
184
 
 
185
 
    def __init__(self,
186
 
                 to_file=None,
187
 
                 show_pct=False,
188
 
                 show_spinner=False,
189
 
                 show_eta=False,
190
 
                 show_bar=True,
191
 
                 show_count=True,
192
 
                 to_messages_file=None,
193
 
                 _stack=None):
194
 
        object.__init__(self)
195
 
        if to_file is None:
196
 
            to_file = sys.stderr
197
 
        if to_messages_file is None:
198
 
            to_messages_file = sys.stdout
199
 
        self.to_file = to_file
200
 
        self.to_messages_file = to_messages_file
201
 
        self.last_msg = None
202
 
        self.last_cnt = None
203
 
        self.last_total = None
204
 
        self.show_pct = show_pct
205
 
        self.show_spinner = show_spinner
206
 
        self.show_eta = show_eta
207
 
        self.show_bar = show_bar
208
 
        self.show_count = show_count
209
 
        self._stack = _stack
210
 
        # seed throttler
211
 
        self.MIN_PAUSE = 0.1 # seconds
212
 
        now = time.time()
213
 
        # starting now
214
 
        self.start_time = now
215
 
        # next update should not throttle
216
 
        self.last_update = now - self.MIN_PAUSE - 1
217
 
 
218
 
    def finished(self):
219
 
        """Return this bar to its progress stack."""
220
 
        self.clear()
221
 
        self._stack.return_pb(self)
222
 
 
223
 
    def note(self, fmt_string, *args, **kwargs):
224
 
        """Record a note without disrupting the progress bar."""
225
 
        self.clear()
226
 
        self.to_messages_file.write(fmt_string % args)
227
 
        self.to_messages_file.write('\n')
228
 
 
229
 
 
230
169
class DummyProgress(object):
231
170
    """Progress-bar standin that does nothing.
232
171
 
248
187
    def clear(self):
249
188
        pass
250
189
 
251
 
    def note(self, fmt_string, *args, **kwargs):
252
 
        """See _BaseProgressBar.note()."""
253
 
 
254
190
    def child_progress(self, **kwargs):
255
191
        return DummyProgress(**kwargs)
256
192