search

python / typing

Python static typing home. Hosts the documentation and a user help forum.
https://typing.readthedocs.io/
Other
1.57k stars 231 forks source link

Integrate the Type Stubs document into the spec #1605

Open srittau opened 6 months ago

srittau commented 6 months ago

The Type Stubs document (source/stubs.rst) is based on a proposed PEP by @rchen152, @JelleZijlstra, @Solumin, and myself to describe the allowed elements of type stubs. It was turned into kind of a proto-spec document, instead of a PEP. I haven't reviewed it in detail, but I think at least the "spec" parts of this document should be moved to the spec: chapters "Syntax" and "Supported Constructs". They might need updating, though. The "Distribution" chapter is mostly redundant with the spec anyway. The other chapters should probably moved to other documents, like "Writing and Maintaining Stub Files".

JelleZijlstra commented 6 months ago

Agree that the sections you flagged should be incorporated into the spec, with some updates.

For example, the "Syntax" section says stubs should follow 3.7 syntax, but 3.7 is dead now; we should instead say stubs should follow the syntax of the earliest Python version that is not EOL yet.

rchen152 commented 3 weeks ago

I'd like to take a stab at this, if that's okay.

erictraut commented 3 weeks ago

Thanks for volunteering, @rchen152.

There's overlap between the Type Stubs document and the Typing Python Libraries document. I'd love to see these unified when this content is added to the typing spec.