Skip to content

Commit

Permalink
gh-71261: Add paragraph on shadowing submodules with star imports (GH…
Browse files Browse the repository at this point in the history
…-107004)

(cherry picked from commit 680f3e1)

Co-authored-by: wulmer <[email protected]>
  • Loading branch information
wulmer authored and miss-islington committed Jul 23, 2023
1 parent 9875b17 commit cb7974e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Doc/tutorial/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,22 @@ code::
This would mean that ``from sound.effects import *`` would import the three
named submodules of the :mod:`sound.effects` package.

Be aware that submodules might become shadowed by locally defined names. For
example, if you added a ``reverse`` function to the
:file:`sound/effects/__init__.py` file, the ``from sound.effects import *``
would only import the two submodules ``echo`` and ``surround``, but *not* the
``reverse`` submodule, because it is shadowed by the locally defined
``reverse`` function::

__all__ = [
"echo", # refers to the 'echo.py' file
"surround", # refers to the 'surround.py' file
"reverse", # !!! refers to the 'reverse' function now !!!
]

def reverse(msg: str): # <-- this name shadows the 'reverse.py' submodule
return msg[::-1] # in the case of a 'from sound.effects import *'

If ``__all__`` is not defined, the statement ``from sound.effects import *``
does *not* import all submodules from the package :mod:`sound.effects` into the
current namespace; it only ensures that the package :mod:`sound.effects` has
Expand Down

0 comments on commit cb7974e

Please sign in to comment.