__all__ as determiner of a module's api

[pobrien]

BPO	631055
Nosy	@rhettinger

^{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 = 'https://github.com/rhettinger'
closed_at = <Date 2003-01-06.12:57:42.000>
created_at = <Date 2002-10-30.14:20:34.000>
labels = ['docs']
title = "__all__ as determiner of a module's api"
updated_at = <Date 2003-01-06.12:57:42.000>
user = 'https://bugs.python.org/pobrien'

bugs.python.org fields:

activity = <Date 2003-01-06.12:57:42.000>
actor = 'rhettinger'
assignee = 'rhettinger'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-10-30.14:20:34.000>
creator = 'pobrien'
dependencies = []
files = []
hgrepos = []
issue_num = 631055
keywords = []
message_count = 2.0
messages = ['13003', '13004']
nosy_count = 2.0
nosy_names = ['rhettinger', 'pobrien']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue631055'
versions = []

[pobrien]

__all__ as a determiner of a module's api needs to be
more fully documented. The only references I found were
at http://www.python.org/doc/current/ref/import.html and
http://www.python.org/doc/essays/packages.html. I also
think the various uses of __all__ might be worthy of a
small PEP, since I can't find any supporting
documentation for the use of __all__ as anything more
than controlling import *, which to me is not exactly the
same thing as defining the public api for a module. It
could be, and if it is meant to be then tools, such as
IDLE, Boa, PythonWin and PyCrust should take __all__
into account when displaying autocompletion lists for
modules.

[rhettinger]

Logged In: YES
user_id=80475

Fixed.
See Doc/ref/ref6.tex 1.59