环境

环境

你的应用程序可能需要大量的软件包才能正常的工作。如果都不需要 Flask 包的话，你有可能读错了教程。当应用程序运行的时候，你的应用程序的环境基本上是所有一切事情的根基。我们是幸运的，因为有许多方式使得我们能够轻松地管理我们的环境。

使用 virtualenv 管理你的环境

virtualenv 是用于在所谓 虚拟环境 中隔离你的应用程序的一个工具。一个虚拟环境是包含了你的应用依赖的软件的一个目录。一个虚拟环境也能够改变你的环境变量以维持你的开发环境包含的环境变量。不用下载包，像 Flask，到你系统级或者用户级的包目录，我们可以下载它们到一个独立的并且只为我们应用使用的目录。这就可以很容易地指定使用的 Python 的版本以及每一个项目依赖的包。

Virtualenv 也可以让你在不同的项目中使用相同的包的不同版本。这种灵活性可能是十分重要的，如果你正使用一个旧的系统并且它的上面有几个项目需要不同的版本。

当使用 virtualenv 的时候，你通常只需要安装几个的 Python 包在你的系统上。其中一个就是 virtualenv 本身。你可以使用 Pip 来安装 virtualenv 包。

一旦在你的系统上安装了 virtualenv，你可以开始创建虚拟环境。前往你项目所在的目录并且运行 virtualenv 命令。它需要一个参数，这个参数就是虚拟环境的目标目录。下面展示了它大概的样子。

$ virtualenv venv
New python executable in venv/bin/python
Installing Setuptools...........[...].....done.
Installing Pip..................[...].....done.
$

virtualenv 创建一个新的目录，依赖包将会安装到这个目录中。

一旦新的虚拟环境已经创建，你必须激活它，通过发动创建在虚拟环境里的 bin/activate 脚本。

$ which python
/usr/local/bin/python
$ source venv/bin/activate
(venv)$ which python
/Users/robert/Code/myapp/venv/bin/python

bin/activate 脚本对你的 shell 环境变量进行一些改变以致一切都指向新的虚拟环境而不是全局系统。你可以在上面的代码块中看到效果。激活后，python 命令指向虚拟环境的中 Python 的 bin 目录。当虚拟环境激活后，使用 Pip 安装的依赖包会被下载到虚拟环境中而不是全局系统。

你可能会注意到 shell 中的提示符也已经改变了。virtualenv 预先设定目前激活虚拟环境的名称，因此你会知道你不是在全局系统上工作。

你可以通过运行 deactivate 命令停用你的虚拟环境。

(venv)$ deactivate
$

### virtualenvwrapper [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) 是一个用于管理 virtualenv 创建的虚拟环境的软件包。我不想提到这个工具，直到你看到了 virtualenv 的基础知识以便你理解它改善了什么以及为什么我们应该使用它。上一部分创建的虚拟环境目录会给你的项目库带来一些混乱。你只需要激活虚拟环境和它进行交互，但是它不应该出现在版本控制中，因此这个虚拟环境目录就不应该在这里。解决方案就是使用 virtualenvwrapper。这个软件包会把所有你的虚拟环境放在一个目录的方式，通常默认是在 _~/.virtualenvs/_。要安装 virtualenvwrapper，请按照文档中的说明，文档位于 [http://virtualenvwrapper.readthedocs.org/en/latest/install.html](http://virtualenvwrapper.readthedocs.org/en/latest/install.html) 。 Warning 请确保在安装 virtualenvwrapper 之前你已经停用所有的虚拟环境。你需要把它安装在全局系统中，而不是虚拟环境中。现在，不用运行 virtualenv 来创建一个环境，你需要运行 mkvirtualenv：

$ mkvirtualenv rocket
New python executable in rocket/bin/python
Installing setuptools...........[...].....done.
Installing pip..................[...].....done.
(rocket)$

mkvirtualenv 在你虚拟环境目录中创建一个文件夹并且为你激活虚拟环境。就像上面的 virtualenv 一样，python 以及 pip 指向虚拟环境中而不是全局系统的二进制文件。要激活一个特定的环境，使用命令：workon [environment name]。deactivate 仍然会停用虚拟环境。

安装依赖包

随着项目的发展，你会发现依赖包的列表会增大。需要几十个 Python 包来运行一个 Flask 应用程序的情况并不少见。管理这些最简单的方法是用一个简单的文本文件。Pip 能够生成一个列出所有已安装的包的文本文件。在一个新的系统上，或者在一个新的刚创建的环境上也能读取文件中的列表并且安装它们中每一个。

pip freeze

requirements.txt 是一个文本文件，它被许多 Flask 应用程序用来列出运行应用所有需要的包。这个代码块用来说明如何创建这个文件接着下一个代码块用来说明在一个新环境中如果使用这个文件来安装依赖包。

(rocket)$ pip freeze > requirements.txt

$ workon fresh-env
(fresh-env)$ pip install -r requirements.txt
[...]
Successfully installed flask Werkzeug Jinja2 itsdangerous markupsafe
Cleaning up...
(fresh-env)$

### 人工管理依赖包随着项目的发展，你可能会发现 pip freeze 列出的某些包实际上并不是运行应用必须的。你安装这些包仅仅为开发用的。pip freeze 并不能区分，它仅仅列出目前已经安装的包。因此，你可能要手动地管理这些依赖包。你可以分别把那些运行应用必须的包放入 _require_run.txt_ 以及那些开发应用程序需要的包放入 _require_dev.txt_ 。 ## 版本控制选择一个版本控制系统并且使用它。我推荐 Git。从我所看到的，Git 是这些天来新项目最流行的选择。能够删除代码而不必担心犯了一个不可逆转的错误是非常宝贵的。你也可以让你的项目摆脱大量注释掉的代码的困扰，因为你可以删除它们，以后如有需要可以恢复它们。另外，你可以在 GitHub，Bitbucket 或者你自己的 Gitolite 服务器上备份整个项目。 ### 置身版本控制之外的文件我通常会让一个文件置身版本控制之外有两个原因：要么就是它会让整个项目显得混乱，要么它就是一个很隐私的密钥/证书。编译的 _.pyc_ 文件和虚拟环境 --- 如果由于某些原因你没有使用 virtualenvwrapper --- 就是让项目显得很混乱的例子。它们不需要在版本控制之中因为它们能够分别地从 _.py_ 文件和你的 _requirements.txt_ 文件重新创建。 API 秘钥，应用程序秘钥以及数据库证书是很隐私的密钥/证书的示例。它们不应该出现在版本控制中因为它们的曝光将是一个巨大的安全漏洞。 Note 当做跟安全有关的决定的时候，我总是喜欢假设我的版本库将在某个时候变成公开的。这就意味着要保守秘密并且从不假设一个安全漏洞不会被发现，“谁来猜猜他们能做到”这类型的假设被称为通过隐匿来实现安全，这是十分槽糕的策略。当使用 Git 的时候，你可以在你的版本库中创建名为 _.gitignore_ 的一个特殊文件。在这个文件里，使用列表通配符来匹配文件名。任何匹配其中一个模式的文件名都会被 Git 给忽略掉。我推荐使用 _.gitignore_ 来控制不需要版本控制的文件。例如：

*.pyc
instance/

Instance 文件夹是用于以一种更安全地方式提供给你的应用程序敏感配置变量。我将会在后面更多地谈到它。

Note

你可以阅读更多的关于 .gitignore 的内容从这里：http://git-scm.com/docs/gitignore

调试

调试模式

Flask 有一个称为调试模式方便的功能。要打开调试功能的话，你只必须在你的开发配置中设置 debug = True。当它打开的时候，服务器会在代码变化的时候自动加载并且出错的时候会伴随着一个堆栈跟踪和一个交互式控制台。

Warning

小心！不要在生产环境中使用调试模式。交互式控制台允许执行任意代码并会是一个巨大的安全漏洞。

Flask-DebugToolbar

Flask-DebugToolbar 是另一个非常了不起的工具，它可以帮助在你的应用程序中调试问题。在调试模式下，它会把一个侧边栏置于你的应用程序的每一页上。侧边栏提供了有关 SQL 查询，日志记录，版本，模板，配置和其它有趣的信息，使得更容易地跟踪问题。