[issue31454] Include "import as" in documentation
New submission from Steve Johnson: I was wondering if you could do something like fiblib = import fibo or import fibo as fiblib, and low and behold, the "as" variant worked. I find this very useful, and thought it should be part of your documentation on "import" ---------- assignee: docs@python components: Documentation messages: 302083 nosy: docs@python, svenyonson priority: normal severity: normal status: open title: Include "import as" in documentation type: enhancement versions: Python 2.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
R. David Murray added the comment: Where do you find that it is not documented that you would expect it to be? Because 'import' 'as' is certainly documented. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Steve Johnson added the comment: In the 2.7 Tutorial, section 6, modules, where it describes the various syntax for using import.
On Sep 13, 2017, at 10:42 AM, R. David Murray <report@bugs.python.org> wrote:
R. David Murray added the comment:
Where do you find that it is not documented that you would expect it to be? Because 'import' 'as' is certainly documented.
---------- nosy: +r.david.murray
_______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Mariatta Wijaya added the comment: import as is documented, so I'm closing this unless you have other concerns. Python 3 docs: https://docs.python.org/3/reference/simple_stmts.html#import ``` If the module name is followed by as, then the name following as is bound directly to the imported module ``` Wording is somewhat different in Python 2.7 docs, but it's there: https://docs.python.org/2.7/reference/simple_stmts.html#the-import-statement Thanks. ---------- nosy: +Mariatta resolution: -> not a bug stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Steve Johnson added the comment: My suggestion was to include this in the 2.7 tutorial, section 6 (modules) where the various syntax is described for import. Most of us don't dig into the reference until we are trying to find something specific. The tutorial is an excellent place to introduce useful but not obvious features of the language.
On Sep 13, 2017, at 12:15 PM, Mariatta Wijaya <report@bugs.python.org> wrote:
Mariatta Wijaya added the comment:
import as is documented, so I'm closing this unless you have other concerns.
Python 3 docs: https://docs.python.org/3/reference/simple_stmts.html#import ``` If the module name is followed by as, then the name following as is bound directly to the imported module ```
Wording is somewhat different in Python 2.7 docs, but it's there: https://docs.python.org/2.7/reference/simple_stmts.html#the-import-statement
Thanks.
---------- nosy: +Mariatta resolution: -> not a bug stage: -> resolved status: open -> closed
_______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
R. David Murray added the comment: I agree that it would seem reasonable to add this to section 6.1 of the tutorial, since it mentions both import statement variants and the modules "global symbol table", which are the two concepts involved in import as. Would you like to propose a PR? ---------- resolution: not a bug -> stage: resolved -> needs patch status: closed -> open title: Include "import as" in documentation -> Include "import as" in tutorial _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Steve Johnson added the comment: I don't know what a PR is, so I'll let you guys handle it if it is OK with you.
On Sep 14, 2017, at 11:47 AM, R. David Murray <report@bugs.python.org> wrote:
R. David Murray added the comment:
I agree that it would seem reasonable to add this to section 6.1 of the tutorial, since it mentions both import statement variants and the modules "global symbol table", which are the two concepts involved in import as.
Would you like to propose a PR?
---------- resolution: not a bug -> stage: resolved -> needs patch status: closed -> open title: Include "import as" in documentation -> Include "import as" in tutorial
_______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Changes by R. David Murray <rdmurray@bitdance.com>: ---------- versions: +Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
R. David Murray added the comment: Well, this is all volunteer work. Maybe someone else will feel like doing it :) ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- keywords: +easy _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Novel added the comment: The offending file is here: https://github.com/python/cpython/blob/master/Doc/tutorial/modules.rst Read the developer's guide to learn how to submit your changes to python. https://devguide.python.org/ ---------- nosy: +nyt _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Mariatta Wijaya added the comment: I might know an aspiring contributor who can work on this. Assigning to myself. ---------- assignee: docs@python -> Mariatta _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by Mario Corchero <mariocj89@gmail.com>: ---------- nosy: +mariocj89 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by Mario Corchero <mariocj89@gmail.com>: ---------- keywords: +patch pull_requests: +4012 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- pull_requests: +4165 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Berker Peksag <berker.peksag@gmail.com> added the comment: I just reviewed Mario's pull request. Should we mention the "from fibo import fib as fibonacci" syntax too? ---------- nosy: +berker.peksag _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Berker Peksag <berker.peksag@gmail.com> added the comment: PR 4041 looks good to me. Mariatta, do you have time to look at Mario's patch? Sarthak, thank you for your PR, but a PR was opened 12 days before yours (sorry, I missed it earlier) Would you like to work on another issue? I've just opened bpo-31948 and I'd be happy to review/merge a PR if you have time. Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Mariatta Wijaya <mariatta.wijaya@gmail.com> added the comment:
PR 4041 looks good to me. Mariatta, do you have time to look at Mario's patch?
Sorry I just saw this now, months later. Looks good to me. I can merge and backport once the CI passed. Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Mariatta Wijaya <mariatta.wijaya@gmail.com> added the comment: New changeset fbee88244e8921afdb29fde51a9a010a8ae18277 by Mariatta (Mario Corchero) in branch 'master': bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041) https://github.com/python/cpython/commit/fbee88244e8921afdb29fde51a9a010a8ae... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +5666 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +5667 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +5668 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
Mariatta Wijaya <mariatta.wijaya@gmail.com> added the comment: Thanks everyone. I've merged Marios's PR. The backport PRs have started and will automerge. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 5a07608d0855e4104e4070328155b52010dec4e7 by Miss Islington (bot) in branch '3.6': bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041) https://github.com/python/cpython/commit/5a07608d0855e4104e4070328155b52010d... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset e48e6499bbad56f7cc665efa25ae4847f51dbc38 by Miss Islington (bot) in branch '3.7': bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041) https://github.com/python/cpython/commit/e48e6499bbad56f7cc665efa25ae4847f51... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 76349471adfa4366a92438c88fd05a0e1e94c59b by Miss Islington (bot) in branch '2.7': bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041) https://github.com/python/cpython/commit/76349471adfa4366a92438c88fd05a0e1e9... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________
participants (9)
-
Berker Peksag -
Mariatta Wijaya
-
Mario Corchero
-
miss-islington
-
Novel
-
R. David Murray
-
Roundup Robot
-
Steve Johnson
-
Éric Araujo