[Python-bugs-list] [ python-Bugs-631055 ] __all__ as determiner of a module's api

[SourceForge.net]

Bugs item #631055, was opened at 2002-10-30 09:20
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=631055&group_id=5470

Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Patrick K. O'Brien (pobrien)
Assigned to: Raymond Hettinger (rhettinger)
Summary: __all__ as determiner of a module's api

Initial Comment:
__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. 

----------------------------------------------------------------------

>Comment By: Raymond Hettinger (rhettinger)
Date: 2003-01-06 07:57

Message:
Logged In: YES 
user_id=80475

Fixed.
See Doc/ref/ref6.tex 1.59


----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=631055&group_id=5470