This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5531

progress: deprecate ui.progress()
ClosedPublic

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

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG44914de4e915: progress: deprecate ui.progress()
Summary

It is now just a weird wrapper for ui.makeprogress().

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.

Event Timeline

martinvonz created this revision.Jan 8 2019, 1:10 PM
martinvonz updated this revision to Diff 13082.Jan 8 2019, 1:28 PM
lothiraldan added a subscriber: lothiraldan.Jan 9 2019, 9:34 AM

The new makeprogress API is more clean but more low-level, could we extend the deprecation warning until the 5.1 release to gives more time to extension authors to update?

martinvonz updated this revision to Diff 13095.Jan 9 2019, 11:15 AM
martinvonz added a comment.Jan 9 2019, 11:16 AM
In D5531#81827, @lothiraldan wrote:

The new makeprogress API is more clean but more low-level, could we extend the deprecation warning until the 5.1 release to gives more time to extension authors to update?

I'm not sure I agree with the first part, but I don't mind extending the deprecation until 5.1. Done.

pulkit accepted this revision.Jan 16 2019, 2:02 AM
martinvonz added a comment.Jan 16 2019, 2:07 AM

Btw, I've sent a patch for evolve: https://bitbucket.org/octobus/evolve-devel/commits/3e07c1eea61d2fe6bc80d75d0062d34e53b40577. Other extension authors should be able to copy that.

pulkit added a comment.Jan 16 2019, 2:42 AM
In D5531#82608, @martinvonz wrote:

Btw, I've sent a patch for evolve: https://bitbucket.org/octobus/evolve-devel/commits/3e07c1eea61d2fe6bc80d75d0062d34e53b40577. Other extension authors should be able to copy that.

Macro goodjob:

Closed by commit rHG44914de4e915: progress: deprecate ui.progress() (authored by martinvonz). · Explain WhyJan 16 2019, 2:49 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/ui.py (2 lines)

Diff 13235

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.
''' '''
self.deprecwarn("use ui.makeprogress() instead of ui.progress()",
"5.1")
progress = self.makeprogress(topic, unit, total) progress = self.makeprogress(topic, unit, total)
if pos is not None: if pos is not None:
progress.update(pos, item=item) progress.update(pos, item=item)
else: else:
progress.complete() progress.complete()
def makeprogress(self, topic, unit="", total=None): def makeprogress(self, topic, unit="", total=None):
"""Create a progress helper for the specified topic""" """Create a progress helper for the specified topic"""