interfaces: introduce and use a protocol class for the `bdiff` module
This is allowed by PEP 544[1], and we basically follow the example there. The
class here is copied from `mercurial.pure.bdiff`, and the implementation
removed.
There are several modules that have a few different implementations, and the
implementation chosen is controlled by `HGMODULEPOLICY`. The module is loaded
via `mercurial/policy.py`, and has been inferred by pytype as `Any` up to this
point. Therefore it and PyCharm were blind to all functions on the module, and
their signatures. Also, having multiple instances of the same module allows
their signatures to get out of sync.
Introducing a protocol class allows the loaded module that is stored in a
variable to be given type info, which cascades through the various places it is
used. This change alters 11 *.pyi files, for example. In theory, this would
also allow us to ensure the various implementations of the same module are kept
in alignment- simply import the module in a test module, attempt to pass it to a
function that uses the corresponding protocol as an argument, and run pytype on
it.
In practice, this doesn't work (yet). PyCharm (erroneously) flags imported
modules being passed where a protocol class is used[2]. Pytype has problems the
other way- it fails to detect when a module that doesn't adhere to the protocol
is passed to a protocol argument. The good news is that mypy properly detects
this case. The bad news is that mypy spews a bunch of other errors when
importing even simple modules, like the various `bdiff` modules. Therefore I'm
punting on the tests for now because the type info around a loaded module in
PyCharm is a clear win by itself.
[1] https://peps.python.org/pep-0544/#modules-as-implementations-of-protocols
[2] https://youtrack.jetbrains.com/issue/PY-58679/Support-modules-implementing-protocols
# automv.py
#
# Copyright 2013-2016 Facebook, Inc.
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
"""check for unrecorded moves at commit time (EXPERIMENTAL)
This extension checks at commit/amend time if any of the committed files
comes from an unrecorded mv.
The threshold at which a file is considered a move can be set with the
``automv.similarity`` config option. This option takes a percentage between 0
(disabled) and 100 (files must be identical), the default is 95.
"""
# Using 95 as a default similarity is based on an analysis of the mercurial
# repositories of the cpython, mozilla-central & mercurial repositories, as
# well as 2 very large facebook repositories. At 95 50% of all potential
# missed moves would be caught, as well as correspond with 87% of all
# explicitly marked moves. Together, 80% of moved files are 95% similar or
# more.
#
# See http://markmail.org/thread/5pxnljesvufvom57 for context.
from __future__ import annotations
from mercurial.i18n import _
from mercurial import (
commands,
copies,
error,
extensions,
pycompat,
registrar,
scmutil,
similar,
)
configtable = {}
configitem = registrar.configitem(configtable)
configitem(
b'automv',
b'similarity',
default=95,
)
def extsetup(ui):
entry = extensions.wrapcommand(commands.table, b'commit', mvcheck)
entry[1].append(
(b'', b'no-automv', None, _(b'disable automatic file move detection'))
)
def mvcheck(orig, ui, repo, *pats, **opts):
"""Hook to check for moves at commit time"""
renames = None
disabled = opts.pop('no_automv', False)
with repo.wlock():
if not disabled:
threshold = ui.configint(b'automv', b'similarity')
if not 0 <= threshold <= 100:
raise error.Abort(
_(b'automv.similarity must be between 0 and 100')
)
if threshold > 0:
match = scmutil.match(
repo[None], pats, pycompat.byteskwargs(opts)
)
added, removed = _interestingfiles(repo, match)
uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
renames = _findrenames(
repo, uipathfn, added, removed, threshold / 100.0
)
if renames is not None:
with repo.dirstate.changing_files(repo):
# XXX this should be wider and integrated with the commit
# transaction. At the same time as we do the `addremove` logic
# for commit. However we can't really do better with the
# current extension structure, and this is not worse than what
# happened before.
scmutil._markchanges(repo, (), (), renames)
return orig(ui, repo, *pats, **opts)
def _interestingfiles(repo, matcher):
"""Find what files were added or removed in this commit.
Returns a tuple of two lists: (added, removed). Only files not *already*
marked as moved are included in the added list.
"""
stat = repo.status(match=matcher)
added = stat.added
removed = stat.removed
copy = copies.pathcopies(repo[b'.'], repo[None], matcher)
# remove the copy files for which we already have copy info
added = [f for f in added if f not in copy]
return added, removed
def _findrenames(repo, uipathfn, added, removed, similarity):
"""Find what files in added are really moved files.
Any file named in removed that is at least similarity% similar to a file
in added is seen as a rename.
"""
renames = {}
if similarity > 0:
for src, dst, score in similar.findrenames(
repo, added, removed, similarity
):
if repo.ui.verbose:
repo.ui.status(
_(b'detected move of %s as %s (%d%% similar)\n')
% (uipathfn(src), uipathfn(dst), score * 100)
)
renames[dst] = src
if renames:
repo.ui.status(_(b'detected move of %d files\n') % len(renames))
return renames