( )⚙ D7595 status: outputting structured unfinished-operation information

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7595

status: outputting structured unfinished-operation information
ClosedPublic

Authored by rdamazio on Dec 10 2019, 1:39 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGaac921f54554: status: outputting structured unfinished-operation information
Summary

This adds a new item in the json/template output for morestatus and added item
types to all entries.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

rdamazio created this revision.Dec 10 2019, 1:39 AM
pulkit added subscribers: yuja, pulkit.Dec 10 2019, 8:19 AM
pulkit added inline comments.
mercurial/configitems.py
247

IMO the whole morestatus functionality is already behind a config option, so lets not have a config option just for that.

But I am not sure whether this change is a BC or not. I believe @yuja might have thoughts here.

rdamazio added inline comments.Dec 10 2019, 1:07 PM
mercurial/configitems.py
247

I'm fine with removing the config option, but will let yuja reply first.
About being BC or not - it depends on how people are parsing the JSON output :) If they're either turning off morestatus for -Tjson calls, or they're ok with an entry with no path, then it should work, but I won't be surprised if it breaks some callers.

rdamazio updated this revision to Diff 18588.Dec 10 2019, 1:15 PM
durin42 added a subscriber: durin42.Dec 11 2019, 12:35 PM
durin42 added inline comments.
mercurial/configitems.py
247

I also support not adding a second config option and just adding content that's from the morestatus config.

rdamazio marked an inline comment as done.Dec 12 2019, 1:38 AM
rdamazio edited the summary of this revision. (Show Details)
rdamazio updated this revision to Diff 18625.
rdamazio marked an inline comment as done.Dec 12 2019, 1:39 AM
pulkit accepted this revision.Dec 12 2019, 7:24 AM
This revision is now accepted and ready to land.Dec 12 2019, 7:24 AM
pulkit added a comment.Dec 12 2019, 7:27 AM

Applying this on top of D7605 failed. So unfortunately you have to rebase again and resend. Also, I think you are pip install black away from preventing such conflicts.

rdamazio updated this revision to Diff 18638.Dec 12 2019, 12:28 PM
martinvonz added a subscriber: martinvonz.Dec 12 2019, 12:33 PM
In D7595#111986, @pulkit wrote:

Applying this on top of D7605 failed. So unfortunately you have to rebase again and resend. Also, I think you are pip install black away from preventing such conflicts.

I'll queue this based on Pulkit's approval.

Revision Contents
Changeset List

Diff 18588

mercurial/cmdutil.py

@attr.s(frozen=True) @attr.s(frozen=True)
class morestatus(object): class morestatus(object):
reporoot = attr.ib() reporoot = attr.ib()
unfinishedop = attr.ib() unfinishedop = attr.ib()
unfinishedmsg = attr.ib() unfinishedmsg = attr.ib()
inmergestate = attr.ib() inmergestate = attr.ib()
unresolvedpaths = attr.ib() unresolvedpaths = attr.ib()
adddataitem = attr.ib()
_label = b'status.morestatus' _label = b'status.morestatus'
def formatfile(self, path, fm): def formatfile(self, path, fm):
if self.inmergestate and path in self.unresolvedpaths: if self.inmergestate and path in self.unresolvedpaths:
fm.data(unresolved=True) fm.data(unresolved=True)
def formatfooter(self, fm): def formatfooter(self, fm):
statemsg = _(b'The repository is in an unfinished *%s* state.' statemsg = _(b'The repository is in an unfinished *%s* state.'
) % self.unfinishedop ) % self.unfinishedop
fm.plain(b'%s\n' % _commentlines(statemsg), label=self._label) fm.plain(b'%s\n' % _commentlines(statemsg), label=self._label)
if self.adddataitem:
fm.startitem()
fm.data(itemtype=b'morestatus', unfinished=self.unfinishedop,
unfinishedmsg=self.unfinishedmsg)
self._formatconflicts(fm) self._formatconflicts(fm)
if self.unfinishedmsg: if self.unfinishedmsg:
fm.plain(b'%s\n' % _commentlines(self.unfinishedmsg), fm.plain(b'%s\n' % _commentlines(self.unfinishedmsg),
label=self._label) label=self._label)
def _formatconflicts(self, fm): def _formatconflicts(self, fm):
if not self.inmergestate: if not self.inmergestate:
return return
if not statetuple: if not statetuple:
return None return None
unfinishedop, unfinishedmsg = statetuple unfinishedop, unfinishedmsg = statetuple
mergestate = mergemod.mergestate.read(repo) mergestate = mergemod.mergestate.read(repo)
unresolved = None unresolved = None
if mergestate.active(): if mergestate.active():
unresolved = sorted(mergestate.unresolved()) unresolved = sorted(mergestate.unresolved())
dataitem = repo.ui.config(b'commands', b'status.morestatus-item')
return morestatus(repo.root, unfinishedop, unfinishedmsg, return morestatus(repo.root, unfinishedop, unfinishedmsg,
unresolved is not None, unresolved) unresolved is not None, unresolved, dataitem)
def findpossible(cmd, table, strict=False): def findpossible(cmd, table, strict=False):
""" """
Return cmd -> (aliases, command table entry) Return cmd -> (aliases, command table entry)
for each matching command. for each matching command.
Return debug commands (or their aliases) only if no normal command matches. Return debug commands (or their aliases) only if no normal command matches.
""" """

mercurial/commands.py

showchar = not opts.get(b'no_status') showchar = not opts.get(b'no_status')
for state, char, files in changestates: for state, char, files in changestates:
if state in show: if state in show:
label = b'status.' + state label = b'status.' + state
for f in files: for f in files:
fm.startitem() fm.startitem()
fm.context(ctx=ctx2) fm.context(ctx=ctx2)
fm.data(path=f) fm.data(itemtype=b'file', path=f)
fm.condwrite(showchar, b'status', b'%s ', char, label=label) fm.condwrite(showchar, b'status', b'%s ', char, label=label)
fm.plain(fmt % uipathfn(f), label=label) fm.plain(fmt % uipathfn(f), label=label)
if f in copy: if f in copy:
fm.data(source=copy[f]) fm.data(source=copy[f])
fm.plain( fm.plain(
(b' %s' + end) % uipathfn(copy[f]), (b' %s' + end) % uipathfn(copy[f]),
label=b'status.copied', label=b'status.copied',
) )

mercurial/configitems.py

coreconfigitem( coreconfigitem(
b'commands', b'resolve.mark-check', default=b'none', b'commands', b'resolve.mark-check', default=b'none',
) )
_registerdiffopts(section=b'commands', configprefix=b'revert.interactive.') _registerdiffopts(section=b'commands', configprefix=b'revert.interactive.')
coreconfigitem( coreconfigitem(
b'commands', b'show.aliasprefix', default=list, b'commands', b'show.aliasprefix', default=list,
) )
coreconfigitem( coreconfigitem(
b'commands', b'status.morestatus-item', default=False,
pulkitUnsubmitted
Done

IMO the whole morestatus functionality is already behind a config option, so lets not have a config option just for that.

But I am not sure whether this change is a BC or not. I believe @yuja might have thoughts here.

pulkit: IMO the whole morestatus functionality is already behind a config option, so lets not have a…
rdamazioAuthorUnsubmitted
Done

I'm fine with removing the config option, but will let yuja reply first.
About being BC or not - it depends on how people are parsing the JSON output :) If they're either turning off morestatus for -Tjson calls, or they're ok with an entry with no path, then it should work, but I won't be surprised if it breaks some callers.

rdamazio: I'm fine with removing the config option, but will let yuja reply first. About being BC or not…
durin42Unsubmitted
Done

I also support not adding a second config option and just adding content that's from the morestatus config.

durin42: I also support not adding a second config option and just adding content that's from the…
)
coreconfigitem(
b'commands', b'status.relative', default=False, b'commands', b'status.relative', default=False,
) )
coreconfigitem( coreconfigitem(
b'commands', b'status.skipstates', default=[], experimental=True, b'commands', b'status.skipstates', default=[], experimental=True,
) )
coreconfigitem( coreconfigitem(
b'commands', b'status.terse', default=b'', b'commands', b'status.terse', default=b'',
) )

tests/test-conflict.t

# To mark files as resolved: hg resolve --mark FILE # To mark files as resolved: hg resolve --mark FILE
# To continue: hg commit # To continue: hg commit
# To abort: hg merge --abort # To abort: hg merge --abort
$ hg status -Tjson $ hg status -Tjson
[ [
{ {
"itemtype": "file",
"path": "a", "path": "a",
"status": "M", "status": "M",
"unresolved": true "unresolved": true
}, },
{ {
"itemtype": "file",
"path": "a.orig", "path": "a.orig",
"status": "?" "status": "?"
} }
] ]
$ hg status -Tjson --config commands.status.morestatus-item=1
[
{
"itemtype": "file",
"path": "a",
"status": "M",
"unresolved": true
},
{
"itemtype": "file",
"path": "a.orig",
"status": "?"
},
{
"itemtype": "morestatus",
"unfinished": "merge",
"unfinishedmsg": "To continue: hg commit\nTo abort: hg merge --abort"
}
]
$ cat a $ cat a
Small Mathematical Series. Small Mathematical Series.
1 1
2 2
3 3
<<<<<<< working copy: 618808747361 - test: branch2 <<<<<<< working copy: 618808747361 - test: branch2
6 6
8 8

tests/test-status.t

? unknown ffff ? unknown ffff
I ignored ffff I ignored ffff
C .hgignore ffff C .hgignore ffff
C modified ffff C modified ffff
$ hg status -A -Tjson $ hg status -A -Tjson
[ [
{ {
"itemtype": "file",
"path": "added", "path": "added",
"status": "A" "status": "A"
}, },
{ {
"itemtype": "file",
"path": "copied", "path": "copied",
"source": "modified", "source": "modified",
"status": "A" "status": "A"
}, },
{ {
"itemtype": "file",
"path": "removed", "path": "removed",
"status": "R" "status": "R"
}, },
{ {
"itemtype": "file",
"path": "deleted", "path": "deleted",
"status": "!" "status": "!"
}, },
{ {
"itemtype": "file",
"path": "unknown", "path": "unknown",
"status": "?" "status": "?"
}, },
{ {
"itemtype": "file",
"path": "ignored", "path": "ignored",
"status": "I" "status": "I"
}, },
{ {
"itemtype": "file",
"path": ".hgignore", "path": ".hgignore",
"status": "C" "status": "C"
}, },
{ {
"itemtype": "file",
"path": "modified", "path": "modified",
"status": "C" "status": "C"
} }
] ]
$ hg status -A -Tpickle > pickle $ hg status -A -Tpickle > pickle
>>> from __future__ import print_function >>> from __future__ import print_function
>>> from mercurial import util >>> from mercurial import util
$ hg status -A --rev 1 1/2/3 $ hg status -A --rev 1 1/2/3
R 1/2/3/4/5/b.txt R 1/2/3/4/5/b.txt
$ hg status -A --rev 1 1 $ hg status -A --rev 1 1
R 1/2/3/4/5/b.txt R 1/2/3/4/5/b.txt
$ hg status --config ui.formatdebug=True --rev 1 1 $ hg status --config ui.formatdebug=True --rev 1 1
status = [ status = [
{ {
'itemtype': 'file',
'path': '1/2/3/4/5/b.txt', 'path': '1/2/3/4/5/b.txt',
'status': 'R' 'status': 'R'
}, },
] ]
#if windows #if windows
$ hg --config ui.slash=false status -A --rev 1 1 $ hg --config ui.slash=false status -A --rev 1 1
R 1\2\3\4\5\b.txt R 1\2\3\4\5\b.txt