This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9345

errors: move similarity_hint() to error module
ClosedPublic

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

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG8cc9e7f762d6: errors: move similarity_hint() to error module
Summary

I want to be able to reuse it from UnknownIdentifier's constructor.

Moving it results in a new import of difflib in the error
module. There was a comment at the top of error.py saying "Do not
import anything but pycompat here, please", which was added (except
for the "pycompat" bit) in 08cabecfa8a8 (errors: move revlog errors,
2009-01-11). I don't know the reason for the comment. I'm guessing the
point was to not make the module depend on other Mercurial modules. If
that was it, then importing difflib should be fine.

Sorry about the churn (I moved this code from the dispatch module to
the scmutil module very recently).

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/dispatch.py (4 lines)
Mmercurial/error.py (21 lines)
Mmercurial/scmutil.py (22 lines)

Diff 23596

mercurial/dispatch.py

formatted = help.formattedhelp( formatted = help.formattedhelp(
ui, commands, inst.command, unknowncmd=True ui, commands, inst.command, unknowncmd=True
) )
ui.warn(nocmdmsg) ui.warn(nocmdmsg)
ui.write(formatted) ui.write(formatted)
except (error.UnknownCommand, error.Abort): except (error.UnknownCommand, error.Abort):
suggested = False suggested = False
if inst.all_commands: if inst.all_commands:
sim = scmutil.getsimilar(inst.all_commands, inst.command) sim = error.getsimilar(inst.all_commands, inst.command)
if sim: if sim:
ui.warn(nocmdmsg) ui.warn(nocmdmsg)
ui.warn(b"(%s)\n" % scmutil.similarity_hint(sim)) ui.warn(b"(%s)\n" % error.similarity_hint(sim))
suggested = True suggested = True
if not suggested: if not suggested:
ui.warn(nocmdmsg) ui.warn(nocmdmsg)
ui.warn(_(b"(use 'hg help' for a list of commands)\n")) ui.warn(_(b"(use 'hg help' for a list of commands)\n"))
except IOError: except IOError:
raise raise
except KeyboardInterrupt: except KeyboardInterrupt:
raise raise

mercurial/error.py

# error.py - Mercurial exceptions # error.py - Mercurial exceptions
# #
# Copyright 2005-2008 Matt Mackall <mpm@selenic.com> # Copyright 2005-2008 Matt Mackall <mpm@selenic.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
"""Mercurial exceptions. """Mercurial exceptions.
This allows us to catch exceptions at higher levels without forcing This allows us to catch exceptions at higher levels without forcing
imports. imports.
""" """
from __future__ import absolute_import from __future__ import absolute_import
import difflib
# Do not import anything but pycompat here, please # Do not import anything but pycompat here, please
from . import pycompat from . import pycompat
def _tobytes(exc): def _tobytes(exc):
"""Byte-stringify exception in the same way as BaseException_str()""" """Byte-stringify exception in the same way as BaseException_str()"""
if not exc.args: if not exc.args:
return b'' return b''
__bytes__ = _tobytes __bytes__ = _tobytes
class PatchError(Exception): class PatchError(Exception):
__bytes__ = _tobytes __bytes__ = _tobytes
def getsimilar(symbols, value):
sim = lambda x: difflib.SequenceMatcher(None, value, x).ratio()
# The cutoff for similarity here is pretty arbitrary. It should
# probably be investigated and tweaked.
return [s for s in symbols if sim(s) > 0.6]
def similarity_hint(similar):
from .i18n import _
if len(similar) == 1:
return _(b"did you mean %s?") % similar[0]
elif similar:
ss = b", ".join(sorted(similar))
return _(b"did you mean one of %s?") % ss
else:
return None
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) ParseError.__init__(self, _(b"unknown identifier: %s") % function)
self.function = function self.function = function

mercurial/scmutil.py

# scmutil.py - Mercurial core utility functions # scmutil.py - Mercurial core utility functions
# #
# Copyright Matt Mackall <mpm@selenic.com> # Copyright Matt Mackall <mpm@selenic.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import difflib
import errno import errno
import glob import glob
import os import os
import posixpath import posixpath
import re import re
import subprocess import subprocess
import weakref import weakref
ui.status( ui.status(
_(b"no changes found (ignored %d secret changesets)\n") _(b"no changes found (ignored %d secret changesets)\n")
% len(secretlist) % len(secretlist)
) )
else: else:
ui.status(_(b"no changes found\n")) ui.status(_(b"no changes found\n"))
def getsimilar(symbols, value):
sim = lambda x: difflib.SequenceMatcher(None, value, x).ratio()
# The cutoff for similarity here is pretty arbitrary. It should
# probably be investigated and tweaked.
return [s for s in symbols if sim(s) > 0.6]
def similarity_hint(similar):
if len(similar) == 1:
return _(b"did you mean %s?") % similar[0]
elif similar:
ss = b", ".join(sorted(similar))
return _(b"did you mean one of %s?") % ss
else:
return None
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 isinstance(inst, error.UnknownIdentifier):
# make sure to check fileset first, as revset can invoke fileset # make sure to check fileset first, as revset can invoke fileset
similar = getsimilar(inst.symbols, inst.function) similar = error.getsimilar(inst.symbols, inst.function)
hint = similarity_hint(similar) hint = error.similarity_hint(similar)
if hint: if hint:
write(b"(%s)\n" % hint) write(b"(%s)\n" % hint)
elif inst.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