Skip to content

Change to -stubs over _stubs #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 5, 2018
Merged

Change to -stubs over _stubs #568

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f72157
Change to -stubs over _stubs
emmatyping Feb 5, 2018
b1c483d
PEP 561: Add changlog and note about pip updating
emmatyping Feb 5, 2018
e7548e6
Fix rst errors
emmatyping Feb 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions pep-0561.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,10 @@ type information, it is preferred that the ``*.pyi`` stubs are alongside the
corresponding ``*.py`` files. However, the stubs can also be put in a separate
package and distributed separately. Third parties can also find this method
useful if they wish to distribute stub files. The name of the stub package
MUST follow the scheme ``foopkg_stubs`` for type stubs for the package named
``foopkg``. The normal resolution order of checking ``*.pyi`` before ``*.py``
will be maintained.
MUST follow the scheme ``foopkg-stubs`` for type stubs for the package named
``foopkg``. Note that for stub only packages adding a py.typed marker is not
needed since the name ``*-stubs`` is enough to indicate it is a source of typing
information.

Third parties seeking to distribute stub files are encouraged to contact the
maintainer of the package about distribution alongside the package. If the
Expand All @@ -143,9 +144,13 @@ inline, then a third party stub only package can be created.
In addition, stub-only distributions SHOULD indicate which version(s)
of the runtime package are supported by indicating the runtime distribution's
version(s) through normal dependency data. For example, the
stub package ``flyingcircus_stubs`` can indicate the versions of the
stub package ``flyingcircus-stubs`` can indicate the versions of the
runtime ``flyingcircus`` distribution it supports through ``install_requires``
in distutils-based tools, or the equivalent in other packaging tools.
in distutils-based tools, or the equivalent in other packaging tools. Note that
in pip 9.0, if you update ``flyingcircus-stubs``, it will update
``flyingcircus``. In pip 9.0, you can use the
``--upgrade-strategy=only-if-needed`` flag. In pip 10.0 this is the default
behavior.


Type Checker Module Resolution Order
Expand All @@ -161,7 +166,7 @@ resolve modules containing type information:
stubs to use, and patch broken stubs/inline types from packages.

3. Stub packages - these packages can supersede the installed packages.
They can be found at ``foopkg_stubs`` for package ``foopkg``.
They can be found at ``foopkg-stubs`` for package ``foopkg``.

4. Inline packages - if there is nothing overriding the installed
package, and it opts into type checking, inline types SHOULD be used.
Expand All @@ -176,6 +181,9 @@ of that Python version. This can be queried e.g.
that the type checker allow for the user to point to a particular Python
binary, in case it is not in the path.

The normal resolution order of checking ``*.pyi`` before ``*.py``
will be maintained.


Implementation
==============
Expand All @@ -198,6 +206,12 @@ Smith, and Guido van Rossum.
Version History
===============

* 2018-02-02

* Change stub only package suffix to be -stubs not _stubs.
* Note that py.typed is not needed for stub only packages.
* Add note about pip and upgrading stub packages.

* 2017-11-12

* Rewritten to use existing tooling only
Expand Down