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

     1

# node.py - basic nodeid manipulation for mercurial

     2

#

     3

# Copyright 2005, 2006 Olivia Mackall <olivia@selenic.com>

     4

#

     5

# This software may be used and distributed according to the terms of the

     6

# GNU General Public License version 2 or any later version.

     7

     8

from __future__ import annotations

     9

    10

import binascii

    11

    12

# This ugly style has a noticeable effect in manifest parsing

    13

hex = binascii.hexlify

    14

bin = binascii.unhexlify

    15

    16

    17

def short(node):

    18

    return hex(node[:6])

    19

    20

    21

nullrev = -1

    22

    23

# pseudo identifier for working directory

    24

# (experimental, so don't add too many dependencies on it)

    25

wdirrev = 0x7FFFFFFF

    26

    27

    28

class sha1nodeconstants:

    29

    nodelen = 20

    30

    31

    # In hex, this is '0000000000000000000000000000000000000000'

    32

    nullid = b"\0" * nodelen

    33

    nullhex = hex(nullid)

    34

    35

    # Phony node value to stand-in for new files in some uses of

    36

    # manifests.

    37

    # In hex, this is '2121212121212121212121212121212121212121'

    38

    newnodeid = b'!!!!!!!!!!!!!!!!!!!!'

    39

    # In hex, this is '3030303030303030303030303030306164646564'

    40

    addednodeid = b'000000000000000added'

    41

    # In hex, this is '3030303030303030303030306d6f646966696564'

    42

    modifiednodeid = b'000000000000modified'

    43

    44

    wdirfilenodeids = {newnodeid, addednodeid, modifiednodeid}

    45

    46

    # pseudo identifier for working directory

    47

    # (experimental, so don't add too many dependencies on it)

    48

    # In hex, this is 'ffffffffffffffffffffffffffffffffffffffff'

    49

    wdirid = b"\xff" * nodelen

    50

    wdirhex = hex(wdirid)

    51

    52

    53

# legacy starting point for porting modules

    54

nullid = sha1nodeconstants.nullid

    55

nullhex = sha1nodeconstants.nullhex

    56

newnodeid = sha1nodeconstants.newnodeid

    57

addednodeid = sha1nodeconstants.addednodeid

    58

modifiednodeid = sha1nodeconstants.modifiednodeid

    59

wdirfilenodeids = sha1nodeconstants.wdirfilenodeids

    60

wdirid = sha1nodeconstants.wdirid

    61

wdirhex = sha1nodeconstants.wdirhex