[Python-checkins] cpython: Closes #15241: Added information on venv prefixes to pyvenv section.
vinay.sajip
python-checkins at python.org
Tue Jul 3 18:27:08 CEST 2012
http://hg.python.org/cpython/rev/74fea1763d02
changeset: 77937:74fea1763d02
user: Vinay Sajip <vinay_sajip at yahoo.co.uk>
date: Tue Jul 03 17:26:55 2012 +0100
summary:
Closes #15241: Added information on venv prefixes to pyvenv section.
files:
Doc/using/scripts.rst | 22 ++++++++++++++++++++++
1 files changed, 22 insertions(+), 0 deletions(-)
diff --git a/Doc/using/scripts.rst b/Doc/using/scripts.rst
--- a/Doc/using/scripts.rst
+++ b/Doc/using/scripts.rst
@@ -63,3 +63,25 @@
virtualenv will be created, according to the given options, at each
provided path.
+.. note:: A virtual environment (also called a ``venv``) is a Python
+ environment such that the Python interpreter, libraries and scripts
+ installed into it are isolated from those installed in other virtual
+ environments, and (by default) any libraries installed in a "system" Python,
+ i.e. one which is installed as part of your operating system.
+
+ A venv is a directory tree which contains Python executable files and
+ other files which indicate that it is a venv.
+
+ Common installation tools such as ``distribute`` and ``pip`` work as
+ expected with venvs - i.e. when a venv is active, they install Python
+ packages into the venv without needing to be told to do so explicitly.
+
+ When a venv is active (i.e. the venv's Python interpreter is running), the
+ attributes :attr:`sys.prefix` and :attr:`sys.exec_prefix` point to the base
+ directory of the venv, whereas :attr:`sys.base_prefix` and
+ :attr:`sys.base_exec_prefix` point to the non-venv Python installation
+ which was used to create the venv. If a venv is not active, then
+ :attr:`sys.prefix` is the same as :attr:`sys.base_prefix` and
+ :attr:`sys.exec_prefix` is the same as :attr:`sys.base_exec_prefix` (they
+ all point to a non-venv Python installation).
+
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list