summaryrefslogtreecommitdiffstats
path: root/Doc/ref/ref6.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-10-24 19:50:31 (GMT)
committerFred Drake <fdrake@acm.org>2001-10-24 19:50:31 (GMT)
commit08fd51509c27b3c2be5562f64336852f50d28349 (patch)
tree8c290d0587849176a812086f4770e8b79ec5a30b /Doc/ref/ref6.tex
parentb8fc9721001b6d6b53d272be32b0bf80248cb2ba (diff)
downloadcpython-08fd51509c27b3c2be5562f64336852f50d28349.zip
cpython-08fd51509c27b3c2be5562f64336852f50d28349.tar.gz
cpython-08fd51509c27b3c2be5562f64336852f50d28349.tar.bz2
When describing "import *", add a level of indirection between "*" and the
set of names imported (the "public names"), adding a definition of "public names" that describes the use of __all__. This closes SF bug #473986. Flesh out the vague reference to __import__().
Diffstat (limited to 'Doc/ref/ref6.tex')
-rw-r--r--Doc/ref/ref6.tex20
1 files changed, 17 insertions, 3 deletions
diff --git a/Doc/ref/ref6.tex b/Doc/ref/ref6.tex
index d96a670..bb0f920 100644
--- a/Doc/ref/ref6.tex
+++ b/Doc/ref/ref6.tex
@@ -603,11 +603,20 @@ list of identifiers, looks each one of them up in the module found in step
As with the first form of \keyword{import}, an alternate local name can be
supplied by specifying "\keyword{as} localname". If a name is not found,
\exception{ImportError} is raised. If the list of identifiers is replaced
-by a star (\samp{*}), all names defined in the module are bound, except
-those beginning with an underscore (\character{_}).
+by a star (\character{*}), all public names defined in the module are
+bound in the local namespace of the \keyword{import} statement..
\indexii{name}{binding}
\exindex{ImportError}
+The \emph{public names} defined by a module are determined by checking
+the module's namespace for a variable named \code{__all__}; if
+defined, it must be a sequence of strings which are names defined or
+imported by that module. The names given in \code{__all__} are all
+considered public and are required to exist. If \code{__all__} is not
+defined, the set of public names includes all names found in the
+module's namespace which do not begin with an underscore character
+(\character{_}).
+
Names bound by \keyword{import} statements may not occur in
\keyword{global} statements in the same scope.
\stindex{global}
@@ -628,7 +637,12 @@ file \file{__init__.py}.\ttindex{__init__.py}
\url{http://www.python.org/doc/essays/packages.html} for more details, also
about how the module search works from inside a package.]
-[XXX Also should mention __import__().]
+The built-in function \function{__import__()} is provided to support
+applications that determine which modules need to be loaded
+dynamically; refer to \ulink{Built-in
+Functions}{../lib/built-in-funcs.html} in the
+\citetitle[../lib/lib.html]{Python Library Reference} for additional
+information.
\bifuncindex{__import__}