This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5527

progress: write ui.progress() in terms of ui.makeprogress()
ClosedPublic

Authored by martinvonz on Jan 8 2019, 1:10 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG8cf92ca92bfe: progress: write ui.progress() in terms of ui.makeprogress()
Summary

I think ui.makeprogress() should be the preferred interface and we
should deprecate ui.progress(). All in-core callers already use
ui.makeprogress(). Moving the logic to the scmutil.progress() will let
us make further improvements.

This seems to have sped up hg perfprogress from 1.92 s to 1.85 s,
perhaps because we now skip the indirection of updating the progress
bar via ui.progress().

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathPackages
Mmercurial/scmutil.py (41 lines)
Mmercurial/ui.py (36 lines)

Diff 13096

mercurial/scmutil.py

self.total = total self.total = total
self.pos = pos self.pos = pos
self._print(item) self._print(item)
def increment(self, step=1, item="", total=None): def increment(self, step=1, item="", total=None):
self.update(self.pos + step, item, total) self.update(self.pos + step, item, total)
def complete(self): def complete(self):
self.ui.progress(self.topic, None) self.pos = None
self.unit = ""
self.total = None
self._print("")
def _print(self, item): def _print(self, item):
self.ui.progress(self.topic, self.pos, item, self.unit, if getattr(self.ui._fmsgerr, 'structured', False):
self.total) # channel for machine-readable output with metadata, just send
# raw information
# TODO: consider porting some useful information (e.g. estimated
# time) from progbar. we might want to support update delay to
# reduce the cost of transferring progress messages.
self.ui._fmsgerr.write(None, type=b'progress', topic=self.topic,
pos=self.pos, item=item, unit=self.unit,
total=self.total)
elif self.ui._progbar is not None:
self.ui._progbar.progress(self.topic, self.pos, item=item,
unit=self.unit, total=self.total)
# Looking up progress.debug in tight loops is expensive. The value
# is cached on the progbar object and we can avoid the lookup in
# the common case where a progbar is active.
if self.pos is None or not self.ui._progbar.debug:
return
# Keep this logic in sync with above.
if self.pos is None or not self.ui.configbool('progress', 'debug'):
return
if self.unit:
unit = ' ' + self.unit
if item:
item = ' ' + item
if self.total:
pct = 100.0 * self.pos / self.total
self.ui.debug('%s:%s %d/%d%s (%4.2f%%)\n'
% (self.topic, item, self.pos, self.total, unit, pct))
else:
self.ui.debug('%s:%s %d%s\n' % (self.topic, item, self.pos, unit))
def gdinitconfig(ui): def gdinitconfig(ui):
"""helper function to know if a repo should be created as general delta """helper function to know if a repo should be created as general delta
""" """
# experimental config: format.generaldelta # experimental config: format.generaldelta
return (ui.configbool('format', 'generaldelta') return (ui.configbool('format', 'generaldelta')
or ui.configbool('format', 'usegeneraldelta')) or ui.configbool('format', 'usegeneraldelta'))

mercurial/ui.py

revision, bytes, etc.), unit is a corresponding unit label, revision, bytes, etc.), unit is a corresponding unit label,
and total is the highest expected pos. and total is the highest expected pos.
Multiple nested topics may be active at a time. Multiple nested topics may be active at a time.
All topics should be marked closed by setting pos to None at All topics should be marked closed by setting pos to None at
termination. termination.
''' '''
if getattr(self._fmsgerr, 'structured', False): progress = self.makeprogress(topic, unit, total)
# channel for machine-readable output with metadata, just send if pos is not None:
# raw information progress.update(pos, item=item)
# TODO: consider porting some useful information (e.g. estimated
# time) from progbar. we might want to support update delay to
# reduce the cost of transferring progress messages.
self._fmsgerr.write(None, type=b'progress', topic=topic, pos=pos,
item=item, unit=unit, total=total)
elif self._progbar is not None:
self._progbar.progress(topic, pos, item=item, unit=unit,
total=total)
# Looking up progress.debug in tight loops is expensive. The value
# is cached on the progbar object and we can avoid the lookup in
# the common case where a progbar is active.
if pos is None or not self._progbar.debug:
return
# Keep this logic in sync with above.
if pos is None or not self.configbool('progress', 'debug'):
return
if unit:
unit = ' ' + unit
if item:
item = ' ' + item
if total:
pct = 100.0 * pos / total
self.debug('%s:%s %d/%d%s (%4.2f%%)\n'
% (topic, item, pos, total, unit, pct))
else: else:
self.debug('%s:%s %d%s\n' % (topic, item, pos, unit)) progress.complete()
def makeprogress(self, topic, unit="", total=None): def makeprogress(self, topic, unit="", total=None):
'''exists only so low-level modules won't need to import scmutil''' '''exists only so low-level modules won't need to import scmutil'''
return scmutil.progress(self, topic, unit, total) return scmutil.progress(self, topic, unit, total)
def getlogger(self, name): def getlogger(self, name):
"""Returns a logger of the given name; or None if not registered""" """Returns a logger of the given name; or None if not registered"""
return self._loggers.get(name) return self._loggers.get(name)