| phillco |
| Restricted Project |
The statefile-not-set case was not tested. Previously the code will make
ui._progbar return None, which means no progress bar.
Also move the docstring to the header so it shows up in hg help -e, and
use modern config registrar to avoid devel warnings.
Added a test
| Lint Skipped |
| Unit Tests Skipped |
Looks good. I sent D1487 to add a test for the HGPLAIN behavior (which works in this change too). I'll land that after this lands so you don't have to merge.
| from __future__ import absolute_import | |||||
| import json | |||||
| import time | |||||
| from mercurial import progress, util | |||||
| """allows users to have JSON progress bar information written to a path | """allows users to have JSON progress bar information written to a path | ||||
| Controlled by the `ui.progressfile` config. Mercurial will overwrite this file | Controlled by the `ui.progressfile` config. Mercurial will overwrite this file | ||||
| each time the progress bar is updated. It is not affected by HGPLAIN since it | each time the progress bar is updated. It is not affected by HGPLAIN since it | ||||
| does not write to stdout. | does not write to stdout. | ||||
| The schema of this file is (JSON): | The schema of this file is (JSON): | ||||
| is left (e.g. "2m30s") | is left (e.g. "2m30s") | ||||
| config example:: | config example:: | ||||
| [progress] | [progress] | ||||
| # Where to write progress information | # Where to write progress information | ||||
| statefile = /some/path/to/file | statefile = /some/path/to/file | ||||
| """ | """ | ||||
| from __future__ import absolute_import | |||||
| import json | |||||
| import time | |||||
| from mercurial import ( | |||||
| progress, | |||||
| registrar, | |||||
| util, | |||||
| ) | |||||
| testedwith = 'ships-with-fb-hgext' | testedwith = 'ships-with-fb-hgext' | ||||
| configtable = {} | |||||
| configitem = registrar.configitem(configtable) | |||||
| configitem('progress', 'statefile', default='') | |||||
| class progbarwithfile(progress.progbar): | class progbarwithfile(progress.progbar): | ||||
| def progress(self, topic, pos, item='', unit='', total=None): | def progress(self, topic, pos, item='', unit='', total=None): | ||||
| super(progbarwithfile, self).progress(topic, pos, item, unit, total) | super(progbarwithfile, self).progress(topic, pos, item, unit, total) | ||||
| self.writeprogress(time.time()) | self.writeprogress(time.time()) | ||||
| def writeprogress(self, now): | def writeprogress(self, now): | ||||
| progressfile = self.ui.config('progress', 'statefile') | progressfile = self.ui.config('progress', 'statefile') | ||||
| if not progressfile: | if not progressfile: | ||||
| def _speed(self, topic, pos, now): | def _speed(self, topic, pos, now): | ||||
| initialpos = self.startvals[topic] | initialpos = self.startvals[topic] | ||||
| delta = pos - initialpos | delta = pos - initialpos | ||||
| elapsed = now - self.starttimes[topic] | elapsed = now - self.starttimes[topic] | ||||
| return int(delta / elapsed) | return int(delta / elapsed) | ||||
| def uisetup(ui): | def uisetup(ui): | ||||
| progbar = progbarwithfile(ui) | |||||
| class progressfileui(ui.__class__): | class progressfileui(ui.__class__): | ||||
| """Redirects _progbar to our version, which always outputs if the config | """Redirects _progbar to our version, which always outputs if the config | ||||
| is set, and calls the default progbar if plain mode is off. | is set, and calls the default progbar if plain mode is off. | ||||
| """ | """ | ||||
| @util.propertycache | @util.propertycache | ||||
| def _progbar(self): | def _progbar(self): | ||||
| if self.config('progress', 'statefile', None): | if self.config('progress', 'statefile'): | ||||
| return progbar | return progbarwithfile(self) | ||||
| else: | |||||
| return super(progressfileui, self)._progbar | |||||
| ui.__class__ = progressfileui | ui.__class__ = progressfileui | ||||
| $ PYTHONPATH=$TESTDIR/../:$PYTHONPATH | $ PYTHONPATH=$TESTDIR/../:$PYTHONPATH | ||||
| $ export PYTHONPATH | $ export PYTHONPATH | ||||
| $ cat > loop.py <<EOF | $ cat > loop.py <<EOF | ||||
| > from mercurial import commands, registrar | > from mercurial import commands, registrar | ||||
| > import time | > import time | ||||
| > | > | ||||
| > from mercurial.extensions import wrapfunction | > from mercurial.extensions import wrapfunction | ||||
| > # This borrows heavily from test-progress.t: | > # This borrows heavily from test-progress.t: | ||||
| > | > | ||||
| > cmdtable = {} | > cmdtable = {} | ||||
| > command = registrar.command(cmdtable) | > command = registrar.command(cmdtable) | ||||
| > | > | ||||
| > def uisetup(ui): | > def uisetup(ui): | ||||
| > def progress(orig, *args, **kwargs): | > def progress(orig, *args, **kwargs): | ||||
| > orig(*args, **kwargs) | > orig(*args, **kwargs) | ||||
| > if ui.config("progress", "statefile") is not None: | > if ui.config("progress", "statefile"): | ||||
| > try: | > try: | ||||
| > with open(ui.config("progress", "statefile"), 'r') as f: | > with open(ui.config("progress", "statefile"), 'r') as f: | ||||
| > print(f.read()) | > print(f.read()) | ||||
| > except IOError as e: | > except IOError as e: | ||||
| > print(e) | > print(e) | ||||
| > wrapfunction(ui, 'progress', progress) | > wrapfunction(ui, 'progress', progress) | ||||
| > | > | ||||
| > class incrementingtime(object): | > class incrementingtime(object): | ||||
| \r (no-eol) (esc) | \r (no-eol) (esc) | ||||
| {"state": {"loop": {"active": true, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": "0 loopnum/sec", "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | {"state": {"loop": {"active": true, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": "0 loopnum/sec", "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | ||||
| {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": null, "estimate_str": null, "item": "nested #0", "pos": 0, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": null, "estimate_str": null, "item": "nested #0", "pos": 0, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | ||||
| {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": 7, "estimate_str": "07s", "item": "nested #1", "pos": 1, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": 7, "estimate_str": "07s", "item": "nested #1", "pos": 1, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | ||||
| {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": 3, "estimate_str": "03s", "item": "nested #2", "pos": 2, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}, "nested": {"active": true, "estimate_sec": 3, "estimate_str": "03s", "item": "nested #2", "pos": 2, "speed_str": "0 nestnum/sec", "topic": "nested", "total": 3, "unit": "nestnum", "units_per_sec": null}}, "topics": ["loop", "nested"]} | ||||
| {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | {"state": {"loop": {"active": false, "estimate_sec": null, "estimate_str": null, "item": "item #0", "pos": 0, "speed_str": null, "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | ||||
| {"state": {"loop": {"active": true, "estimate_sec": 12, "estimate_str": "12s", "item": "item #1", "pos": 1, "speed_str": "0 loopnum/sec", "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | {"state": {"loop": {"active": true, "estimate_sec": 12, "estimate_str": "12s", "item": "item #1", "pos": 1, "speed_str": "0 loopnum/sec", "topic": "loop", "total": 2, "unit": "loopnum", "units_per_sec": null}}, "topics": ["loop"]} | ||||
| {"state": {}, "topics": []} | {"state": {}, "topics": []} | ||||
| Do not hide the progress if statefile is not set | |||||
| $ hg -y loop 5 --config progress.statefile= | |||||
| \r (no-eol) (esc) | |||||
| loop [ ] 0/5\r (no-eol) (esc) | |||||
| loop [=======> ] 1/5 05s\r (no-eol) (esc) | |||||
| loop [================> ] 2/5 04s\r (no-eol) (esc) | |||||
| loop [=========================> ] 3/5 03s\r (no-eol) (esc) | |||||
| loop [==================================> ] 4/5 02s\r (no-eol) (esc) | |||||
| \r (no-eol) (esc) | |||||