Skip to content

gh-54643: Document the rules for public names in the tutorial #155344

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

Open
Phantom0299 wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

gh-54643: Document the rules for public names in the tutorial #155344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions Doc/tutorial/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,3 +603,17 @@ modules found in a package.
.. [#] In fact function definitions are also 'statements' that are 'executed'; the
execution of a module-level function definition adds the function name to
the module's global namespace.

Public Names
------------

.. note::
When using a module, it is important to know which names (functions, classes, variables) are intended for you to use (the *public API*), and which are internal details that might change.

The rules for public names are:

1. If a module defines an ``__all__`` variable, only the names listed inside it are considered public. All remaining names are considered private.

2. If a module does not define an ``__all__`` variable, then any name that does NOT start with an underscore (``_``) is considered public.

3. Any imported names from other modules are not public, unless they are explicitly included in ``__all__``.
Loading