##// END OF EJS Templates
interfaces: introduce and use a protocol class for the `bdiff` module...
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

File last commit:

r50538:e1c586b9 default
r52826:f2832de2 default
Show More
__init__.py
79 lines | 1.6 KiB | text/x-python | PythonLexer
Matt Harbison
attr: vendor 22.1.0...
r50538 # SPDX-License-Identifier: MIT
import sys
from functools import partial
Siddharth Agarwal
thirdparty: vendor attrs...
r34398
Matt Harbison
attr: vendor 22.1.0...
r50538 from . import converters, exceptions, filters, setters, validators
from ._cmp import cmp_using
from ._config import get_run_validators, set_run_validators
from ._funcs import asdict, assoc, astuple, evolve, has, resolve_types
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 from ._make import (
Matt Harbison
attr: vendor 22.1.0...
r50538 NOTHING,
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 Attribute,
Factory,
Matt Harbison
attr: vendor 22.1.0...
r50538 attrib,
attrs,
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 fields,
Matt Harbison
attr: vendor 22.1.0...
r50538 fields_dict,
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 make_class,
validate,
)
Matt Harbison
attr: vendor 22.1.0...
r50538 from ._version_info import VersionInfo
Siddharth Agarwal
thirdparty: vendor attrs...
r34398
Matt Harbison
attr: vendor 22.1.0...
r50538 __version__ = "22.1.0"
__version_info__ = VersionInfo._from_version_string(__version__)
Siddharth Agarwal
thirdparty: vendor attrs...
r34398
__title__ = "attrs"
__description__ = "Classes Without Boilerplate"
Matt Harbison
attr: vendor 22.1.0...
r50538 __url__ = "https://www.attrs.org/"
__uri__ = __url__
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 __doc__ = __description__ + " <" + __uri__ + ">"
__author__ = "Hynek Schlawack"
__email__ = "hs@ox.cx"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2015 Hynek Schlawack"
Matt Harbison
attr: vendor 22.1.0...
r50538 s = attributes = attrs
ib = attr = attrib
dataclass = partial(attrs, auto_attribs=True) # happy Easter ;)
Siddharth Agarwal
thirdparty: vendor attrs...
r34398
__all__ = [
"Attribute",
"Factory",
"NOTHING",
"asdict",
"assoc",
"astuple",
"attr",
"attrib",
"attributes",
"attrs",
Matt Harbison
attr: vendor 22.1.0...
r50538 "cmp_using",
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 "converters",
"evolve",
"exceptions",
"fields",
Matt Harbison
attr: vendor 22.1.0...
r50538 "fields_dict",
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 "filters",
"get_run_validators",
"has",
"ib",
"make_class",
Matt Harbison
attr: vendor 22.1.0...
r50538 "resolve_types",
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 "s",
"set_run_validators",
Matt Harbison
attr: vendor 22.1.0...
r50538 "setters",
Siddharth Agarwal
thirdparty: vendor attrs...
r34398 "validate",
"validators",
]
Matt Harbison
attr: vendor 22.1.0...
r50538
if sys.version_info[:2] >= (3, 6):
from ._next_gen import define, field, frozen, mutable # noqa: F401
__all__.extend(("define", "field", "frozen", "mutable"))