This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7432

templates: make {indent("", " ")} be empty
ClosedPublic

Authored by martinvonz on Nov 15 2019, 1:18 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGfa246ada356b: templates: make {indent("", " ")} be empty
Summary

indent() is documented to indent all non-empty lines, but it made an
exception for the first line, which always got indented. I also made
indent() not indent the first line even if an indent override was
given for the first line. I think that is what one would usually want.

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.Nov 15 2019, 1:18 PM
pulkit accepted this revision.Nov 18 2019, 11:15 AM
This revision is now accepted and ready to land.Nov 18 2019, 11:15 AM
martinvonz added a commit: rHGfa246ada356b: templates: make {indent("", " ")} be empty.Nov 18 2019, 11:51 AM
Closed by commit rHGfa246ada356b: templates: make {indent("", " ")} be empty (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 18218

mercurial/templatefilters.py

def isodatesec(text): def isodatesec(text):
"""Date. Returns the date in ISO 8601 format, including """Date. Returns the date in ISO 8601 format, including
seconds: "2009-08-18 13:00:13 +0200". See also the rfc3339date seconds: "2009-08-18 13:00:13 +0200". See also the rfc3339date
filter. filter.
""" """
return dateutil.datestr(text, b'%Y-%m-%d %H:%M:%S %1%2') return dateutil.datestr(text, b'%Y-%m-%d %H:%M:%S %1%2')
def indent(text, prefix): def indent(text, prefix, firstline=b''):
'''indent each non-empty line of text after first with prefix.''' '''indent each non-empty line of text after first with prefix.'''
lines = text.splitlines() lines = text.splitlines()
num_lines = len(lines) num_lines = len(lines)
endswithnewline = text[-1:] == b'\n' endswithnewline = text[-1:] == b'\n'
def indenter(): def indenter():
for i in pycompat.xrange(num_lines): for i in pycompat.xrange(num_lines):
l = lines[i] l = lines[i]
if i and l.strip(): if l.strip():
yield prefix yield prefix if i else firstline
yield l yield l
if i < num_lines - 1 or endswithnewline: if i < num_lines - 1 or endswithnewline:
yield b'\n' yield b'\n'
return b"".join(indenter()) return b"".join(indenter())
@templatefilter(b'json') @templatefilter(b'json')

mercurial/templatefuncs.py

if present.""" if present."""
if not (2 <= len(args) <= 3): if not (2 <= len(args) <= 3):
# i18n: "indent" is a keyword # i18n: "indent" is a keyword
raise error.ParseError(_(b"indent() expects two or three arguments")) raise error.ParseError(_(b"indent() expects two or three arguments"))
text = evalstring(context, mapping, args[0]) text = evalstring(context, mapping, args[0])
indent = evalstring(context, mapping, args[1]) indent = evalstring(context, mapping, args[1])
firstline = indent
if len(args) == 3: if len(args) == 3:
firstline = evalstring(context, mapping, args[2]) firstline = evalstring(context, mapping, args[2])
else:
firstline = indent
# the indent function doesn't indent the first line, so we do it here return templatefilters.indent(text, indent, firstline=firstline)
return templatefilters.indent(firstline + text, indent)
@templatefunc(b'get(dict, key)') @templatefunc(b'get(dict, key)')
def get(context, mapping, args): def get(context, mapping, args):
"""Get an attribute/key from an object. Some keywords """Get an attribute/key from an object. Some keywords
are complex types. This function allows you to obtain the value of an are complex types. This function allows you to obtain the value of an
attribute on these types.""" attribute on these types."""
if len(args) != 2: if len(args) != 2:

relnotes/next

== New Features == == New Features ==
== New Experimental Features == == New Experimental Features ==
== Bug Fixes == == Bug Fixes ==
* The `indent()` template function was documented to not indent empty lines,
but it still indented the first line even if it was empty. It no longer does
that.
== Backwards Compatibility Changes == == Backwards Compatibility Changes ==
== Internal API Changes == == Internal API Changes ==

tests/test-template-functions.t

> other 1 > other 1
>> other 2 >> other 2
>> other 3 >> other 3
Test indent with empty first line Test indent with empty first line
$ hg version -T "{indent('', '>> ')}\n" $ hg version -T "{indent('', '>> ')}\n"
>>
$ hg version -T "{indent(' $ hg version -T "{indent('
> second', '>> ')}\n" > second', '>> ')}\n"
>>
>> second >> second
$ hg version -T "{indent(' $ hg version -T "{indent('
> second', '>> ', ' > ')}\n" > second', '>> ', ' > ')}\n"
>
>> second >> second
Test with non-strings like dates Test with non-strings like dates
$ hg log -T "{indent(date, ' ')}\n" -r 2:3 -R a $ hg log -T "{indent(date, ' ')}\n" -r 2:3 -R a
1200000.00 1200000.00
1300000.00 1300000.00