Confusing text about __all__ in __init__.py in tutorial

[ztane]

BPO	27074
Nosy	@ericsnowcurrently, @ztane

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2016-05-21.07:45:05.669>
labels = ['type-feature', 'docs']
title = 'Confusing text about __all__ in __init__.py in tutorial'
updated_at = <Date 2021-06-22.21:16:18.466>
user = 'https://github.com/ztane'

bugs.python.org fields:

activity = <Date 2021-06-22.21:16:18.466>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2016-05-21.07:45:05.669>
creator = 'ztane'
dependencies = []
files = []
hgrepos = []
issue_num = 27074
keywords = []
message_count = 1.0
messages = ['265990']
nosy_count = 3.0
nosy_names = ['docs@python', 'eric.snow', 'ztane']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue27074'
versions = []

Linked PRs

• gh-71261: Add paragraph on shadowing submodules with star imports #107004
• [3.11] gh-71261: Add paragraph on shadowing submodules with star imports (GH-107004) #107099
• [3.12] gh-71261: Add paragraph on shadowing submodules with star imports (GH-107004) #107100

[ztane]

https://docs.python.org/3/tutorial/modules.html#importing-from-a-package

says that

"The import statement uses the following convention: if a package’s __init__.py code defines a list named __all__, it is taken to be the list of module names that should be imported when from package import * is encountered."

However, of course this is not true. The behaviour is that __all__ lists the names that are to be imported from the package with from package import *; only only those names that raise AttributeError at the time of import would be attempted to be imported as submodules.

[hugovk]

Thanks, fixed during the EuroPython 2023 sprint!