virtualenv详解_virtualenv 参数

命令

用法:

$ virtualenv [OPTIONS] DEST_DIR

选项:

--version

显示当前版本号。

-h, --help

显示帮助信息。

-v, --verbose

显示详细信息。

-q, --quiet

不显示详细信息。

-p PYTHON_EXE, --python=PYTHON_EXE

指定所用的python解析器的版本，比如  --python=python2.5 就使用2.5版本的解析器创建新的隔离环境。 默认使用的是当前系统安装(/usr/bin/python)的python解析器

--clear

清空非root用户的安装，并重头开始创建隔离环境。

--no-site-packages

令隔离环境不能访问系统全局的site-packages目录。

--system-site-packages

令隔离环境可以访问系统全局的site-packages目录。

--unzip-setuptools

安装时解压Setuptools或Distribute

--relocatable

重定位某个已存在的隔离环境。使用该选项将修正脚本并令所有.pth文件使用相当路径。

--distribute

使用Distribute代替Setuptools，也可设置环境变量VIRTUALENV_DISTRIBUTE达到同样效要。

--extra-search-dir=SEARCH_DIRS

用于查找setuptools/distribute/pip发布包的目录。可以添加任意数量的–extra-search-dir路径。

--never-download

禁止从网上下载任何数据。此时，如果在本地搜索发布包失败，virtualenv就会报错。

--prompt==PROMPT

定义隔离环境的命令行前缀。

环境变量和配置文件

virtualenv既可以通过命令行配置，比如 --distribute ，也可以用下面两种方式配置:

• 环境变量

  命令行的每个参数都以 VIRTUALENV_<UPPER_NAME> 的格式对应一个环境变量。 转换变量名过程中，除了将命令行参数大写外，还要把 ('-') 替换为 ('_') 。

  举个例子，要自动安装Distribute取代默认的setuptools，可以这样设置环境变量:

  $ export VIRTUALENV_USE_DISTRIBUTE=true
  $ python virtualenv.py ENV
  

  等同于在命令行直接使用参数:

  $ python virtualenv.py --distribute ENV
  

  有时要重复输入多个命令行参数，比如 --extra-search-dir 。变成环境变量时，要用空格隔开多个参数值，例如:

  $ export VIRTUALENV_EXTRA_SEARCH_DIR="/path/to/dists /path/to/other/dists"
  $ virtualenv ENV
  

  等同于:

  $ python virtualenv.py --extra-search-dir=/path/to/dists --extra-search-dir=/path/to/other/dists ENV
  

• 配置文件

  virtualenv还能通过标准ini文件进行配置。在Unix和Mac OS X中是 $HOME/.virtualenv/virtualenv.ini ，在Windows下是 %HOME%\\virtualenv\\virtualenv.ini 。

  配置项名称就是命令行参数的名称。例如，参数 --distribute 在ini文件如下:

  [virtualenv]
  distribute = true
  

  象 --extra-search-dir 这样的多值命令行参数，在ini文件中要用断行将多个值隔开:

  [virtualenv]
  extra-search-dir =
      /path/to/dists
      /path/to/other/dists
  

virtualenv --help 可以查看完整的参数列表。

Windows下注意事项

在Windows下路径会与*nix下略有不同:脚本和可执行文件在Windows下位于 ENV\Scripts\ 下，而非 ENV/bin/ ， 模块也会安装在 ENV\Lib\ 下，而非 ENV/lib/ 。

要在某个含有空格的目录下面创建virtualenv环境，就要安装 win32api 。

PyPy支持

从1.5版开始，virtualenv开始支持 PyPy 。 >=1.5版的virtualenv支持PyPy1.4和1.4.1， >=1.6.1版的virtualenv支持PyPy1,5。

启动脚本范例

这有个具体的例子:

import virtualenv, textwrap
output = virtualenv.create_bootstrap_script(textwrap.dedent("""
import os, subprocess
def after_install(options, home_dir):
    etc = join(home_dir, 'etc')
    if not os.path.exists(etc):
        os.makedirs(etc)
    subprocess.call([join(home_dir, 'bin', 'easy_install'),
                     'BlogApplication'])
    subprocess.call([join(home_dir, 'bin', 'paster'),
                     'make-config', 'BlogApplication',
                     join(etc, 'blog.ini')])
    subprocess.call([join(home_dir, 'bin', 'paster'),
                     'setup-app', join(etc, 'blog.ini')])
"""))
f = open('blog-bootstrap.py', 'w').write(output)

这还有一个例子 点击 。

激活脚本

刚创建的隔离环境下会有一个 bin/activate 命令行脚本。在Windows下，激活脚本要在CMD.exe或Powershell.exe中使用。

在Posix系统(*nix/BSD)中，用法如下:

$ source bin/activate

该操作会将当前 $PATH 指向隔离环境下的 bin/ 目录。之所以要用source是因为它要改变当前shell环境。仅仅就是一行命令，就这么简单。 如果直接运行隔离环境下的脚本或是python解释器（比如 path/to/env/bin/pip or/path/to/env/bin/python script.py ），那都没必要使用激活脚本。

输入 deactivate 就能退出已激活的隔离环境，也就是取消对当前 $PATH 所做的修改。

activate 脚本会修改当前shell命令行提示符，以提示当前激活的是哪个隔离环境。这是挺有用的， 不过要是想自定义的提示符，只要在运行 activate 前将 VIRTUAL_ENV_DISABLE_PROMPT 设为你想要的提示(不能为空字符串)。

在Windows下只须如此（*nix用户此处就不用看了，包括下面的注意也不用看了）:

> \path\to\env\Scripts\activate

输入 deactivate 就能退出隔离环境。

视你用的shell不同（CMD.exe或Powershell.exe），Windows会使用activate.bat或activate.ps1来激活隔离环境。 如果使用的是Powershell，那么以下几点值得注意。

注意(说真的，开发python还是在*nix下好，真的真的真的！):

使用Powershell时，运行 ``activate`` 脚本取决于`执行策略`_ 。但在Windows7下，默认情况下执行策略被设为严格，
这就意味着象 ``activate`` 这样的脚本是不能直接运行的。但稍微设置一下即可。

降低执行策略，改为 ``AllSigned``, 这就意味着本机所有已通过数字签名的脚本都获许运行。
由于virtualenv作者之一Jannis Leidel的数字签名已被核准，允许运行。那么只要以管理员权限运行::

    PS C:\> Set-ExecutionPolicy AllSigned

接下来运行脚本时会提示是否信任该签名::

    PS C:\> virtualenv .\foo
    New python executable in C:\foo\Scripts\python.exe
    Installing setuptools................done.
    Installing pip...................done.
    PS C:\> .\foo\scripts\activate

    Do you want to run software from this untrusted publisher?
    File C:\foo\scripts\activate.ps1 is published by E=jannis@leidel.info,
    CN=Jannis Leidel, L=Berlin, S=Berlin, C=DE, Description=581796-Gh7xfJxkxQSIO4E0
    and is not trusted on your system. Only run scripts from trusted publishers.
    [V] Never run  [D] Do not run  [R] Run once  [A] Always run  [?] Help
    (default is "D"):A
    (foo) PS C:\>

如果选择了 ``[A] Always Run``, 该证书就会添加到当前帐户下的受信任发布者名单中，而且此后一直被该用户所信任。
如果选择了 ``[R] Run Once``, 该脚本会立即运行，但之后每次使用都会重新出现信任提示并选择。
高级用户可以将该证书添加到当前计算机的受信任发布者名单中，这样所有用户都可以使用该脚本了(不过这部分内容已经超过了本文档范畴了)。

此外，还可以进一步降低执行策略，允行未验证的本地脚本运行::

    PS C:\> Set-ExecutionPolicy RemoteSigned

因为对任何一个virtualenv环境而言， ``activate.ps1`` 都是一个本地脚本而非远程脚本，因为可以获准运行。

--system-site-packages 参数

virtualenv --system-site-packages ENV 创建的隔离环境能直接引用 /usr/lib/python2.7/site-packages (即是本机全局site-packages路径)中的模块。

只在拥有全局site-packages目录的读写权限，并且你的应用要依赖其中的模块的情况下，该参数会很有用。其他情况下没必要使用该参数。

不使用Virtualenv下的 bin/python

某些情况下，我们无法或是不想使用由virtualenv创建的Python解释器。 比如，在 mod_python 或 mod_wsgi 下，只能用唯一一个Python解释器。(wrongway补充，不过uwsgi是可以使用多个python解释器的)

幸运的是，这相当简单。只要用指定的Python解释器来 安装 应用包即可。 但要使用这些模块，就得更正路径。有一个脚本可以用来更正路径，如下这般设置环境:

activate_this = '/path/to/env/bin/activate_this.py'
execfile(activate_this, dict(__file__=activate_this))

上述操作会更改 sys.path 和 sys.prefix ，但使用的仍是当前Python解释器。在隔离环境中 会先寻找 sys.path 下的内容再寻找全局路径。不过全局路径始终是可以访问的（无论隔离环境是否是由 --system-site-packages 创建的）。 而且，上述操作不会影响其他隔离环境，也不会更正在此之前已经引用的模块。所以，在处理web请求时才激活环境往往是无效的，应该尽可能早的激活环境和更正路径，而不是在处理请求时才开始处理。

重定位隔离环境

注意: –relocatable参数带有一定的实验性，可能还有一些尚未发现的问题。而且该参数也不能在Windows下使用。

一般情况下，隔离环境都绑定在某个特定路径下。这也就意味着不能通过仅仅是移动或拷贝目录到另一台计算机上而迁移隔离环境。 这时可以使用–relocatable来重定位隔离环境:

$ virtualenv --relocatable ENV

该参数会根据相对路径生成某些setuptools或distribute文件，然后再运行 activate_this.py 更改所有的脚本， 而不是通过改变python解释器软链接的指向来重置环境。

注意: 安装 任何 包之后，都要再次重定位环境。只要你将某个隔离环境迁移了，那么每安装一个新的包之后，都要再运行一遍 virtualenv --relocatable 。

要认识到，该参数 不能做到真正的跨平台 。虽然我们可以移动相关目录，但仅仅能用于类似的计算机之间。 一些已知的环境差异，仍会导致不兼容：

• 不同版本的Python
• 不同平台使用不同的内部编码，比如一台用UCS2,另一台用UCS4
• Linux和Windows
• Intel和ARM
• 某些包依赖系统的C库，而C库在不同平台下有所差异(不同的版本或不同的文件系统下的所在位置)。

使用重定位参数创建新隔离环境时，会默认使用 --system-site-packages 参数。

--extra-search-dir 参数

创建新的隔离环境时，virtualenv会安装setuptools,distribute或是pip包管理器。一般情况下， 它们都会从 Python Package Index (PyPI) 中寻找并安装最新的包。但在一些特定情况下，我们并不希望如此。例如， 你在部署virtualenv时既不想从网上下载，也不想从PyPI中获取包。

做为替代方案，可以让setuptools，distribute或是pip搜寻文件系统，让virtualenv使用本地发行包而不是从网上下载。 只要象下面这样传入一个或多个 --extra-search-dir 参数就能使用该特性:

$ virtualenv --extra-search-dir=/path/to/distributions ENV

/path/to/distributions 路径指向某个包含setuptools/distribute/pip发行包的目录。 Setuptools发行包必须是 .egg 文件，distribute和pip发行包则是 .tar.gz 原代码压缩包。

如果本地路径没有找到相应的发布包，virtualenv还是会从网上下载。

要想确保不会从网上下载任何发行包，就使用 --never-download 参数，如下:

$ virtualenv --extra-search-dir=/path/to/distributions --never-download ENV

这样，virtualenv不会从网上下载任何发行包。而只搜索本地发行包，如果没有找到要安装的包，就返回状态码1。 virtualenv会按照如下顺序搜索发行包位置:

1. 当前目录
2. virtualenv.py所在目录
3. virtualenv.py所在目录下的 virtualenv_support 目录
4. 如果实际运行的脚本名并不是virtualenv.py (换句话说，就是你的自定义启动脚本 )，会搜索实际安装的virtualenv.py所在目录下的``virtualenv_support`` 目录。

运行测试

Virtualenv 的测试案例很小，也不完整，但我们后面会完善的。

运行测试的最简单方法就是(自动处理测试依赖):

$ python setup.py test

可以使用nose运行测试的某一部分。创建一个virtualenv环境，然后安装必要的包:

$ pip install nose mock

运行nosetests:

$ nosetests

或是只测试某个文件:

$ nosetests tests.test_virtualenv

1.创建隔离环境并安装最新的django

使用当前系统默认Python解释器安装最新的django（当前是1.4），以及django用到的mysql驱动:

$ mkdir myproject1
$ cd myproject1
$ virtualenv env --no-site-packages
$ source env/bin/active
$(env) pip install django
$(env) pip install mysql-python
$(env) deactive
$

2.创建隔离环境并安装django1.3以及一系列开发用组件

首先编辑一个.pip文件，假定为requirement.pip文件，将要用到的第三方模块名称写入:

Django==1.3
PIL
South
sorl-thumbnail
pylibmc
mysql-python
django-debug-toolbar

再在命令行运行:

$ mkdir myproject2
$ cd myproject2
$ virtualenv environ --no-site-packages
$ source environ/bin/active
$(environ) pip install -r requirement.pip
$(environ) deactive
$

3.创建Python2.7隔离环境并安装tornado

我当前环境的默认Python解析器版本是2.6，我已经安装了python2.7，现在两个python共存，但默认使用还是2.6:

$ mkdir myproject3
$ cd myproject3
$ virtualenv huanjing --no-site-packages --python=python2.7
$ source huanjing/bin/active
$(huanjing) pip install tornado
$(huanjing) deactive
$

要注意的，python2.7应该是被已设为全局可访问的，在当前命令行输入python2.7是可运行的，否则–python就要设为python2.7解释器的完整路径。