This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9346

errors: create "similarity hint" for UnknownIdentifier eagerly in constructor
ClosedPublic

Authored by martinvonz on Nov 20 2020, 7:24 PM.

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG1817b66897ad: errors: create "similarity hint" for UnknownIdentifier eagerly in constructor
Summary

No code wanted to do anything but to produce a hint from it anyway, so
we might as well just store the hint in the exception (which already
extended Hint). That way we can easily convert it to a
ConfigException when it's parsing of configuration that fails.

I was wondering if the purpose of lazily creating the string was so we
don't create it in cases where it won't get printed anyway. However, I
couldn't find any places where that could happen. If we do find such
places, we could instead revert to making it lazy but add a function
on UnknownIdentifier for creating the hint string.

I dropped the comment saying "make sure to check fileset first, as
revset can invoke fileset", which was added in 4e240d6ab898 (dispatch:
offer near-edit-distance suggestions for {file,rev}set functions,
2015-01-26). I couldn't figure out what it meant. The author of that
patch also did not remember the reason for it. Perhaps changes that
have happened since then made it so it no longer matters.

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

PathPackages
Mmercurial/error.py (9 lines)
Mmercurial/scmutil.py (8 lines)

Diff 23597

mercurial/error.py

class UnknownIdentifier(ParseError): class UnknownIdentifier(ParseError):
"""Exception raised when a {rev,file}set references an unknown identifier""" """Exception raised when a {rev,file}set references an unknown identifier"""
def __init__(self, function, symbols): def __init__(self, function, symbols):
from .i18n import _ from .i18n import _
ParseError.__init__(self, _(b"unknown identifier: %s") % function) similar = getsimilar(symbols, function)
self.function = function hint = similarity_hint(similar)
self.symbols = symbols
ParseError.__init__(
self, _(b"unknown identifier: %s") % function, hint=hint
)
class RepoError(Hint, Exception): class RepoError(Hint, Exception):
__bytes__ = _tobytes __bytes__ = _tobytes
class RepoLookupError(RepoError): class RepoLookupError(RepoError):
pass pass

mercurial/scmutil.py

def formatparse(write, inst): def formatparse(write, inst):
if inst.location is not None: if inst.location is not None:
write( write(
_(b"hg: parse error at %s: %s\n") _(b"hg: parse error at %s: %s\n")
% (pycompat.bytestr(inst.location), inst.message) % (pycompat.bytestr(inst.location), inst.message)
) )
else: else:
write(_(b"hg: parse error: %s\n") % inst.message) write(_(b"hg: parse error: %s\n") % inst.message)
if isinstance(inst, error.UnknownIdentifier): if inst.hint:
# make sure to check fileset first, as revset can invoke fileset
similar = error.getsimilar(inst.symbols, inst.function)
hint = error.similarity_hint(similar)
if hint:
write(b"(%s)\n" % hint)
elif inst.hint:
write(_(b"(%s)\n") % inst.hint) write(_(b"(%s)\n") % inst.hint)
def callcatch(ui, func): def callcatch(ui, func):
"""call func() with global exception handling """call func() with global exception handling
return func() if no exception happens. otherwise do some error handling return func() if no exception happens. otherwise do some error handling
and return an exit code accordingly. does not handle all exceptions. and return an exit code accordingly. does not handle all exceptions.