Add py.typed #4424
Add py.typed #4424
Conversation
| @@ -0,0 +1 @@ | |||
| partial | |||
There was a problem hiding this comment.
py.typed is just a marker file, per https://peps.python.org/pep-0561/#packaging-type-information
This marker applies recursively
It should be blank (e.g. just a file without any contents), so can you remove the text "partial"?
Are you interpreting the text partial to be like a signifier of partial typing? I don't think anyone actually consumes the content of this file, for example mypy just goes based on the file existing: https://github.com/python/mypy/blob/v1.14.1/mypy/modulefinder.py#L344-L345
There was a problem hiding this comment.
Regardless of what mypy consumes, this is literally what the standard specifies should be done: https://peps.python.org/pep-0561/#partial-stub-packages
There was a problem hiding this comment.
Oh I follow what you mean, thanks for sharing. TIL that partial means to first check a stub package, then fall back on the runtime package.
Though I still don't think partial should be here, as this is not a stub package, this is the actual runtime package. Does that make sense?
In other words, if this was an external stub package filled with .pyi, then you'd put partial. But that's not the case here, it's the runtime package with .py files, so py.typed should be blank
This is neither a doc pr nor a code pr, but a packaging PR! Related to #1103, this makes the existing partially-complete type annotations usable for checking projects which import plotly.