深度客製化Python的Flask框架開發環境的一些技巧總結
- WBOY原創
- 2016-08-04 08:55:461009瀏覽
Flask 環境配置
你的應用程式可能需要大量的軟體包才能正常的工作。如果都不需要 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 是一個用於管理 virtualenv 所建立的虛擬環境的軟體包。我不想提到這個工具，直到你看到了 virtualenv 的基礎知識以便你理解它改善了什麼以及為什麼我們應該使用它。
上一部分建立的虛擬環境目錄會為你的專案庫帶來一些混亂。你只需要啟動虛擬環境和它進行交互，但是它不應該出現在版本控制中，因此這個虛擬環境目錄就不應該在這裡。解決方案就是使用 virtualenvwrapper。這個軟體包會把所有你的虛擬環境放在一個目錄的方式，通常預設在 ~/.virtualenvs/。
要安裝 virtualenvwrapper，請按照文件中的說明，文件位於 http://virtualenvwrapper.readthedocs.org/en/latest/install.html 。
請確保在安裝 virtualenvwrapper 之前你已經停用所有的虛擬環境。你需要把它安裝在全域系統中，而不是虛擬環境。
現在，不用執行 virtualenv 來創造一個環境，你需要執行 mkvirtualenv：
$ mkvirtualenv rocket New python executable in rocket/bin/python Installing setuptools...........[...].....done. Installing pip..................[...].....done. (rocket)$
安裝依賴套件
隨著專案的發展，你會發現依賴套件的清單會增加。需要數十個 Python 套件來運行一個 Flask 應用程式的情況並不少見。管理這些最簡單的方法是用一個簡單的文字檔案。 Pip 能夠產生一個列出所有已安裝的套件的文字檔案。在一個新的系統上，或者在一個新的剛創建的環境上也能讀取文件中的列表並且安裝它們中每一個。
(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 秘钥，应用程序秘钥以及数据库证书是很隐私的密钥/证书的示例。它们不应该出现在版本控制中因为它们的曝光将是一个巨大的安全漏洞。
当做跟安全有关的决定的时候，我总是喜欢假设我的版本库将在某个时候变成公开的。这就意味着要保守秘密并且从不假设一个安全漏洞不会被发现，“谁来猜猜他们能做到”这类型的假设被称为通过隐匿来实现安全，这是十分槽糕的策略。
当使用 Git 的时候，你可以在你的版本库中创建名为 .gitignore 的一个特殊文件。在这个文件里，使用列表通配符来匹配文件名。任何匹配其中一个模式的文件名都会被 Git 给忽略掉。我推荐使用 .gitignore 来控制不需要版本控制的文件。例如：
*.pyc instance/
你可以阅读更多的关于 .gitignore 的内容从这里： http://git-scm.com/docs/gitignore
调试
1.调试模式
Flask 有一个称为调试模式方便的功能。要打开调试功能的话，你只必须在你的开发配置中设置 debug = True。当它打开的时候，服务器会在代码变化的时候自动加载并且出错的时候会伴随着一个堆栈跟踪和一个交互式控制台。
小心！不要在生产环境中使用调试模式。交互式控制台允许执行任意代码并会是一个巨大的安全漏洞。
2.Flask-DebugToolbar
Flask-DebugToolbar 是另一个非常了不起的工具，它可以帮助在你的应用程序中调试问题。在调试模式下，它会把一个侧边栏置于你的应用程序的每一页上。侧边栏提供了有关 SQL 查询，日志记录，版本，模板，配置和其它有趣的信息，使得更容易地跟踪问题。
看看快速入门中的 调试模式。在 Flask 官方文档 中有一些关于错误处理，日志记录以及使用调试器等不错的信息。
Flask 工程配置
当你学习 Flask 的时候，配置看起来很简单。你只要在 config.py 中定义一些变量接着一切就能工作了。当你开始必须要管理生产应用的配置的时候，这些简单性开始消失了。你可能需要保护 API 密钥以及为不同的环境使用不同的配置（例如，开发和生产环境）。在本章节中我们会介绍 Flask 一些先进的功能，它可以使得管理配置容易些。
简单的例子
一个简单的应用程序可能不会需要任何这些复杂的功能。你可能只需要把 config.py 放在你的仓库/版本库的根目录并且在 app.py 或者 yourapp/\\_init\\_.py 中加载它。
config.py 文件中应该每行包含一个配置变量赋值。当你的应用程序初始化的时候，在 config.py 中的配置变量用于配置 Flask 和它的扩展并且它们能够通过 app.config 字典访问到 – 例如，app.config["DEBUG"]。
DEBUG = True # Turns on debugging features in Flask BCRYPT_LEVEL = 12 # Configuration for the Flask-Bcrypt extension MAIL_FROM_EMAIL = "robert@example.com" # For use in application emails
配置的变量可以被 Flask，它的扩展或者你来使用。这个例子中， 每当我们在一封事务性邮件中需要默认的 “发件人” 的时候，我们可以使用 app.config["MAIL_FROM_EMAIL"] – 例如，密码重置。把这些信息放置于一个配置变量中使得以后能够容易地修改它。
# app.py or app/__init__.pyfrom flask import Flask
app = Flask(__name__)
app.config.from_object('config')
# Now we can access the configuration variables via app.config["VAR_NAME"].
- DEBUG： 为你提供了调试错误的一些方便的工具。 这包括一个基于 Web 的堆栈跟踪和交互式的 Python 控制台。在开发环境中设置成 True； 生产环境中设置成 False。
- SECRET\_KEY：这是 Flask 用来为 cookies 签名的密钥。 它也能被像 Flask-Bcrypt 类的扩展使用。 你应该在你的实例文件夹中定义它， 这样可以远离版本控制。 你可以在下一个章节中阅读更多关于示例文件夹的内容。一般情况下这应该是一个复杂的随机值。
- BCRYPT\_LEVEL：如果你使用 Flask-Bcrypt 来散列用户密码的话， 你需要指定一个“循环”数，这个数是在执行散列密码的 算法需要的。如果你不使用 Flask-Bcrypt，你可以 忽略这里。用于散列密码的循环数越大，攻击者猜测密码 的时间会越长。同时，循环数越大会增加散列密码的时间。后面我们会给出在 Flask 应用中 使用 Bcrypt 的一些最佳实践。
确保在生产环境中 DEBUG 设置成 False。如果保留 DEBUG 为 True，它允许用户在你的服务器上执行任意的 Python。
实例文件夹
有时候你需要定义包含敏感信息的配置变量。我们想要从 config.py 中分离这些变量并且让它们保留在仓库/版本库之外。你可能会隐藏像数据库密码以及 API 密钥的一些敏感信息，或者定义于特定于指定机器的配置变量。为让实现这些要求更加容易些，Flask 提供了一个叫做 instance folders 的功能。实例文件夹是仓库/版本库下的一个子目录并且包含专门为这个应用程序的实例的一个配置文件。我们不希望它提交到版本控制。
config.py requirements.txt run.py instance/ config.py yourapp/ __init__.py models.py views.py templates/ static/
使用实例文件夹
我们使用 app.config.from_pyfile() 来从一个实例文件夹中加载配置变量。当我们调用 Flask() 来创建我们的应用的时候，如果我们设置了 instance_relative_config=True， app.config.from_pyfile() 将会从 instance/ 目录加载指定文件。
# app.py or app/__init__.py
app = Flask(__name__, instance_relative_config=True)
app.config.from_object('config')
app.config.from_pyfile('config.py')
现在我们可以像在 config.py 中那样在 instance/config.py 中定义配置变量。你也应该把你的实例文件夹加入到版本控制系统的忽略列表中。要使用 Git 做到这一点的话，你需要在 .gitignore 新的一行中添加 instance/ 。
密钥
实例文件夹的隐私性成为在其里面定义不想暴露到版本控制的密钥的最佳候选。这些密钥可能包含了你的应用的密钥或者第三方 API 密钥。如果你的应用是开源的或者以后可能会公开的话，这一点特别重要。我们通常要求其他用户或者贡献者使用自己的密钥。
# instance/config.py SECRET_KEY = 'Sm9obiBTY2hyb20ga2lja3MgYXNz' STRIPE_API_KEY = 'SmFjb2IgS2FwbGFuLU1vc3MgaXMgYSBoZXJv' SQLALCHEMY_DATABASE_URI= \\"postgresql://user:TWljaGHFgiBCYXJ0b3N6a2lld2ljeiEh@localhost/databasename"
基于环境的配置
如果在你的生产环境和开发环境中的差异非常小的话，你可能想要使用实例文件夹来处理配置的变化。定义在 'instance/config.py' 文件中的配置变量能够覆盖 'config.py' 中的值。你只需要在 'app.config.from_object()' 后调用 'app.config.from_pyfile()'。这样用法的好处之一就是在不同的机器上修改你的应用的配置。
# config.py DEBUG = False SQLALCHEMY_ECHO = False # instance/config.py DEBUG = True SQLALCHEMY_ECHO = True
在生产环境上，我们略去上面 'instance/-config.py' 中的配置变量，它会退回到定义在 'config.py' 中的值。
了解更多关于 Flask-SQLAlchemy 的 配置项。（中文版的位于：http://www.pythondoc.com/flask-sqlalchemy/config.html#configuration-keys)
基于环境变量配置
实例文件夹不应该出现在版本控制中。这就意味着你将无法跟踪你的实例配置的变化。如果只是一、两个变量这可能不是什么问题，但是如果你在不同的环境上（生产，预升级，开发，等等）配置都有些微调话，你就不会想要存在丢失它们的风险。
Flask 给我们选择配置文件的能力，它可以基于一个环境变量的值来加载不同的配置文件。这就意味着在我们的仓库/版本库里，我们可以有多个配置文件并且总会加载正确的那一个。一旦我们有多个配置文件的话，我可以把它们移入它们自己 config 文件夹中。
requirements.txt run.py config/ __init__.py # Empty, just here to tell Python that it's a package. default.py production.py development.py staging.py instance/ config.py yourapp/ __init__.py models.py views.py static/ templates/
在上面的文件列表中我们有多个不同的配置文件。
- config/default.py： 默认的配置值，可用于所有的环境或者被个人的环境给覆盖。
- config/development.py： 用于开发环境的配置值。这里你可能会指定本地数据库的 URI。
- config/production.py： 用于生产环境的配置值。在这里 DEBUG 一定要设置成 False。
- config/staging.py： 根据开发进度，你可能会有一个模拟生产环境，这个文件主要用于这种场景。
为了决定要加载哪个配置文件，我们会调用 'app.config.from_envvar()'。
# yourapp/\\_\\_init\\_\\_.py
app = Flask(__name__, instance_relative_config=True)
# Load the default configuration
app.config.from_object('config.default')
# Load the configuration from the instance folder
app.config.from_pyfile('config.py')
# Load the file specified by the APP\\_CONFIG\\_FILE environment variable# Variables defined here will override those in the default configuration
app.config.from_envvar('APP_CONFIG_FILE')
环境变量的值应该是配置文件的绝对路径。
我们如何设置这个环境变量取决于我们运行应用所在的平台。如果我们运行在一个普通的 Linux 服务器上，我们可以编写一个设置环境变量的 shell 脚本并且运行 run.py。
# start.sh APP\\_CONFIG\\_FILE=/var/www/yourapp/config/production.py python run.py
start.sh 对于每一个环境都是独一无二的，因此它应该被排除在版本控制之外。在 Heroku 上，我们需要使用 Heroku 工具来设置环境变量。这种设置方式也适用于其它的 PaaS 平台。