Added cross-references to venv definition.

This commit is contained in:
Vinay Sajip 2012-07-09 10:37:01 +01:00
parent 6dc9f0eca7
commit cd9b746b37
3 changed files with 20 additions and 37 deletions

View file

@ -6,8 +6,8 @@ Additional Tools and Scripts
pyvenv - Creating virtual environments
--------------------------------------
Creation of virtual environments is done by executing the ``pyvenv``
script::
Creation of :ref:`virtual environments <venv-def>` is done by executing the
``pyvenv`` script::
pyvenv /path/to/new/virtual/environment
@ -72,7 +72,7 @@ a Posix platform, you would typically do::
whereas on Windows, you might do::
c:\> <venv>/Scripts/activate
C:\> <venv>/Scripts/activate
if you are using the ``cmd.exe`` shell, or perhaps::
@ -92,25 +92,3 @@ a "deactivate" function, whereas on Windows there are separate scripts called
``deactivate.bat`` and ``Deactivate.ps1`` which are installed when the venv is
created.
.. 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).