当前位置 主页 > 网站技术 > 代码类 >

    在flask中使用python-dotenv+flask-cli自定义命令(推荐)

    栏目:代码类 时间:2020-01-05 18:05

    最近在重构 flask 项目的时候发现项目的环境变量异常的混乱,非常不便于管理。而且,更重要的事情是我需要通过自定义命令来运行 devlopment 和 production 两种项目环境。

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

    在Flask 1.0+ 中已经支持了flask-cli,在翻阅了flask-cli文档之后,发现文档中提供的自定义命令的方法约束还是有点多,而且介绍的也不是特别详细。后来,通过查看flask-cli的源码发现flask-cli是基于Click开发的。

    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是一个可以使用简洁代码和组合方法来创建漂亮的命令行命令的Python包。它还是一个高度可配置的,具有合理的默认设置的命令行工具创建工具包。

    管理环境变量——python-dotenv

    在使用flask-cli的时候,为了不需要每次都在 flask run 之前都引入环境变量。官方文档中提了 python-dotenv ,需要在项目中创建 .env 和 .flaskenv 两个文件。

    命令行设置的变量会重载 .env 中的变量, .env 中的变量会重载 .flaskenv 中的变量。 .flaskenv 应当用于公共变量,如 FLASK_APP 而 .env 则应用用于私有变量,并且不提交到储存库。

    在使用 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'
    

    读取环境变量

    这里介绍如何在项目读取变量的方法:

    import os
    from dotenv import load_dotenv
    # 加载环境变量文件,dotenv_path默认值为.env,override是表示是否可以重载,默认值为False
    load_dotenv(dotenv_path='.flaskenv',override=True)
    # 读取环境变量 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')
    
    '''
    下面这一段代码是根据在命令行中传入的dev的值来执行不同的命令,从而达到一个命令区分开发环境和生产环境
    '''
    @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()

    运行代码:

    # 开发环境
    python app.py
    或者
    python app.py --dev=development
    # 生产环境
    python app.py --dev=production

    目前,第一阶段就做了这么多,其中还有很多不足之处,希望大家帮忙提出点意见,后续我有更多的做法,也会第一时间更新这些内容。