]> granicus.if.org Git - python/commitdiff
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 25 Feb 2018 19:35:52 +0000 (11:35 -0800)
committerGitHub <noreply@github.com>
Sun, 25 Feb 2018 19:35:52 +0000 (11:35 -0800)
(cherry picked from commit fbee88244e8921afdb29fde51a9a010a8ae18277)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
Doc/tutorial/modules.rst

index 2be03ac6ae30765562d233eddb6d5eb26c2f0e27..584d4fd72ea82bcd246deeea4766f1629b3233e6 100644 (file)
@@ -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