[issue24356] venv documentation incorrect / misleading
New submission from Graham Oliver: See my question here https://groups.google.com/forum/#!topic/comp.lang.python/BUmyc_hzAsA In particular Carl Meyer's response https://groups.google.com/d/msg/comp.lang.python/BUmyc_hzAsA/-cT-N-g_LL4J I am not sure what is possible with venv but I would suggest that the statement 'allowing creation of environments with various Python versions' needs to be clarified and / or altered. Thanks Graham ---------- assignee: docs@python components: Documentation messages: 244618 nosy: Graham.Oliver, docs@python priority: normal severity: normal status: open title: venv documentation incorrect / misleading versions: Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Graham Oliver added the comment: See also https://groups.google.com/d/msg/comp.lang.python/BUmyc_hzAsA/Nx5QgT1gzYEJ ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
R. David Murray added the comment: Hmm. We don't in general mention 2.7 in the python3 docs (in fact I found only one mention of it, in the logging package docs). I suppose this might be confusing enough to warrant it. But it might be better to rewrite that sentence to make it clear that the python binary you get in your virtual environment is the one that the venv command comes from. That should make it pretty clear you can't use it with 2.7, since 2.7 doesn't include venv. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Graham Oliver added the comment: ok current version Each virtual environment has its own Python binary (allowing creation of environments with various Python versions) and can have its own independent set of installed Python packages in its site directories. Suggested Alternative Each virtual environment has its own isolated Python binary (which matches the version used to create it) and can have its own independent set of installed Python packages in its site directories. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Carol Willing added the comment: Current version Each virtual environment has its own Python binary (allowing creation of environments with various Python versions) and can have its own independent set of installed Python packages in its site directories. Another suggested revision Since its introduction in Python 3.3, venv may be used to create a virtual environment with its own Python binary and optionally its own independent set of installed Python packages in its site directories. Multiple virtual environments permit various Python versions to exist on a system. David and Graham, Perhaps moving the "see also" box (see also Python Packaging User Guide: Creating and using virtual environments) closer to the top, perhaps under the pep reference, would be helpful for the user. Virtual environments are confusing for those new to Python since there are many "env"s such as venv, pyvenv, virtualenv, virtualenvwrapper, pyenv tool, and myenv used in many examples. Carol ---------- nosy: +willingc _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
R. David Murray added the comment: I think Graham's formulation provides more information. venv already has a "new in python 3.3" at the top (just before that sentence), so putting that in the text feels redundant. On the other hand, the current placement of the 'see also' box looks odd, unless the packaging authority doesn't mention virtual environments on Windows (and if it doesn't, it should!). I agree that moving that up to just after the PEP reference is probably a good idea. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Carol Willing added the comment: David, Sounds good to me. I'll submit a patch with Graham's suggested text and move the See also box up right after the PEP reference. Thanks, Carol ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Tal Einat added the comment: See also the recent addition of a section on venv to the Tutorial section of the docs (Doc/tutorial/venv.rst, issue23891). The wording there and in the module docs should at least be consistent with each other. ---------- nosy: +taleinat _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________
Change by Cheryl Sabella <chekat2@gmail.com>: ---------- keywords: +easy stage: -> needs patch type: -> enhancement versions: +Python 3.7, Python 3.8 -Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Change by Steven Downum <devilaether@gmail.com>: ---------- nosy: +steven.downum _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Change by Elena Oat <oat.elena@gmail.com>: ---------- keywords: +patch pull_requests: +6289 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Change by Tal Einat <taleinat@gmail.com>: ---------- nosy: -taleinat _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Steve Dower <steve.dower@python.org> added the comment: New changeset 50326927465c3f5c6c0168fc43310c8e97db0a47 by Steve Dower (Elena Oat) in branch 'master': bpo-24356: Specify which Python binary will be used with venv (GH-6589) https://github.com/python/cpython/commit/50326927465c3f5c6c0168fc43310c8e97d... ---------- nosy: +steve.dower _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Change by Steve Dower <steve.dower@python.org>: ---------- pull_requests: +8043 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Steve Dower <steve.dower@python.org> added the comment: New changeset 83b449d754f4da3be107b508392ef5180f105c8b by Steve Dower in branch '3.7': bpo-24356: Specify which Python binary will be used with venv (GH-6589) https://github.com/python/cpython/commit/83b449d754f4da3be107b508392ef5180f1... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
Change by Steve Dower <steve.dower@python.org>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue24356> _______________________________________
participants (8)
-
Carol Willing -
Cheryl Sabella
-
Elena Oat
-
Graham Oliver
-
R. David Murray
-
Steve Dower
-
Steven Downum
-
Tal Einat