A simple script to encapsulate venv and virtualenv creation in one. venv is always used if possible; if it's not, virtualenv will be used (if specified) as the fallback option.
This file can be used either as a standalone script, or a module to import.
create(python, env_dir, system, prompt, bare, virtualenv_py=None)
pythonshould be an absolute path pointing to a Python executable. If this is not
None, and does not match
sys.executable, that interpreter is launched as a subprocess to run this script. Otherwise, the creation is done in-process (subprocesses may still be run in steps during the creation).
env_dirpoints to the directory to create the new virtual environment.
systemspecifies whether system site packages will be available for the created virtual environment.
promptspecifies the prompt prefix used in the created virtual environment's activate scripts.
bare, if True, prevents any third-party libraries from being installed. This means you will not have Setuptools, pip, and Wheel available inside the created virtual environment.
virtualenv_pyshould be an absolute path pointing to a
virtualenv.pyscript. This is optional; if missing, virtualenv will not be used to create a virtual environment.
Command line API
virtenv env_dir --python PYTHON [--system] [--prompt PROMPT]
Meanings of arguments are similar to the Python API.
python argument is required, and can be a version, such as
A suitable Python executable will be looked up automatically if possible.
When is venv used
As mentioned above, venv is always preferred if possible. virtualenv is used for the following scenarios:
- When the module
venvis not available in the target Python.
- When the module
ensurepipis not available in the target Python. This generally happens for Python 3.3, or distributions such as Debian that don't like to bundle
ensurepip. Without it, pip wouldn't be available, and we don't want that.
sys.real_prefixis set. This usually means the target Python is managed by a virtualenv, and venv is known to have problems working in this situation. See discussion in bpo-30811 and pypa/virtualenv#1095 for more information.