This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5959

templates: adding a config() function for template customization
ClosedPublic

Authored by rdamazio on Feb 13 2019, 9:34 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG6704696141b8: templates: adding a config() function for template customization
Summary

This allows templates to be written such that users can customize them easily,
or that they can be customized based on other configuration of the system. For
enterprise deployments, we often have complex template aliases, and right now
the only way individual users can customize those is by replacing the whole
template alias (which means they won't get company-wide updates to it anymore,
plus most users don't want to have to get a complex template right).
With this change, they can just set a config option which feeds into our
templates for common changes (e.g. whether to limit commit descriptions to the
width of their terminal or not).

To work around the issue of having to register the config options, I declared
a dedicated section [templateconfig] for these options to be dynamically
declared. They can still reference any other config option that's registered
elsewhere.

I only did string, bool and int at this time - list and date would add other
complications with parsing the default so I'll leave that as an exercise to
the reader :)

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

rdamazio created this revision.Feb 13 2019, 9:34 PM
rdamazio retitled this revision from templates: adding a config() function for template customization. to templates: adding a config() function for template customization.Feb 13 2019, 9:36 PM
durin42 accepted this revision as: durin42.Feb 15 2019, 11:03 PM
durin42 added a subscriber: durin42.

I like this, but can see it being vaguely controversial so I'll only give it a +1 here for now - if I don't see objections in a few days I'll go ahead and land it.

Closed by commit rHG6704696141b8: templates: adding a config() function for template customization (authored by rdamazio). · Explain WhyFeb 17 2019, 8:52 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 14133

mercurial/configitems.py

) )
coreconfigitem('subrepos', 'svn:allowed', coreconfigitem('subrepos', 'svn:allowed',
default=dynamicdefault, default=dynamicdefault,
) )
coreconfigitem('templates', '.*', coreconfigitem('templates', '.*',
default=None, default=None,
generic=True, generic=True,
) )
coreconfigitem('templateconfig', '.*',
default=dynamicdefault,
generic=True,
)
coreconfigitem('trusted', 'groups', coreconfigitem('trusted', 'groups',
default=list, default=list,
) )
coreconfigitem('trusted', 'users', coreconfigitem('trusted', 'users',
default=list, default=list,
) )
coreconfigitem('ui', '_usedassubrepo', coreconfigitem('ui', '_usedassubrepo',
default=False, default=False,

mercurial/templatefuncs.py

key = evalrawexp(context, mapping, args[1]) key = evalrawexp(context, mapping, args[1])
try: try:
return dictarg.getmember(context, mapping, key) return dictarg.getmember(context, mapping, key)
except error.ParseError as err: except error.ParseError as err:
# i18n: "get" is a keyword # i18n: "get" is a keyword
hint = _("get() expects a dict as first argument") hint = _("get() expects a dict as first argument")
raise error.ParseError(bytes(err), hint=hint) raise error.ParseError(bytes(err), hint=hint)
@templatefunc('config(section, name[, default])', requires={'ui'})
def config(context, mapping, args):
"""Returns the requested hgrc config option as a string."""
fn = context.resource(mapping, 'ui').config
return _config(context, mapping, args, fn, evalstring)
@templatefunc('configbool(section, name[, default])', requires={'ui'})
def configbool(context, mapping, args):
"""Returns the requested hgrc config option as a boolean."""
fn = context.resource(mapping, 'ui').configbool
return _config(context, mapping, args, fn, evalboolean)
@templatefunc('configint(section, name[, default])', requires={'ui'})
def configint(context, mapping, args):
"""Returns the requested hgrc config option as an integer."""
fn = context.resource(mapping, 'ui').configint
return _config(context, mapping, args, fn, evalinteger)
def _config(context, mapping, args, configfn, defaultfn):
if not (2 <= len(args) <= 3):
raise error.ParseError(_("config expects two or three arguments"))
# The config option can come from any section, though we specifically
# reserve the [templateconfig] section for dynamically defining options
# for this function without also requiring an extension.
section = evalstringliteral(context, mapping, args[0])
name = evalstringliteral(context, mapping, args[1])
if len(args) == 3:
default = defaultfn(context, mapping, args[2])
return configfn(section, name, default)
else:
return configfn(section, name)
@templatefunc('if(expr, then[, else])') @templatefunc('if(expr, then[, else])')
def if_(context, mapping, args): def if_(context, mapping, args):
"""Conditionally execute based on the result of """Conditionally execute based on the result of
an expression.""" an expression."""
if not (2 <= len(args) <= 3): if not (2 <= len(args) <= 3):
# i18n: "if" is a keyword # i18n: "if" is a keyword
raise error.ParseError(_("if expects two or three arguments")) raise error.ParseError(_("if expects two or three arguments"))

tests/test-template-functions.t

$ hg log -T "coerced to string: {rev|utf8}\n" -r0 $ hg log -T "coerced to string: {rev|utf8}\n" -r0
coerced to string: 0 coerced to string: 0
pad width: pad width:
$ HGENCODING=utf-8 hg debugtemplate "{pad('`cat utf-8`', 2, '-')}\n" $ HGENCODING=utf-8 hg debugtemplate "{pad('`cat utf-8`', 2, '-')}\n"
\xc3\xa9- (esc) \xc3\xa9- (esc)
read config options:
$ hg log -T "{config('templateconfig', 'knob', 'foo')}\n"
foo
$ hg log -T "{config('templateconfig', 'knob', 'foo')}\n" \
> --config templateconfig.knob=bar
bar
$ hg log -T "{configbool('templateconfig', 'knob', True)}\n"
True
$ hg log -T "{configbool('templateconfig', 'knob', True)}\n" \
> --config templateconfig.knob=0
False
$ hg log -T "{configint('templateconfig', 'knob', 123)}\n"
123
$ hg log -T "{configint('templateconfig', 'knob', 123)}\n" \
> --config templateconfig.knob=456
456
$ hg log -T "{config('templateconfig', 'knob')}\n"
devel-warn: config item requires an explicit default value: 'templateconfig.knob' at: * (glob)
$ hg log -T "{configbool('ui', 'interactive')}\n"
False
$ hg log -T "{configbool('ui', 'interactive')}\n" --config ui.interactive=1
True
$ hg log -T "{config('templateconfig', 'knob', if(true, 'foo', 'bar'))}\n"
foo
$ cd .. $ cd ..