venv
— Creation of virtual environments¶
Нове в версії 3.3.
Вихідний код: Lib/venv/
The venv
module provides support for creating lightweight «virtual
environments» with their own site directories, optionally isolated from system
site directories. Each virtual environment has its own Python binary (which
matches the version of the binary that was used to create this environment) and
can have its own independent set of installed Python packages in its site
directories.
See PEP 405 for more information about Python virtual environments.
Створення віртуальних середовищ¶
Створення віртуальних середовищ виконується за допомогою команди venv
:
python3 -m venv /path/to/new/virtual/environment
Виконання цієї команди створює цільовий каталог (створюючи будь-які батьківські каталоги, які ще не існують) і розміщує в ньому файл pyvenv.cfg
з ключем home
, що вказує на інсталяцію Python, з якої була команда запустити (загальною назвою цільового каталогу є .venv
). Він також створює підкаталог bin
(або Scripts
у Windows), що містить копію/символне посилання двійкового/бінарних файлів Python (відповідно до платформи або аргументів, що використовуються під час створення середовища). Він також створює (спочатку порожній) підкаталог lib/pythonX.Y/site-packages
(у Windows це Lib\site-packages
). Якщо вказано існуючий каталог, він буде використаний повторно.
Застаріло починаючи з версії 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.
Змінено в версії 3.5: Тепер для створення віртуальних середовищ рекомендується використовувати venv
.
У Windows викличте команду venv
наступним чином:
c:\>c:\Python35\python -m venv c:\path\to\myenv
Крім того, якщо ви налаштували змінні PATH
і PATHEXT
для вашої інсталяції Python:
c:\>python -m venv c:\path\to\myenv
Команда, запущена з -h
, покаже доступні параметри:
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
[--upgrade] [--without-pip] [--prompt PROMPT] [--upgrade-deps]
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.
--upgrade-deps Upgrade core dependencies: pip setuptools to the
latest version in PyPI
Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.
Змінено в версії 3.9: Додайте опцію --upgrade-deps
, щоб оновити pip + setuptools до останньої версії PyPI
Змінено в версії 3.4: Встановлює pip за замовчуванням, додано параметри --without-pip
і --copies
Змінено в версії 3.4: У попередніх версіях, якщо цільовий каталог уже існував, виникала помилка, якщо не було надано опцію --clear
або --upgrade
.
Примітка
Хоча символічні посилання підтримуються в Windows, їх не рекомендується використовувати. Особливо варто відзначити, що подвійне клацання python.exe
у Провіднику файлів швидко розкриє символічне посилання та проігнорує віртуальне середовище.
Примітка
У Microsoft Windows може знадобитися ввімкнути сценарій Activate.ps1
, встановивши політику виконання для користувача. Ви можете зробити це, виконавши таку команду PowerShell:
PS C:> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Додаткову інформацію див. у розділі «Про політику виконання <https://go.microsoft.com/fwlink/?LinkID=135170>.
Створений файл pyvenv.cfg
також містить ключ include-system-site-packages
, встановлений на true
, якщо venv
запускається з --system-site
-packages`` параметр, false
інакше.
Якщо не вказано параметр --without-pip
, ensurepip
буде викликано для завантаження pip
у віртуальне середовище.
Для venv
можна надати кілька шляхів, і в цьому випадку буде створено ідентичне віртуальне середовище, відповідно до заданих параметрів, для кожного наданого шляху.
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):
Платформа |
оболонка |
Команда для активації віртуального середовища |
---|---|---|
POSIX |
bash/zsh |
$ source <venv>/bin/activate |
fish |
$ source <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 |
When a virtual environment is active, the VIRTUAL_ENV
environment
variable is set to the path of the virtual environment. This can be used to
check if one is running inside a virtual environment.
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 and is an internal implementation detail (typically a script or shell function will be used).
Нове в версії 3.4: fish
and csh
activation scripts.
Нове в версії 3.8: Сценарії активації PowerShell, встановлені під POSIX для підтримки PowerShell Core.
Примітка
A virtual environment 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 virtual environment is a directory tree which contains Python executable files and other files which indicate that it is a virtual environment.
Common installation tools such as setuptools and pip work as expected with virtual environments. In other words, when a virtual environment is active, they install Python packages into the virtual environment without needing to be told to do so explicitly.
When a virtual environment is active (i.e., the virtual environment’s Python
interpreter is running), the attributes sys.prefix
and
sys.exec_prefix
point to the base directory of the virtual
environment, whereas sys.base_prefix
and
sys.base_exec_prefix
point to the non-virtual environment Python
installation which was used to create the virtual environment. If a virtual
environment is not active, then sys.prefix
is the same as
sys.base_prefix
and sys.exec_prefix
is the same as
sys.base_exec_prefix
(they all point to a non-virtual environment
Python installation).
When a virtual environment is active, any options that change the
installation path will be ignored from all distutils
configuration
files to prevent projects being inadvertently installed outside of the
virtual environment.
When working in a command shell, users can make a virtual environment active
by running an activate
script in the virtual environment’s executables
directory (the precise filename and command to use the file is
shell-dependent), which prepends the virtual environment’s directory for
executables to the PATH
environment variable for the running shell. There
should be no need in other circumstances to activate a virtual
environment; scripts installed into virtual environments have a «shebang»
line which points to the virtual environment’s Python interpreter. This means
that the script will run with that interpreter regardless of the value of
PATH
. On Windows, «shebang» line processing is supported if you have the
Python Launcher for Windows installed (this was added to Python in 3.3 - see
PEP 397 for more details). Thus, double-clicking an installed script in a
Windows Explorer window should run the script with the correct interpreter
without there needing to be any reference to its virtual environment in
PATH
.
API¶
Метод високого рівня, описаний вище, використовує простий API, який надає механізми для сторонніх творців віртуального середовища для налаштування створення середовища відповідно до своїх потреб, клас EnvBuilder
.
-
class
venv.
EnvBuilder
(system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False)¶ Клас
EnvBuilder
приймає такі ключові аргументи під час створення екземпляра:system_site_packages
– логічне значення, яке вказує, що системні пакети сайтів Python мають бути доступними для середовища (за замовчуваннямFalse
).clear
– логічне значення, яке, якщо воно істинне, видалить вміст будь-якого існуючого цільового каталогу перед створенням середовища.symlinks
– логічне значення, яке вказує, чи намагатися символічно посилати двійковий файл Python замість копіювання.upgrade
– логічне значення, яке, якщо істинне, оновить існуюче середовище з запущеним Python - для використання, коли цей Python було оновлено на місці (за замовчуваннямFalse
).with_pip
– логічне значення, яке, якщо воно істинне, гарантує встановлення pip у віртуальному середовищі. Тут використовуєтьсяensurepip
з опцією--default-pip
.prompt
– Рядок, який буде використовуватися після активації віртуального середовища (за замовчуваннямNone
, що означає, що використовуватиметься назва каталогу середовища). Якщо вказано спеціальний рядок"."
, базова назва поточного каталогу використовується як підказка.upgrade_deps
– Оновіть базові модулі venv до останньої версії на PyPI
Змінено в версії 3.4: Додано параметр
with_pip
Нове в версії 3.6: Додано параметр
prompt
Нове в версії 3.9: Додано параметр
upgrade_deps
Творці інструментів віртуального середовища сторонніх розробників зможуть вільно використовувати наданий клас
EnvBuilder
як базовий клас.Повернений env-builder є об’єктом, який має метод
create
:-
create
(env_dir)¶ Створіть віртуальне середовище, вказавши цільовий каталог (абсолютний або відносний до поточного каталогу), який має містити віртуальне середовище. Метод
create
або створить середовище у вказаному каталозі, або викличе відповідний виняток.Метод
create
класуEnvBuilder
ілюструє хуки, доступні для налаштування підкласу:def create(self, env_dir): """ Create a virtualized Python environment in a directory. env_dir is the target directory to create an environment in. """ env_dir = os.path.abspath(env_dir) context = self.ensure_directories(env_dir) self.create_configuration(context) self.setup_python(context) self.setup_scripts(context) self.post_setup(context)
Кожен із методів
ensure_directories()
,create_configuration()
,setup_python()
,setup_scripts()
іpost_setup()
можна замінити.
-
ensure_directories
(env_dir)¶ Creates the environment directory and all necessary directories, and returns a context object. This is just a holder for attributes (such as paths), for use by the other methods. The directories are allowed to exist already, as long as either
clear
orupgrade
were specified to allow operating on an existing environment directory.
-
create_configuration
(context)¶ Створює файл конфігурації
pyvenv.cfg
у середовищі.
-
setup_python
(context)¶ Створює копію або символічне посилання на виконуваний файл Python у середовищі. У системах POSIX, якщо використовувався певний виконуваний файл
python3.x
, будуть створені символічні посилання наpython
іpython3
, які вказуватимуть на цей виконуваний файл, якщо файли з такими назвами вже не існують.
-
setup_scripts
(context)¶ Встановлює у віртуальне середовище сценарії активації, які відповідають платформі.
-
upgrade_dependencies
(context)¶ Upgrades the core venv dependency packages (currently
pip
andsetuptools
) in the environment. This is done by shelling out to thepip
executable in the environment.Нове в версії 3.9.
-
post_setup
(context)¶ Метод заповнювача, який можна замінити в реалізаціях сторонніх розробників, щоб попередньо встановити пакети у віртуальному середовищі або виконати інші кроки після створення.
Змінено в версії 3.7.2: Windows тепер використовує сценарії перенаправлення для
python[w].exe
замість копіювання фактичних двійкових файлів. У 3.7.2 лишеsetup_python()
нічого не робить, якщо не запускається зі збірки в дереві вихідних кодів.Змінено в версії 3.7.3: Windows копіює сценарії перенаправлення як частину
setup_python()
замістьsetup_scripts()
. У 3.7.2 цього не було. У разі використання символічних посилань оригінальні виконувані файли будуть зв’язані.Крім того,
EnvBuilder
надає цей метод утиліти, який можна викликати зsetup_scripts()
абоpost_setup()
у підкласах, щоб допомогти в установці спеціальних сценаріїв у віртуальне середовище.-
install_scripts
(context, path)¶ шлях — це шлях до каталогу, який має містити підкаталоги «common», «posix», «nt», кожен із яких містить сценарії, призначені для каталогу bin у середовищі. Вміст «common» і каталогу, що відповідає
os.name
, копіюються після деякої заміни тексту заповнювачів:__VENV_DIR__
замінюється на абсолютний шлях до каталогу середовища.__VENV_NAME__
замінюється назвою середовища (останній сегмент шляху каталогу середовища).__VENV_PROMPT__
замінюється підказкою (назва середовища в круглих дужках і пробіл після неї)__VENV_BIN_NAME__
замінюється назвою каталогу bin (абоbin
, абоScripts
).__VENV_PYTHON__
замінюється абсолютним шляхом до виконуваного файлу середовища.
Каталоги можуть існувати (під час оновлення існуючого середовища).
Також є функція зручності на рівні модуля:
-
venv.
create
(env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None)¶ Створіть
EnvBuilder
із заданими ключовими аргументами та викличте його методcreate()
з аргументом env_dir.Нове в версії 3.3.
Змінено в версії 3.4: Додано параметр
with_pip
Змінено в версії 3.6: Додано параметр
prompt
Приклад розширення EnvBuilder
¶
Наступний сценарій показує, як розширити EnvBuilder
шляхом впровадження підкласу, який встановлює setuptools і pip у створене віртуальне середовище:
import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
from urllib.request import urlretrieve
import venv
class ExtendedEnvBuilder(venv.EnvBuilder):
"""
This builder installs setuptools and pip so that you can pip or
easy_install other packages into the created virtual environment.
:param nodist: If true, setuptools and pip are not installed into the
created virtual environment.
:param nopip: If true, pip is not installed into the created
virtual environment.
:param progress: If setuptools or pip are installed, the progress of the
installation can be monitored by passing a progress
callable. If specified, it is called with two
arguments: a string indicating some progress, and a
context indicating where the string is coming from.
The context argument can have one of three values:
'main', indicating that it is called from virtualize()
itself, and 'stdout' and 'stderr', which are obtained
by reading lines from the output streams of a subprocess
which is used to install the app.
If a callable is not specified, default progress
information is output to sys.stderr.
"""
def __init__(self, *args, **kwargs):
self.nodist = kwargs.pop('nodist', False)
self.nopip = kwargs.pop('nopip', False)
self.progress = kwargs.pop('progress', None)
self.verbose = kwargs.pop('verbose', False)
super().__init__(*args, **kwargs)
def post_setup(self, context):
"""
Set up any packages which need to be pre-installed into the
virtual environment being created.
:param context: The information for the virtual environment
creation request being processed.
"""
os.environ['VIRTUAL_ENV'] = context.env_dir
if not self.nodist:
self.install_setuptools(context)
# Can't install pip without setuptools
if not self.nopip and not self.nodist:
self.install_pip(context)
def reader(self, stream, context):
"""
Read lines from a subprocess' output stream and either pass to a progress
callable (if specified) or write progress information to sys.stderr.
"""
progress = self.progress
while True:
s = stream.readline()
if not s:
break
if progress is not None:
progress(s, context)
else:
if not self.verbose:
sys.stderr.write('.')
else:
sys.stderr.write(s.decode('utf-8'))
sys.stderr.flush()
stream.close()
def install_script(self, context, name, url):
_, _, path, _, _, _ = urlparse(url)
fn = os.path.split(path)[-1]
binpath = context.bin_path
distpath = os.path.join(binpath, fn)
# Download script into the virtual environment's binaries folder
urlretrieve(url, distpath)
progress = self.progress
if self.verbose:
term = '\n'
else:
term = ''
if progress is not None:
progress('Installing %s ...%s' % (name, term), 'main')
else:
sys.stderr.write('Installing %s ...%s' % (name, term))
sys.stderr.flush()
# Install in the virtual environment
args = [context.env_exe, fn]
p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
t1.start()
t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
t2.start()
p.wait()
t1.join()
t2.join()
if progress is not None:
progress('done.', 'main')
else:
sys.stderr.write('done.\n')
# Clean up - no longer needed
os.unlink(distpath)
def install_setuptools(self, context):
"""
Install setuptools in the virtual environment.
:param context: The information for the virtual environment
creation request being processed.
"""
url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'
self.install_script(context, 'setuptools', url)
# clear up the setuptools archive which gets downloaded
pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
files = filter(pred, os.listdir(context.bin_path))
for f in files:
f = os.path.join(context.bin_path, f)
os.unlink(f)
def install_pip(self, context):
"""
Install pip in the virtual environment.
:param context: The information for the virtual environment
creation request being processed.
"""
url = 'https://bootstrap.pypa.io/get-pip.py'
self.install_script(context, 'pip', url)
def main(args=None):
compatible = True
if sys.version_info < (3, 3):
compatible = False
elif not hasattr(sys, 'base_prefix'):
compatible = False
if not compatible:
raise ValueError('This script is only for use with '
'Python 3.3 or later')
else:
import argparse
parser = argparse.ArgumentParser(prog=__name__,
description='Creates virtual Python '
'environments in one or '
'more target '
'directories.')
parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
help='A directory in which to create the '
'virtual environment.')
parser.add_argument('--no-setuptools', default=False,
action='store_true', dest='nodist',
help="Don't install setuptools or pip in the "
"virtual environment.")
parser.add_argument('--no-pip', default=False,
action='store_true', dest='nopip',
help="Don't install pip in the virtual "
"environment.")
parser.add_argument('--system-site-packages', default=False,
action='store_true', dest='system_site',
help='Give the virtual environment access to the '
'system site-packages dir.')
if os.name == 'nt':
use_symlinks = False
else:
use_symlinks = True
parser.add_argument('--symlinks', default=use_symlinks,
action='store_true', dest='symlinks',
help='Try to use symlinks rather than copies, '
'when symlinks are not the default for '
'the platform.')
parser.add_argument('--clear', default=False, action='store_true',
dest='clear', help='Delete the contents of the '
'virtual environment '
'directory if it already '
'exists, before virtual '
'environment creation.')
parser.add_argument('--upgrade', default=False, action='store_true',
dest='upgrade', help='Upgrade the virtual '
'environment directory to '
'use this version of '
'Python, assuming Python '
'has been upgraded '
'in-place.')
parser.add_argument('--verbose', default=False, action='store_true',
dest='verbose', help='Display the output '
'from the scripts which '
'install setuptools and pip.')
options = parser.parse_args(args)
if options.upgrade and options.clear:
raise ValueError('you cannot supply --upgrade and --clear together.')
builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
clear=options.clear,
symlinks=options.symlinks,
upgrade=options.upgrade,
nodist=options.nodist,
nopip=options.nopip,
verbose=options.verbose)
for d in options.dirs:
builder.create(d)
if __name__ == '__main__':
rc = 1
try:
main()
rc = 0
except Exception as e:
print('Error: %s' % e, file=sys.stderr)
sys.exit(rc)
Цей скрипт також доступний для завантаження online.