Mercurial > hg
annotate CONTRIBUTORS @ 51933:f2832de2a46c
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
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sat, 28 Sep 2024 19:12:18 -0400 |
parents | c29efd272395 |
children |
rev | line source |
---|---|
5514
c29efd272395
Add note to CONTRIBUTORS file
Matt Mackall <mpm@selenic.com>
parents:
2947
diff
changeset
|
1 [This file is here for historical purposes, all recent contributors |
c29efd272395
Add note to CONTRIBUTORS file
Matt Mackall <mpm@selenic.com>
parents:
2947
diff
changeset
|
2 should appear in the changelog directly] |
c29efd272395
Add note to CONTRIBUTORS file
Matt Mackall <mpm@selenic.com>
parents:
2947
diff
changeset
|
3 |
c29efd272395
Add note to CONTRIBUTORS file
Matt Mackall <mpm@selenic.com>
parents:
2947
diff
changeset
|
4 Andrea Arcangeli <andrea at suse.de> |
519 | 5 Thomas Arendsen Hein <thomas at intevation.de> |
6 Goffredo Baroncelli <kreijack at libero.it> | |
756
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
7 Muli Ben-Yehuda <mulix at mulix.org> |
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
8 Mikael Berthe <mikael at lilotux.net> |
1450 | 9 Benoit Boissinot <bboissin at gmail.com> |
2947
2d865068f72e
Add self to contributors
Brendan Cully <brendan@kublai.com>
parents:
2162
diff
changeset
|
10 Brendan Cully <brendan at kublai.com> |
519 | 11 Vincent Danjean <vdanjean.ml at free.fr> |
12 Jake Edge <jake at edge2.net> | |
13 Michael Fetterman <michael.fetterman at intel.com> | |
14 Edouard Gomez <ed.gomez at free.fr> | |
1231 | 15 Eric Hopper <hopper at omnifarious.org> |
756
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
16 Alecs King <alecsk at gmail.com> |
1310
7e8a55c9ee5c
Updated CONTRIBUTORS.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1231
diff
changeset
|
17 Volker Kleinfeld <Volker.Kleinfeld at gmx.de> |
519 | 18 Vadim Lebedev <vadim at mbdsys.com> |
19 Christopher Li <hg at chrisli.org> | |
20 Chris Mason <mason at suse.com> | |
2162
dac432a521d8
Add self to CONTRIBUTORS
Colin McMillen <mcmillen@cs.cmu.edu>
parents:
2120
diff
changeset
|
21 Colin McMillen <mcmillen at cs.cmu.edu> |
1080
253072f39205
Updated list of contributors.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
896
diff
changeset
|
22 Wojciech Milkowski <wmilkowski at interia.pl> |
756
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
23 Chad Netzer <chad.netzer at gmail.com> |
519 | 24 Bryan O'Sullivan <bos at serpentine.com> |
756
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
25 Vicent SeguĂ Pascual <vseguip at gmail.com> |
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
26 Sean Perry <shaleh at speakeasy.net> |
594 | 27 Nguyen Anh Quynh <aquynh at gmail.com> |
1310
7e8a55c9ee5c
Updated CONTRIBUTORS.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1231
diff
changeset
|
28 Ollivier Robert <roberto at keltia.freenix.fr> |
2120
c0994047c5ff
Added my name to the contributors list.
Alexander Schremmer <alex AT alexanderweb DOT de>
parents:
1450
diff
changeset
|
29 Alexander Schremmer <alex at alexanderweb.de> |
519 | 30 Arun Sharma <arun at sharma-home.net> |
1231 | 31 Josef "Jeff" Sipek <jeffpc at optonline.net> |
1310
7e8a55c9ee5c
Updated CONTRIBUTORS.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1231
diff
changeset
|
32 Kevin Smith <yarcs at qualitycode.com> |
1231 | 33 TK Soh <teekaysoh at yahoo.com> |
519 | 34 Radoslaw Szkodzinski <astralstorm at gorzow.mm.pl> |
851
73a432c8040a
Added Samuel Tardieu to contributors list.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
760
diff
changeset
|
35 Samuel Tardieu <sam at rfc1149.net> |
519 | 36 K Thananchayan <thananck at yahoo.com> |
37 Andrew Thompson <andrewkt at aktzero.com> | |
38 Michael S. Tsirkin <mst at mellanox.co.il> | |
39 Rafael Villar Burke <pachi at mmn-arquitectos.com> | |
855
a107c64c76be
Added Tristan Wibberley to contributors.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
851
diff
changeset
|
40 Tristan Wibberley <tristan at wibberley.org> |
756
5d79dfa5e98f
Added new code contributors, fixed Vincent's name, added hint on encoding.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
594
diff
changeset
|
41 Mark Williamson <mark.williamson at cl.cam.ac.uk> |