pyproject.toml
author Matt Harbison <matt_harbison@yahoo.com>
Sat, 28 Sep 2024 19:12:18 -0400
changeset 51933 f2832de2a46c
parent 48004 58fe6d127a01
child 52003 d4b275587847
permissions -rw-r--r--
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46381
45afff0f530a pyproject: add config file
Augie Fackler <augie@google.com>
parents:
diff changeset
     1
[build-system]
45afff0f530a pyproject: add config file
Augie Fackler <augie@google.com>
parents:
diff changeset
     2
requires = ["setuptools", "wheel"]
46382
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     3
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     4
[tool.black]
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     5
line-length = 80
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     6
exclude = '''
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     7
build/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     8
| wheelhouse/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
     9
| dist/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    10
| packages/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    11
| \.hg/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    12
| \.mypy_cache/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    13
| \.venv/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    14
| mercurial/thirdparty/
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    15
'''
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    16
skip-string-normalization = true
d4c8b4b90ecb black: merge config into main pyproject.toml now that we have it
Augie Fackler <augie@google.com>
parents: 46381
diff changeset
    17
quiet = true