summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMario Corchero <mariocj89@gmail.com>2018-02-25 19:11:12 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2018-02-25 19:11:12 (GMT)
commitfbee88244e8921afdb29fde51a9a010a8ae18277 (patch)
treea5618dc4ed4cb4c9f307167bf8a40d3805d34b62
parent84c4b0cc67ceb4b70842b78c718b6e8214874d6a (diff)
downloadcpython-fbee88244e8921afdb29fde51a9a010a8ae18277.zip
cpython-fbee88244e8921afdb29fde51a9a010a8ae18277.tar.gz
cpython-fbee88244e8921afdb29fde51a9a010a8ae18277.tar.bz2
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
-rw-r--r--Doc/tutorial/modules.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/tutorial/modules.rst b/Doc/tutorial/modules.rst
index 2be03ac..584d4fd 100644
--- a/Doc/tutorial/modules.rst
+++ b/Doc/tutorial/modules.rst
@@ -112,6 +112,25 @@ Note that in general the practice of importing ``*`` from a module or package is
frowned upon, since it often causes poorly readable code. However, it is okay to
use it to save typing in interactive sessions.
+If the module name is followed by :keyword:`as`, then the name
+following :keyword:`as` is bound directly to the imported module.
+
+::
+
+ >>> import fibo as fib
+ >>> fib.fib(500)
+ 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
+
+This is effectively importing the module in the same way that ``import fibo``
+will do, with the only difference of it being available as ``fib``.
+
+It can also be used when utilising :keyword:`from` with similar effects::
+
+ >>> from fibo import fib as fibonacci
+ >>> fibonacci(500)
+ 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
+
+
.. note::
For efficiency reasons, each module is only imported once per interpreter