This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8905

templater: add exception-raising version of open_template()
ClosedPublic

Authored by martinvonz on Aug 6 2020, 2:29 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHG4aa484efc926: templater: add exception-raising version of open_template()
Summary

I'm about to add another caller of open_template() (in the template
loader). That caller will want to get exceptions instead of `(None,
None)` if the template doesn't exist. This patch therefore changes
open_template() to raise exceptions and adds a new
try_open_template() that returns the (None, None) value.

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.

Revision Contents
Changeset List

Diff 22319

mercurial/debugcommands.py

fm.plain(_(b'checking "re2" regexp engine (%s)\n') % re2) fm.plain(_(b'checking "re2" regexp engine (%s)\n') % re2)
fm.data(re2=bool(util._re2)) fm.data(re2=bool(util._re2))
# templates # templates
p = templater.templatedir() p = templater.templatedir()
fm.write(b'templatedirs', b'checking templates (%s)...\n', p or b'') fm.write(b'templatedirs', b'checking templates (%s)...\n', p or b'')
fm.condwrite(not p, b'', _(b" no template directories found\n")) fm.condwrite(not p, b'', _(b" no template directories found\n"))
if p: if p:
(m, fp) = templater.open_template(b"map-cmdline.default") (m, fp) = templater.try_open_template(b"map-cmdline.default")
if m: if m:
# template found, check if it is working # template found, check if it is working
err = None err = None
try: try:
templater.templater.frommapfile(m) templater.templater.frommapfile(m)
except Exception as inst: except Exception as inst:
err = stringutil.forcebytestr(inst) err = stringutil.forcebytestr(inst)
p = None p = None

mercurial/formatter.py

# a function-style reference to built-in template # a function-style reference to built-in template
func, fsep, ftail = tmpl.partition(b'(') func, fsep, ftail = tmpl.partition(b'(')
if func in {b'cbor', b'json'} and fsep and ftail.endswith(b')'): if func in {b'cbor', b'json'} and fsep and ftail.endswith(b')'):
templater.parseexpr(tmpl) # make sure syntax errors are confined templater.parseexpr(tmpl) # make sure syntax errors are confined
return reference_templatespec(func, refargs=ftail[:-1]) return reference_templatespec(func, refargs=ftail[:-1])
# perhaps a stock style? # perhaps a stock style?
if not os.path.split(tmpl)[0]: if not os.path.split(tmpl)[0]:
(mapname, fp) = templater.open_template( (mapname, fp) = templater.try_open_template(
b'map-cmdline.' + tmpl b'map-cmdline.' + tmpl
) or templater.open_template(tmpl) ) or templater.try_open_template(tmpl)
if mapname: if mapname:
return mapfile_templatespec(topic, mapname, fp) return mapfile_templatespec(topic, mapname, fp)
# perhaps it's a reference to [templates] # perhaps it's a reference to [templates]
if ui.config(b'templates', tmpl): if ui.config(b'templates', tmpl):
return reference_templatespec(tmpl) return reference_templatespec(tmpl)
if tmpl == b'list': if tmpl == b'list':

mercurial/hgweb/hgweb_mod.py

or pycompat.ossep in style or pycompat.ossep in style
or pycompat.osaltsep or pycompat.osaltsep
and pycompat.osaltsep in style and pycompat.osaltsep in style
): ):
continue continue
locations = (os.path.join(style, b'map'), b'map-' + style, b'map') locations = (os.path.join(style, b'map'), b'map-' + style, b'map')
for location in locations: for location in locations:
mapfile, fp = templater.open_template(location, path) mapfile, fp = templater.try_open_template(location, path)
if mapfile: if mapfile:
return style, mapfile, fp return style, mapfile, fp
raise RuntimeError(b"No hgweb templates found in %r" % path) raise RuntimeError(b"No hgweb templates found in %r" % path)
def makebreadcrumb(url, prefix=b''): def makebreadcrumb(url, prefix=b''):
'''Return a 'URL breadcrumb' list '''Return a 'URL breadcrumb' list

mercurial/logcmdutil.py

return formatter.literal_templatespec(templater.unquotestring(tmpl)) return formatter.literal_templatespec(templater.unquotestring(tmpl))
else: else:
style = util.expandpath(ui.config(b'ui', b'style')) style = util.expandpath(ui.config(b'ui', b'style'))
if not tmpl and style: if not tmpl and style:
mapfile = style mapfile = style
fp = None fp = None
if not os.path.split(mapfile)[0]: if not os.path.split(mapfile)[0]:
(mapname, fp) = templater.open_template( (mapname, fp) = templater.try_open_template(
b'map-cmdline.' + mapfile b'map-cmdline.' + mapfile
) or templater.open_template(mapfile) ) or templater.try_open_template(mapfile)
if mapname: if mapname:
mapfile = mapname mapfile = mapname
return formatter.mapfile_templatespec(b'changeset', mapfile, fp) return formatter.mapfile_templatespec(b'changeset', mapfile, fp)
return formatter.lookuptemplate(ui, b'changeset', tmpl) return formatter.lookuptemplate(ui, b'changeset', tmpl)
def maketemplater(ui, repo, tmpl, buffered=False): def maketemplater(ui, repo, tmpl, buffered=False):

mercurial/templater.py

If the name is a relative path and we're in a frozen binary, the template If the name is a relative path and we're in a frozen binary, the template
will be read from the mercurial.templates package instead. The returned path will be read from the mercurial.templates package instead. The returned path
will then be the relative path. will then be the relative path.
''' '''
if templatepath is None: if templatepath is None:
templatepath = templatedir() templatepath = templatedir()
if templatepath is not None or os.path.isabs(name): if templatepath is not None or os.path.isabs(name):
f = os.path.join(templatepath, name) f = os.path.join(templatepath, name)
try:
return f, open(f, mode='rb') return f, open(f, mode='rb')
except EnvironmentError:
return None, None
else: else:
name_parts = pycompat.sysstr(name).split('/') name_parts = pycompat.sysstr(name).split('/')
package_name = '.'.join(['mercurial', 'templates'] + name_parts[:-1]) package_name = '.'.join(['mercurial', 'templates'] + name_parts[:-1])
try:
return ( return (
name, name,
resourceutil.open_resource(package_name, name_parts[-1]), resourceutil.open_resource(package_name, name_parts[-1]),
) )
except (ImportError, OSError):
def try_open_template(name, templatepath=None):
try:
return open_template(name, templatepath)
except (EnvironmentError, ImportError):
return None, None return None, None