Mercurial > public > mercurial-scm > hg-stable
diff mercurial/templatekw.py @ 36475:e8d37838f5df
templatekw: add 'requires' flag to switch to exception-safe interface
The current templatekw interface, f(repo, ctx, templ, **args), is horrible
because it's quite easy to encounter TypeError, ValueError, etc. It's also
bad for Python 3 porting due to the **kwargs issue.
This patch introduces a flag to switch to new f(context, mapping) API seen
in templater functions. The requirement spec isn't verified (yet) because
context.resource() can gracefully raise a ResourceUnavailable exception,
but it's planned to be used as a filter in the help, such as "Revision
Keywords" (if 'ctx' in requires), "File Keywords" (if 'fctx' in requires),
etc.
showauthor() is ported to the new API as an example. 20 more follows.
| author | Yuya Nishihara <yuya@tcha.org> |
|---|---|
| date | Sun, 25 Feb 2018 13:24:35 +0900 |
| parents | e46b24582fa0 |
| children | 9ff5cbfbc26a |
line wrap: on
line diff
--- a/mercurial/templatekw.py Sun Feb 25 12:50:30 2018 +0900 +++ b/mercurial/templatekw.py Sun Feb 25 13:24:35 2018 +0900 @@ -341,21 +341,14 @@ # filecopy is preserved for compatibility reasons defaulttempl['filecopy'] = defaulttempl['file_copy'] -# keywords are callables like: -# fn(repo, ctx, templ, cache, revcache, **args) -# with: -# repo - current repository instance -# ctx - the changectx being displayed -# templ - the templater instance -# cache - a cache dictionary for the whole templater run -# revcache - a cache dictionary for the current revision +# keywords are callables (see registrar.templatekeyword for details) keywords = {} - templatekeyword = registrar.templatekeyword(keywords) -@templatekeyword('author') -def showauthor(repo, ctx, templ, **args): +@templatekeyword('author', requires={'ctx'}) +def showauthor(context, mapping): """String. The unmodified author of the changeset.""" + ctx = context.resource(mapping, 'ctx') return ctx.user() @templatekeyword('bisect')