This is an archive of the discontinued Mercurial Phabricator instance.

Differential D849

hgweb: query string arguments to control whitespace for annotate
ClosedPublic

Authored by indygreg on Sep 30 2017, 4:08 AM.

Details

Reviewers
simpkins
durin42
Group Reviewers
hg-reviewers
Commits
rHGf6492f482c60: hgweb: query string arguments to control whitespace for annotate
Summary

This feature should hopefully be pretty straightforward. We simply
examine some query string arguments to feed into the diff options.

The function to obtain the diff options has been factored into its
own generic function to facilitate an upcoming change to the HTML
interface and to enable diff settings to be controlled via the same
query string arguments on other web commands.

The test output for "ignoreblanklines" didn't change. I'm not sure
why. Our test coverage for --ignore-blank-lines isn't great and I
can't figure out how to make this diff setting do anything meaningful.
On a very brief examination of the code, it is possible the setting
doesn't work because it is operating at the line level and blank lines
detection needs to examine multiple lines. But I'm not an expert in
this code, so I'm not sure.

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

indygreg created this revision.Sep 30 2017, 4:08 AM
simpkins accepted this revision.Oct 1 2017, 6:22 AM
simpkins added a subscriber: simpkins.

Looks good to me apart from one minor question.

mercurial/hgweb/webutil.py
180–183

Would it be better to use util.parsebool() here?

durin42 added a subscriber: durin42.Oct 1 2017, 6:38 AM
durin42 added inline comments.
mercurial/hgweb/webutil.py
180–183

Yeah, let's do parsebool() here, but that's fine as a follow-up

durin42 accepted this revision.Oct 1 2017, 6:40 AM
This revision is now accepted and ready to land.Oct 1 2017, 6:40 AM
Closed by commit rHGf6492f482c60: hgweb: query string arguments to control whitespace for annotate (authored by indygreg). · Explain WhyOct 1 2017, 6:55 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 2235

mercurial/hgweb/webcommands.py

@webcommand('annotate') @webcommand('annotate')
def annotate(web, req, tmpl): def annotate(web, req, tmpl):
""" """
/annotate/{revision}/{path} /annotate/{revision}/{path}
--------------------------- ---------------------------
Show changeset information for each line in a file. Show changeset information for each line in a file.
The ``ignorews``, ``ignorewsamount``, ``ignorewseol``, and
``ignoreblanklines`` query string arguments have the same meaning as
their ``[annotate]`` config equivalents. A value of ``0`` sets the
whitespace option to false. All other values are true. If not defined,
the server default settings are used.
The ``fileannotate`` template is rendered. The ``fileannotate`` template is rendered.
""" """
fctx = webutil.filectx(web.repo, req) fctx = webutil.filectx(web.repo, req)
f = fctx.path() f = fctx.path()
parity = paritygen(web.stripecount) parity = paritygen(web.stripecount)
ishead = fctx.filerev() in fctx.filelog().headrevs() ishead = fctx.filerev() in fctx.filelog().headrevs()
# parents() is called once per line and several lines likely belong to # parents() is called once per line and several lines likely belong to
yield p yield p
def annotate(**map): def annotate(**map):
if fctx.isbinary(): if fctx.isbinary():
mt = (mimetypes.guess_type(fctx.path())[0] mt = (mimetypes.guess_type(fctx.path())[0]
or 'application/octet-stream') or 'application/octet-stream')
lines = [((fctx.filectx(fctx.filerev()), 1), '(binary:%s)' % mt)] lines = [((fctx.filectx(fctx.filerev()), 1), '(binary:%s)' % mt)]
else: else:
lines = webutil.annotate(fctx, web.repo.ui) lines = webutil.annotate(req, fctx, web.repo.ui)
previousrev = None previousrev = None
blockparitygen = paritygen(1) blockparitygen = paritygen(1)
for lineno, ((f, targetline), l) in enumerate(lines): for lineno, ((f, targetline), l) in enumerate(lines):
rev = f.rev() rev = f.rev()
if rev != previousrev: if rev != previousrev:
blockhead = True blockhead = True
blockparity = next(blockparitygen) blockparity = next(blockparitygen)

mercurial/hgweb/webutil.py

} }
if util.safehasattr(s, 'path'): if util.safehasattr(s, 'path'):
d['file'] = s.path() d['file'] = s.path()
yield d yield d
def __len__(self): def __len__(self):
return len(self.siblings) return len(self.siblings)
def annotate(fctx, ui): def difffeatureopts(req, ui, section):
diffopts = patch.difffeatureopts(ui, untrusted=True, diffopts = patch.difffeatureopts(ui, untrusted=True,
section='annotate', whitespace=True) section=section, whitespace=True)
for k in ('ignorews', 'ignorewsamount', 'ignorewseol', 'ignoreblanklines'):
v = req.form.get(k, [None])[0]
if v is not None:
try:
v = bool(int(v))
except ValueError:
v = True
simpkinsUnsubmitted
Not Done

Would it be better to use util.parsebool() here?

simpkins: Would it be better to use `util.parsebool()` here?
durin42Unsubmitted
Not Done

Yeah, let's do parsebool() here, but that's fine as a follow-up

durin42: Yeah, let's do parsebool() here, but that's fine as a follow-up
setattr(diffopts, k, v)
return diffopts
def annotate(req, fctx, ui):
diffopts = difffeatureopts(req, ui, 'annotate')
return fctx.annotate(follow=True, linenumber=True, diffopts=diffopts) return fctx.annotate(follow=True, linenumber=True, diffopts=diffopts)
def parents(ctx, hide=None): def parents(ctx, hide=None):
if isinstance(ctx, context.basefilectx): if isinstance(ctx, context.basefilectx):
introrev = ctx.introrev() introrev = ctx.introrev()
if ctx.changectx().rev() != introrev: if ctx.changectx().rev() != introrev:
return _siblings([ctx.repo()[introrev]], hide) return _siblings([ctx.repo()[introrev]], hide)
return _siblings(ctx.parents(), hide) return _siblings(ctx.parents(), hide)

tests/test-hgweb-annotate-whitespace.t

"desc": "commit 6 (add another blank line between line 0 and 1)", "desc": "commit 6 (add another blank line between line 0 and 1)",
"node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5", "node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5",
"parents": [ "parents": [
"400ef1d404706cfb48afd2b78ce6addf641ced25" "400ef1d404706cfb48afd2b78ce6addf641ced25"
], ],
"permissions": "" "permissions": ""
} }
ignorews=1 query string argument enables whitespace skipping (not implemented) ignorews=1 query string argument enables whitespace skipping
$ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorews=1' $ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorews=1'
200 Script output follows 200 Script output follows
{ {
"abspath": "foo", "abspath": "foo",
"annotate": [ "annotate": [
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 4 (intra whitespace on line 0)", "desc": "commit 0",
"line": "line 0\n", "line": "line 0\n",
"lineno": 1, "lineno": 1,
"node": "08adbe269f24cf22d975eadeec16790c5b22f558", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 1 "targetline": 1
}, },
{ {
"abspath": "foo", "abspath": "foo",
0.0, 0.0,
0 0
], ],
"targetline": 2 "targetline": 2
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 2 (leading whitespace on line 2)", "desc": "commit 0",
"line": " line 2\n", "line": " line 2\n",
"lineno": 5, "lineno": 5,
"node": "6bdb694e7b8cebb68d5b6b27b4bcc2a49d62c602", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 3 "targetline": 3
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 3 (trailing whitespace on line 3)", "desc": "commit 0",
"line": "line 3 \n", "line": "line 3 \n",
"lineno": 6, "lineno": 6,
"node": "dcb62cfbfc9b3ab995a5cbbaff6e1971c3e4f865", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 4 "targetline": 4
} }
], ],
"author": "test", "author": "test",
"children": [], "children": [],
"date": [ "date": [
0.0, 0.0,
0 0
], ],
"desc": "commit 6 (add another blank line between line 0 and 1)", "desc": "commit 6 (add another blank line between line 0 and 1)",
"node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5", "node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5",
"parents": [ "parents": [
"400ef1d404706cfb48afd2b78ce6addf641ced25" "400ef1d404706cfb48afd2b78ce6addf641ced25"
], ],
"permissions": "" "permissions": ""
} }
ignorews=0 query string argument disables when config defaults to enabled (not implemented) ignorews=0 query string argument disables when config defaults to enabled
$ get-with-headers.py --json $LOCALIP:$HGPORT1 'json-annotate/9d1b2c7db017/foo?ignorews=0' $ get-with-headers.py --json $LOCALIP:$HGPORT1 'json-annotate/9d1b2c7db017/foo?ignorews=0'
200 Script output follows 200 Script output follows
{ {
"abspath": "foo", "abspath": "foo",
"annotate": [ "annotate": [
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 0", "desc": "commit 4 (intra whitespace on line 0)",
"line": "line 0\n", "line": "line 0\n",
"lineno": 1, "lineno": 1,
"node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc", "node": "08adbe269f24cf22d975eadeec16790c5b22f558",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 1 "targetline": 1
}, },
{ {
"abspath": "foo", "abspath": "foo",
0.0, 0.0,
0 0
], ],
"targetline": 2 "targetline": 2
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 0", "desc": "commit 2 (leading whitespace on line 2)",
"line": " line 2\n", "line": " line 2\n",
"lineno": 5, "lineno": 5,
"node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc", "node": "6bdb694e7b8cebb68d5b6b27b4bcc2a49d62c602",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 3 "targetline": 3
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 0", "desc": "commit 3 (trailing whitespace on line 3)",
"line": "line 3 \n", "line": "line 3 \n",
"lineno": 6, "lineno": 6,
"node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc", "node": "dcb62cfbfc9b3ab995a5cbbaff6e1971c3e4f865",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 4 "targetline": 4
} }
], ],
"author": "test", "author": "test",
"children": [], "children": [],
"date": [ "date": [
0.0, 0.0,
0 0
], ],
"desc": "commit 6 (add another blank line between line 0 and 1)", "desc": "commit 6 (add another blank line between line 0 and 1)",
"node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5", "node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5",
"parents": [ "parents": [
"400ef1d404706cfb48afd2b78ce6addf641ced25" "400ef1d404706cfb48afd2b78ce6addf641ced25"
], ],
"permissions": "" "permissions": ""
} }
ignorewsamount=1 query string enables whitespace amount skipping (not implemented) ignorewsamount=1 query string enables whitespace amount skipping
$ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorewsamount=1' $ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorewsamount=1'
200 Script output follows 200 Script output follows
{ {
"abspath": "foo", "abspath": "foo",
"annotate": [ "annotate": [
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 4 (intra whitespace on line 0)", "desc": "commit 0",
"line": "line 0\n", "line": "line 0\n",
"lineno": 1, "lineno": 1,
"node": "08adbe269f24cf22d975eadeec16790c5b22f558", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 1 "targetline": 1
}, },
{ {
"abspath": "foo", "abspath": "foo",
0.0, 0.0,
0 0
], ],
"targetline": 3 "targetline": 3
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 3 (trailing whitespace on line 3)", "desc": "commit 0",
"line": "line 3 \n", "line": "line 3 \n",
"lineno": 6, "lineno": 6,
"node": "dcb62cfbfc9b3ab995a5cbbaff6e1971c3e4f865", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 4 "targetline": 4
} }
], ],
"author": "test", "author": "test",
"children": [], "children": [],
"date": [ "date": [
0.0, 0.0,
0 0
], ],
"desc": "commit 6 (add another blank line between line 0 and 1)", "desc": "commit 6 (add another blank line between line 0 and 1)",
"node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5", "node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5",
"parents": [ "parents": [
"400ef1d404706cfb48afd2b78ce6addf641ced25" "400ef1d404706cfb48afd2b78ce6addf641ced25"
], ],
"permissions": "" "permissions": ""
} }
ignorewseol=1 query string enables whitespace end of line skipping (not implemented) ignorewseol=1 query string enables whitespace end of line skipping
$ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorewseol=1' $ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignorewseol=1'
200 Script output follows 200 Script output follows
{ {
"abspath": "foo", "abspath": "foo",
"annotate": [ "annotate": [
{ {
0.0, 0.0,
0 0
], ],
"targetline": 3 "targetline": 3
}, },
{ {
"abspath": "foo", "abspath": "foo",
"author": "test", "author": "test",
"desc": "commit 3 (trailing whitespace on line 3)", "desc": "commit 0",
"line": "line 3 \n", "line": "line 3 \n",
"lineno": 6, "lineno": 6,
"node": "dcb62cfbfc9b3ab995a5cbbaff6e1971c3e4f865", "node": "b9c578134d72b3a9d26afde8ddd76c0a93c5adbc",
"revdate": [ "revdate": [
0.0, 0.0,
0 0
], ],
"targetline": 4 "targetline": 4
} }
], ],
"author": "test", "author": "test",
"children": [], "children": [],
"date": [ "date": [
0.0, 0.0,
0 0
], ],
"desc": "commit 6 (add another blank line between line 0 and 1)", "desc": "commit 6 (add another blank line between line 0 and 1)",
"node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5", "node": "9d1b2c7db0175870a950f8c48c9c4ead1058f2c5",
"parents": [ "parents": [
"400ef1d404706cfb48afd2b78ce6addf641ced25" "400ef1d404706cfb48afd2b78ce6addf641ced25"
], ],
"permissions": "" "permissions": ""
} }
ignoreblanklines=1 query string enables whitespace blank line skipping (not implemented) ignoreblanklines=1 query string enables whitespace blank line skipping
$ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignoreblanklines=1' $ get-with-headers.py --json $LOCALIP:$HGPORT 'json-annotate/9d1b2c7db017/foo?ignoreblanklines=1'
200 Script output follows 200 Script output follows
{ {
"abspath": "foo", "abspath": "foo",
"annotate": [ "annotate": [
{ {