Flask 環(huán)境配置
你的應(yīng)用程序可能需要大量的軟件包才能正常的工作。如果都不需要 Flask 包的話，你有可能讀錯(cuò)了教程。當(dāng)應(yīng)用程序運(yùn)行的時(shí)候，你的應(yīng)用程序的 環(huán)境 基本上是所有一切事情的根基。我們是幸運(yùn)的，因?yàn)橛性S多方式使得我們能夠輕松地管理我們的環(huán)境。
使用 virtualenv 管理你的環(huán)境
virtualenv 是用于在所謂 虛擬環(huán)境 中隔離你的應(yīng)用程序的一個(gè)工具。一個(gè)虛擬環(huán)境是包含了你的應(yīng)用依賴的軟件的一個(gè)目錄。一個(gè)虛擬環(huán)境也能夠改變你的環(huán)境變量以維持你的開發(fā)環(huán)境包含的環(huán)境變量。不用下載包，像 Flask， 到你系統(tǒng)級(jí)或者用戶級(jí)的包目錄，我們可以下載它們到一個(gè)獨(dú)立的并且只為我們應(yīng)用使用的目錄。這就可以很容易地指定使用的 Python 的版本以及每一個(gè)項(xiàng)目依賴的包。
Virtualenv 也可以讓你在不同的項(xiàng)目中使用相同的包的不同版本。這種靈活性可能是十分重要的，如果你正使用一個(gè)舊的系統(tǒng)并且它的上面有幾個(gè)項(xiàng)目需要不同的版本。
當(dāng)使用 virtualenv 的時(shí)候，你通常只需要安裝幾個(gè)的 Python 包在你的系統(tǒng)上。其中一個(gè)就是 virtualenv 本身。你可以使用 Pip 來(lái)安裝 virtualenv 包。
一旦在你的系統(tǒng)上安裝了 virtualenv，你可以開始創(chuàng)建虛擬環(huán)境。前往你項(xiàng)目所在的目錄并且運(yùn)行 virtualenv 命令。它需要一個(gè)參數(shù)，這個(gè)參數(shù)就是虛擬環(huán)境的目標(biāo)目錄。下面展示了它大概的樣子。

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

virtualenv 創(chuàng)建一個(gè)新的目錄，依賴包將會(huì)安裝到這個(gè)目錄中。
一旦新的虛擬環(huán)境已經(jīng)創(chuàng)建，你必須激活它，通過(guò)發(fā)動(dòng)創(chuàng)建在虛擬環(huán)境里的 bin/activate 腳本。

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

bin/activate 腳本對(duì)你的 shell 環(huán)境變量進(jìn)行一些改變以致一切都指向新的虛擬環(huán)境而不是全局系統(tǒng)。你可以在上面的代碼塊中看到效果。激活后，python 命令指向虛擬環(huán)境的中 Python 的 bin 目錄。當(dāng)虛擬環(huán)境激活后，使用 Pip 安裝的依賴包會(huì)被下載到虛擬環(huán)境中而不是全局系統(tǒng)。
你可能會(huì)注意到 shell 中的提示符也已經(jīng)改變了。virtualenv 預(yù)先設(shè)定目前激活虛擬環(huán)境的名稱，因此你會(huì)知道你不是在全局系統(tǒng)上工作。
你可以通過(guò)運(yùn)行 deactivate 命令停用你的虛擬環(huán)境。

(venv)$ deactivate

virtualenvwrapper
virtualenvwrapper 是一個(gè)用于管理 virtualenv 創(chuàng)建的虛擬環(huán)境的軟件包。我不想提到這個(gè)工具，直到你看到了 virtualenv 的基礎(chǔ)知識(shí)以便你理解它改善了什么以及為什么我們應(yīng)該使用它。
上一部分創(chuàng)建的虛擬環(huán)境目錄會(huì)給你的項(xiàng)目庫(kù)帶來(lái)一些混亂。你只需要激活虛擬環(huán)境和它進(jìn)行交互，但是它不應(yīng)該出現(xiàn)在版本控制中，因此這個(gè)虛擬環(huán)境目錄就不應(yīng)該在這里。解決方案就是使用 virtualenvwrapper。這個(gè)軟件包會(huì)把所有你的虛擬環(huán)境放在一個(gè)目錄的方式，通常默認(rèn)是在 ~/.virtualenvs/。
要安裝 virtualenvwrapper，請(qǐng)按照文檔中的說(shuō)明，文檔位于 http://virtualenvwrapper.readthedocs.org/en/latest/install.html 。
請(qǐng)確保在安裝 virtualenvwrapper 之前你已經(jīng)停用所有的虛擬環(huán)境。你需要把它安裝在全局系統(tǒng)中，而不是虛擬環(huán)境中。
現(xiàn)在，不用運(yùn)行 virtualenv 來(lái)創(chuàng)建一個(gè)環(huán)境，你需要運(yùn)行 mkvirtualenv：

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

(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)$

*.pyc
instance/

Flask 工程配置
當(dāng)你學(xué)習(xí) Flask 的時(shí)候，配置看起來(lái)很簡(jiǎn)單。你只要在 config.py 中定義一些變量接著一切就能工作了。當(dāng)你開始必須要管理生產(chǎn)應(yīng)用的配置的時(shí)候，這些簡(jiǎn)單性開始消失了。你可能需要保護(hù) API 密鑰以及為不同的環(huán)境使用不同的配置（例如，開發(fā)和生產(chǎn)環(huán)境）。在本章節(jié)中我們會(huì)介紹 Flask 一些先進(jìn)的功能，它可以使得管理配置容易些。
簡(jiǎn)單的例子
一個(gè)簡(jiǎn)單的應(yīng)用程序可能不會(huì)需要任何這些復(fù)雜的功能。你可能只需要把 config.py 放在你的倉(cāng)庫(kù)/版本庫(kù)的根目錄并且在 app.py 或者 yourapp/\\_init\\_.py 中加載它。
config.py 文件中應(yīng)該每行包含一個(gè)配置變量賦值。當(dāng)你的應(yīng)用程序初始化的時(shí)候，在 config.py 中的配置變量用于配置 Flask 和它的擴(kuò)展并且它們能夠通過(guò) app.config 字典訪問(wèn)到 – 例如，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，它的擴(kuò)展或者你來(lái)使用。這個(gè)例子中， 每當(dāng)我們?cè)谝环馐聞?wù)性郵件中需要默認(rèn)的 “發(fā)件人” 的時(shí)候，我們可以使用 app.config["MAIL_FROM_EMAIL"] – 例如，密碼重置。把這些信息放置于一個(gè)配置變量中使得以后能夠容易地修改它。

# 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： 為你提供了調(diào)試錯(cuò)誤的一些方便的工具。 這包括一個(gè)基于 Web 的堆棧跟蹤和交互式的 Python 控制臺(tái)。在開發(fā)環(huán)境中設(shè)置成 True； 生產(chǎn)環(huán)境中設(shè)置成 False。
• SECRET\_KEY：這是 Flask 用來(lái)為 cookies 簽名的密鑰。 它也能被像 Flask-Bcrypt 類的擴(kuò)展使用。 你應(yīng)該在你的實(shí)例文件夾中定義它， 這樣可以遠(yuǎn)離版本控制。 你可以在下一個(gè)章節(jié)中閱讀更多關(guān)于示例文件夾的內(nèi)容。一般情況下這應(yīng)該是一個(gè)復(fù)雜的隨機(jī)值。
• BCRYPT\_LEVEL：如果你使用 Flask-Bcrypt 來(lái)散列用戶密碼的話， 你需要指定一個(gè)“循環(huán)”數(shù)，這個(gè)數(shù)是在執(zhí)行散列密碼的 算法需要的。如果你不使用 Flask-Bcrypt，你可以 忽略這里。用于散列密碼的循環(huán)數(shù)越大，攻擊者猜測(cè)密碼 的時(shí)間會(huì)越長(zhǎng)。同時(shí)，循環(huán)數(shù)越大會(huì)增加散列密碼的時(shí)間。后面我們會(huì)給出在 Flask 應(yīng)用中 使用 Bcrypt 的一些最佳實(shí)踐。

確保在生產(chǎn)環(huán)境中 DEBUG 設(shè)置成 False。如果保留 DEBUG 為 True，它允許用戶在你的服務(wù)器上執(zhí)行任意的 Python。
實(shí)例文件夾
有時(shí)候你需要定義包含敏感信息的配置變量。我們想要從 config.py 中分離這些變量并且讓它們保留在倉(cāng)庫(kù)/版本庫(kù)之外。你可能會(huì)隱藏像數(shù)據(jù)庫(kù)密碼以及 API 密鑰的一些敏感信息，或者定義于特定于指定機(jī)器的配置變量。為讓實(shí)現(xiàn)這些要求更加容易些，F(xiàn)lask 提供了一個(gè)叫做 instance folders 的功能。實(shí)例文件夾是倉(cāng)庫(kù)/版本庫(kù)下的一個(gè)子目錄并且包含專門為這個(gè)應(yīng)用程序的實(shí)例的一個(gè)配置文件。我們不希望它提交到版本控制。

config.py
requirements.txt
run.py
instance/
 config.py
yourapp/
 __init__.py
 models.py
 views.py
 templates/
 static/

使用實(shí)例文件夾
我們使用 app.config.from_pyfile() 來(lái)從一個(gè)實(shí)例文件夾中加載配置變量。當(dāng)我們調(diào)用 Flask() 來(lái)創(chuàng)建我們的應(yīng)用的時(shí)候，如果我們?cè)O(shè)置了 instance_relative_config=True， app.config.from_pyfile() 將會(huì)從 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')

現(xiàn)在我們可以像在 config.py 中那樣在 instance/config.py 中定義配置變量。你也應(yīng)該把你的實(shí)例文件夾加入到版本控制系統(tǒng)的忽略列表中。要使用 Git 做到這一點(diǎn)的話，你需要在 .gitignore 新的一行中添加 instance/ 。
密鑰
實(shí)例文件夾的隱私性成為在其里面定義不想暴露到版本控制的密鑰的最佳候選。這些密鑰可能包含了你的應(yīng)用的密鑰或者第三方 API 密鑰。如果你的應(yīng)用是開源的或者以后可能會(huì)公開的話，這一點(diǎn)特別重要。我們通常要求其他用戶或者貢獻(xiàn)者使用自己的密鑰。

# instance/config.py
SECRET_KEY = 'Sm9obiBTY2hyb20ga2lja3MgYXNz'
STRIPE_API_KEY = 'SmFjb2IgS2FwbGFuLU1vc3MgaXMgYSBoZXJv'
SQLALCHEMY_DATABASE_URI= \\"postgresql://user:TWljaGHFgiBCYXJ0b3N6a2lld2ljeiEh@localhost/databasename"

基于環(huán)境的配置
如果在你的生產(chǎn)環(huán)境和開發(fā)環(huán)境中的差異非常小的話，你可能想要使用實(shí)例文件夾來(lái)處理配置的變化。定義在 'instance/config.py' 文件中的配置變量能夠覆蓋 'config.py' 中的值。你只需要在 'app.config.from_object()' 后調(diào)用 'app.config.from_pyfile()'。這樣用法的好處之一就是在不同的機(jī)器上修改你的應(yīng)用的配置。

# config.py
DEBUG = False
SQLALCHEMY_ECHO = False
# instance/config.py
DEBUG = True
SQLALCHEMY_ECHO = True

在生產(chǎn)環(huán)境上，我們略去上面 'instance/-config.py' 中的配置變量，它會(huì)退回到定義在 'config.py' 中的值。
了解更多關(guān)于 Flask-SQLAlchemy 的 配置項(xiàng)。（中文版的位于：http://www.pythondoc.com/flask-sqlalchemy/config.html#configuration-keys)
基于環(huán)境變量配置
實(shí)例文件夾不應(yīng)該出現(xiàn)在版本控制中。這就意味著你將無(wú)法跟蹤你的實(shí)例配置的變化。如果只是一、兩個(gè)變量這可能不是什么問(wèn)題，但是如果你在不同的環(huán)境上（生產(chǎn)，預(yù)升級(jí)，開發(fā)，等等）配置都有些微調(diào)話，你就不會(huì)想要存在丟失它們的風(fēng)險(xiǎn)。
Flask 給我們選擇配置文件的能力，它可以基于一個(gè)環(huán)境變量的值來(lái)加載不同的配置文件。這就意味著在我們的倉(cāng)庫(kù)/版本庫(kù)里，我們可以有多個(gè)配置文件并且總會(huì)加載正確的那一個(gè)。一旦我們有多個(gè)配置文件的話，我可以把它們移入它們自己 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/

在上面的文件列表中我們有多個(gè)不同的配置文件。

• config/default.py： 默認(rèn)的配置值，可用于所有的環(huán)境或者被個(gè)人的環(huán)境給覆蓋。
• config/development.py： 用于開發(fā)環(huán)境的配置值。這里你可能會(huì)指定本地?cái)?shù)據(jù)庫(kù)的 URI。
• config/production.py： 用于生產(chǎn)環(huán)境的配置值。在這里 DEBUG 一定要設(shè)置成 False。
• config/staging.py： 根據(jù)開發(fā)進(jìn)度，你可能會(huì)有一個(gè)模擬生產(chǎn)環(huán)境，這個(gè)文件主要用于這種場(chǎng)景。

為了決定要加載哪個(gè)配置文件，我們會(huì)調(diào)用 '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')

環(huán)境變量的值應(yīng)該是配置文件的絕對(duì)路徑。
我們?nèi)绾卧O(shè)置這個(gè)環(huán)境變量取決于我們運(yùn)行應(yīng)用所在的平臺(tái)。如果我們運(yùn)行在一個(gè)普通的 Linux 服務(wù)器上，我們可以編寫一個(gè)設(shè)置環(huán)境變量的 shell 腳本并且運(yùn)行 run.py。

# start.sh
APP\\_CONFIG\\_FILE=/var/www/yourapp/config/production.py
python run.py

start.sh 對(duì)于每一個(gè)環(huán)境都是獨(dú)一無(wú)二的，因此它應(yīng)該被排除在版本控制之外。在 Heroku 上，我們需要使用 Heroku 工具來(lái)設(shè)置環(huán)境變量。這種設(shè)置方式也適用于其它的 PaaS 平臺(tái)。

最新評(píng)論