Mercurial > public > mercurial-scm > hg-stable
diff mercurial/scmutil.py @ 38351:bec1212eceaa
progress: create helper class for incrementing progress
When using ui.progress(), there's a clear pattern that is followed:
* Pass the same topic and unit
* Usually pass the same total
* Call with pos=None to close the progress bar
* Often keep track of the current position and increment it
This patch creates a simple helper class for this. I'll probably make
it implement the context manager protocol later (calling update(None)
on __exit__).
Progress is used in low-level modules like changegroup, so I also
exposed it via a method on the ui object. Perhaps the class itself
should also live in ui.py?
This patch also makes merge.oy use it to show that it works.
Differential Revision: https://phab.mercurial-scm.org/D3765
| author | Martin von Zweigbergk <martinvonz@google.com> |
|---|---|
| date | Fri, 15 Jun 2018 22:37:01 -0700 |
| parents | cf59de802883 |
| children | ef692614e601 |
line wrap: on
line diff
--- a/mercurial/scmutil.py Sun Jun 17 18:01:49 2018 +0900 +++ b/mercurial/scmutil.py Fri Jun 15 22:37:01 2018 -0700 @@ -1285,6 +1285,27 @@ return _locksub(repo, repo.currentwlock(), 'HG_WLOCK_LOCKER', cmd, *args, **kwargs) +class progress(object): + def __init__(self, ui, topic, unit="", total=None): + self.ui = ui + self.pos = 0 + self.topic = topic + self.unit = unit + self.total = total + + def update(self, pos, item="", total=None): + if total: + self.total = total + self.pos = pos + self._print(item) + + def increment(self, step=1, item="", total=None): + self.update(self.pos + step, item, total) + + def _print(self, item): + self.ui.progress(self.topic, self.pos, item, self.unit, + self.total) + def gdinitconfig(ui): """helper function to know if a repo should be created as general delta """