最近在重構(gòu) flask 項目的時候發(fā)現(xiàn)項目的環(huán)境變量異常的混亂，非常不便于管理。而且，更重要的事情是我需要通過自定義命令來運行 devlopment 和 production 兩種項目環(huán)境。

自定義命令工具——flask-cli

在Flask 1.0+ 中已經(jīng)支持了flask-cli，在翻閱了flask-cli文檔之后，發(fā)現(xiàn)文檔中提供的自定義命令的方法約束還是有點多，而且介紹的也不是特別詳細。后來，通過查看flask-cli的源碼發(fā)現(xiàn)flask-cli是基于Click開發(fā)的。

Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. It's the “Command Line Interface Creation Kit”. It's highly configurable but comes with sensible defaults out of the box.

Click是一個可以使用簡潔代碼和組合方法來創(chuàng)建漂亮的命令行命令的Python包。它還是一個高度可配置的，具有合理的默認設(shè)置的命令行工具創(chuàng)建工具包。

管理環(huán)境變量——python-dotenv

在使用flask-cli的時候，為了不需要每次都在 flask run 之前都引入環(huán)境變量。官方文檔中提了 python-dotenv ，需要在項目中創(chuàng)建 .env 和 .flaskenv 兩個文件。

命令行設(shè)置的變量會重載 .env 中的變量， .env 中的變量會重載 .flaskenv 中的變量。 .flaskenv 應(yīng)當用于公共變量，如 FLASK_APP 而 .env 則應(yīng)用用于私有變量，并且不提交到儲存庫。

在使用 python-dotenv 之前還需要通過 pip 去安裝依賴包(我這里使用的 pipenv )：

pipenv install python-dotenv

在 .env 文件中一般寫一些私有變量或者是涉及到隱私的變量，即使不上傳到 git 上也不影響程序運行的這種。

下面以 .flaskenv 中的幾個變量為例：

# .flaskenv
FLASK_APP = "app"
FLASK_ENV = "development"
FLASK_RUN_HOST = '0.0.0.0'
FLASK_RUN_PORT = '5000'

讀取環(huán)境變量

這里介紹如何在項目讀取變量的方法：

import os
from dotenv import load_dotenv
# 加載環(huán)境變量文件，dotenv_path默認值為.env,override是表示是否可以重載，默認值為False
load_dotenv(dotenv_path='.flaskenv',override=True)
# 讀取環(huán)境變量 FLASK_ENV,通過os.getenv()方法中引入字段名稱來讀取
env = os.getenv("FLASK_ENV")
print(env)

自定義命令

這里我的項目的入口文件為 app.py

# app.py
import click
import os
from os.path import dirname,join
from dotenv import load_dotenv
# 加載變量文件
load_dotenv(dotenv_path='.flaskenv')

'''
下面這一段代碼是根據(jù)在命令行中傳入的dev的值來執(zhí)行不同的命令，從而達到一個命令區(qū)分開發(fā)環(huán)境和生產(chǎn)環(huán)境
'''
@click.command()
@click.option('--dev', default=os.getenv("FLASK_ENV"),help='environment variable')
def runserver(dev):
 os.system("FLASK_ENV=%s flask run" % (dev))

if __name__ == '__main__':
 runserver()

運行代碼：

# 開發(fā)環(huán)境
python app.py
或者
python app.py --dev=development
# 生產(chǎn)環(huán)境
python app.py --dev=production

目前，第一階段就做了這么多，其中還有很多不足之處，希望大家?guī)兔μ岢鳇c意見，后續(xù)我有更多的做法，也會第一時間更新這些內(nèi)容。

總結(jié)

以上所述是小編給大家介紹的在flask中使用python-dotenv+flask-cli自定義命令，希望對大家有所幫助！

最新評論