132 lines
6.4 KiB
PHP
132 lines
6.4 KiB
PHP
Creation of :ref:`virtual environments <venv-def>` is done by executing the
|
|
command ``venv``::
|
|
|
|
python3 -m venv /path/to/new/virtual/environment
|
|
|
|
Running this command creates the target directory (creating any parent
|
|
directories that don't exist already) and places a ``pyvenv.cfg`` file in it
|
|
with a ``home`` key pointing to the Python installation from which the command
|
|
was run (a common name for the target directory is ``.venv``). It also creates
|
|
a ``bin`` (or ``Scripts`` on Windows) subdirectory containing a copy/symlink
|
|
of the Python binary/binaries (as appropriate for the platform or arguments
|
|
used at environment creation time). It also creates an (initially empty)
|
|
``lib/pythonX.Y/site-packages`` subdirectory (on Windows, this is
|
|
``Lib\site-packages``). If an existing directory is specified, it will be
|
|
re-used.
|
|
|
|
.. deprecated:: 3.6
|
|
``pyvenv`` was the recommended tool for creating virtual environments for
|
|
Python 3.3 and 3.4, and is `deprecated in Python 3.6
|
|
<https://docs.python.org/dev/whatsnew/3.6.html#deprecated-features>`_.
|
|
|
|
.. versionchanged:: 3.5
|
|
The use of ``venv`` is now recommended for creating virtual environments.
|
|
|
|
.. highlight:: none
|
|
|
|
On Windows, invoke the ``venv`` command as follows::
|
|
|
|
c:\>c:\Python35\python -m venv c:\path\to\myenv
|
|
|
|
Alternatively, if you configured the ``PATH`` and ``PATHEXT`` variables for
|
|
your :ref:`Python installation <using-on-windows>`::
|
|
|
|
c:\>python -m venv c:\path\to\myenv
|
|
|
|
The command, if run with ``-h``, will show the available options::
|
|
|
|
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
|
|
[--upgrade] [--without-pip] [--prompt PROMPT]
|
|
ENV_DIR [ENV_DIR ...]
|
|
|
|
Creates virtual Python environments in one or more target directories.
|
|
|
|
positional arguments:
|
|
ENV_DIR A directory to create the environment in.
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
--system-site-packages
|
|
Give the virtual environment access to the system
|
|
site-packages dir.
|
|
--symlinks Try to use symlinks rather than copies, when symlinks
|
|
are not the default for the platform.
|
|
--copies Try to use copies rather than symlinks, even when
|
|
symlinks are the default for the platform.
|
|
--clear Delete the contents of the environment directory if it
|
|
already exists, before environment creation.
|
|
--upgrade Upgrade the environment directory to use this version
|
|
of Python, assuming Python has been upgraded in-place.
|
|
--without-pip Skips installing or upgrading pip in the virtual
|
|
environment (pip is bootstrapped by default)
|
|
--prompt PROMPT Provides an alternative prompt prefix for this
|
|
environment.
|
|
|
|
Once an environment has been created, you may wish to activate it, e.g. by
|
|
sourcing an activate script in its bin directory.
|
|
|
|
.. versionchanged:: 3.4
|
|
Installs pip by default, added the ``--without-pip`` and ``--copies``
|
|
options
|
|
|
|
.. versionchanged:: 3.4
|
|
In earlier versions, if the target directory already existed, an error was
|
|
raised, unless the ``--clear`` or ``--upgrade`` option was provided.
|
|
|
|
.. note::
|
|
While symlinks are supported on Windows, they are not recommended. Of
|
|
particular note is that double-clicking ``python.exe`` in File Explorer
|
|
will resolve the symlink eagerly and ignore the virtual environment.
|
|
|
|
The created ``pyvenv.cfg`` file also includes the
|
|
``include-system-site-packages`` key, set to ``true`` if ``venv`` is
|
|
run with the ``--system-site-packages`` option, ``false`` otherwise.
|
|
|
|
Unless the ``--without-pip`` option is given, :mod:`ensurepip` will be
|
|
invoked to bootstrap ``pip`` into the virtual environment.
|
|
|
|
Multiple paths can be given to ``venv``, in which case an identical virtual
|
|
environment will be created, according to the given options, at each provided
|
|
path.
|
|
|
|
Once a virtual environment has been created, it can be "activated" using a
|
|
script in the virtual environment's binary directory. The invocation of the
|
|
script is platform-specific (`<venv>` must be replaced by the path of the
|
|
directory containing the virtual environment):
|
|
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| Platform | Shell | Command to activate virtual environment |
|
|
+=============+=================+=========================================+
|
|
| POSIX | bash/zsh | $ source <venv>/bin/activate |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| | fish | $ . <venv>/bin/activate.fish |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| | csh/tcsh | $ source <venv>/bin/activate.csh |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| | PowerShell Core | $ <venv>/bin/Activate.ps1 |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| Windows | cmd.exe | C:\\> <venv>\\Scripts\\activate.bat |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
| | PowerShell | PS C:\\> <venv>\\Scripts\\Activate.ps1 |
|
|
+-------------+-----------------+-----------------------------------------+
|
|
|
|
You don't specifically *need* to activate an environment; activation just
|
|
prepends the virtual environment's binary directory to your path, so that
|
|
"python" invokes the virtual environment's Python interpreter and you can run
|
|
installed scripts without having to use their full path. However, all scripts
|
|
installed in a virtual environment should be runnable without activating it,
|
|
and run with the virtual environment's Python automatically.
|
|
|
|
You can deactivate a virtual environment by typing "deactivate" in your shell.
|
|
The exact mechanism is platform-specific: for example, the Bash activation
|
|
script defines a "deactivate" function, whereas on Windows there are separate
|
|
scripts called ``deactivate.bat`` and ``Deactivate.ps1`` which are installed
|
|
when the virtual environment is created.
|
|
|
|
.. versionadded:: 3.4
|
|
``fish`` and ``csh`` activation scripts.
|
|
|
|
.. versionadded:: 3.8
|
|
PowerShell activation scripts installed under POSIX for PowerShell Core
|
|
support.
|