Open JonathonReinhart opened 8 months ago
Why not contribute your PYI files here directly ? https://github.com/python/typeshed/pull/11262
I contributed the py.typed because nothing existed in typeshed and my linters (mypy or pyright) can infer quite a lot of types themselves without any additional type info.
Unfortunately as you discovered, they refuse to do so unless the py.typed existed. At the time, it felt like a net-win to me.
@JonathonReinhart as mentioned in the last comment, could you create a PR against this repo with your .pyi files?
TL;DR
As I understand, PR #507 precludes the addition of
pyelftools
stubs to typeshed.Problem
The purpose of the
py.typed
marker is to inform static type checkers that a package containing said file includes type information (in the package), either inline (as part of the.py
source) or as stubs (separate.pyi
files).elftools
currently does neither of those.The problem is that adding
py.typed
to a package that does not provide type information breaks the final step of PEP 561 Type Checker Module Resolution Order (MRO):So the net result (and point of this comment) is: By adding
py.typed
to this library,mypy
will never consult Typeshed -- where I was starting to add stubs: https://github.com/python/typeshed/pull/11262Forward
As I see it, there are two paths forward. In order of preference (mine, and the Python typing community in general):
Keep
py.typed
, and commit to allowing type information to be added in this repository (preferably inline in the.py
source, or secondarily as separate.pyi
stubs)Remove
py.typed
, enabling stubs to be published on Typeshed.References
cc @fzakaria