Skip to content

PEP 484: Clarify that submodules in a package are exported #309

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
gvanrossum merged 2 commits into from
Jul 17, 2017
Merged

PEP 484: Clarify that submodules in a package are exported #309

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51a178b
PEP 484: Clarify that submodules in a package are exported
JelleZijlstra Jul 15, 2017
27f8c04
reword according to Guido's comments
JelleZijlstra Jul 17, 2017
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
16 changes: 16 additions & 0 deletions pep-0484.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1659,6 +1659,19 @@ Additional notes on stub files:
exported. (This makes it easier to re-export all objects from a
given module that may vary by Python version.)

* Just like in normal Python files [importdocs]_, submodules
automatically become exported attributes of their parent module
when imported. For example, if the ``spam`` package has the
following directory structure::

spam/
__init__.pyi
ham.pyi

where ``__init__.pyi`` contains a line such as ``from . import ham``
or ``from .ham import Ham``, then ``ham`` is an exported attribute
of ``spam``.

* Stub files may be incomplete. To make type checkers aware of this, the file
can contain the following code::

Expand Down Expand Up @@ -2457,6 +2470,9 @@ References
.. [peps]
https://hg.python.org/peps/file/tip/pep-0484.txt

.. [importdocs]
https://docs.python.org/3/reference/import.html#submodules


Copyright
=========
Expand Down