( )⚙ D6843 ui: option to preserve the progress bar

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6843

ui: option to preserve the progress bar
ClosedPublic

Authored by joerg.sonnenberger on Sep 11 2019, 9:41 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHG82879e06c926: ui: option to preserve the progress bar
rHGcf25e525b7ae: ui: option to preserve the progress bar
Summary

Some interface like the fast-import format of git are meant for pipe
processing. It can be still desirable to have progress bars in this
case, but clearing the bar after each output operation is not desirable.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

durin42 added a subscriber: durin42.Sep 23 2019, 1:06 PM

Shouldn't we print a newline to preserve the progress bar? I guess I'm not following the logic.

joerg.sonnenberger added a comment.Sep 23 2019, 6:22 PM

The goal here is to allow something like "hg fast-export | git fast-import" to show a proper progress bar.
At the moment every write via ui.write and friends will hide the progress bar and re-enable it, even when stdout doesn't affect the terminal state. This would also make sense for operations like "hg diff", e.g. when writing a large/complicated diff to a file.

indygreg requested changes to this revision.Oct 5 2019, 3:39 PM
indygreg added a subscriber: indygreg.

I think this is a useful feature. I've wanted this in automated environment so the last state from the progress bar is preserved, for example.

But I agree with Augie that I believe we need to print a newline if we're keeping the progress bar because at the point we print the progress bar, the cursor is at the end of the progress bar.

Also, the printing of the line needs to be abstracted and performed in the progress bar implementation. I would check the config option in _progclear() and pass the value to clear() and it can determine if it needs to print a \n or what.

This revision now requires changes to proceed.Oct 5 2019, 3:39 PM
joerg.sonnenberger added a commit: rHGcf25e525b7ae: ui: option to preserve the progress bar.Oct 16 2019, 5:04 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGcf25e525b7ae: ui: option to preserve the progress bar (authored by joerg.sonnenberger). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/ui.py (8 lines)

Diff 16520

mercurial/ui.py

if self._buffers: if self._buffers:
label = opts.get(r'label', '') label = opts.get(r'label', '')
if label and self._bufferapplylabels: if label and self._bufferapplylabels:
self._buffers[-1].extend(self.label(a, label) for a in args) self._buffers[-1].extend(self.label(a, label) for a in args)
else: else:
self._buffers[-1].extend(args) self._buffers[-1].extend(args)
return return
# inliend _writenobuf() for speed # inlined _writenobuf() for speed
if not opts.get(r'keepprogressbar', False):
self._progclear() self._progclear()
msg = b''.join(args) msg = b''.join(args)
# opencode timeblockedsection because this is a critical path # opencode timeblockedsection because this is a critical path
starttime = util.timer() starttime = util.timer()
try: try:
if self._colormode == 'win32': if self._colormode == 'win32':
# windows color printing is its own can of crab, defer to # windows color printing is its own can of crab, defer to
# the color module and that is it. # the color module and that is it.
self._buffers[-1].extend(self.label(a, label) for a in args) self._buffers[-1].extend(self.label(a, label) for a in args)
else: else:
self._buffers[-1].extend(args) self._buffers[-1].extend(args)
else: else:
self._writenobuf(dest, *args, **opts) self._writenobuf(dest, *args, **opts)
def _writenobuf(self, dest, *args, **opts): def _writenobuf(self, dest, *args, **opts):
# update write() as well if you touch this code # update write() as well if you touch this code
if not opts.get(r'keepprogressbar', False):
self._progclear() self._progclear()
msg = b''.join(args) msg = b''.join(args)
# opencode timeblockedsection because this is a critical path # opencode timeblockedsection because this is a critical path
starttime = util.timer() starttime = util.timer()
try: try:
if dest is self._ferr and not getattr(self._fout, 'closed', False): if dest is self._ferr and not getattr(self._fout, 'closed', False):
self._fout.flush() self._fout.flush()
if getattr(dest, 'structured', False): if getattr(dest, 'structured', False):