flask-cli命令行使用方式

2020-12-18 19:26:56 编辑 1 阅读量:1526

flask从0.11版本开始引入了click提供命令行支持，在此之前我们通常会引入Flask-Script来提供。它有很多用处，最重要的是它提供了shell的环境和自定义shell命令的支持，大概的使用方式如下：

#### 一、flask安装
flask安装一定要在虚拟环境下，可以使用virtualenv来提供虚拟环境，用法如下
```
$ sudo pip install virtualenv
$ cd /your/project/path
$ virtualenv venv    # 创建虚拟环境venv目录
$ source venv/bin/activate    # 进入虚拟环境，在这里可以使用pip install 尽情的安装包，也可以使用export自定义环境变量
(venv) $ pip install flask  # 安装flask，flask在虚拟环境中安装时，会自动存在flask命令
(venv) $ flask    # 查看flask命令用法
(venv) $ export FLASK_APP=your_project_filename.py  # 存在你定义的app的文件
(venv) $ flask run  # 以默认方式运行app， 可以使用flask run --help查看更多配置
(venv) $ deactivate  # 退出虚拟环境
```

在 venv/bin/activate中添加一行代码`export FLASK_APP=your_project_filename.py`这样每次进入虚拟环境就不需要自己再export了

#### 二、 定义flask shell环境
因为flask已经集成了click，所以可以不需要再额外安装包。
在`your_project_filename.py`添加
```
@app.shell_context_processor
def shell():    # 有@app.shell_context_processor，取任意名字均可
    return dict(app=app)    # dict中可以包含你自己需要在shell中使用的其他变量
```
这样，可以在shell中运行
```
$ flask shell
```
这样就可以很方便的调试或者初始化各种配置

#### 三、自定义自己的shell命令
##### 3.1 不带参数的命令
flask.cli还有个重要的作用就是定义自己的命令，比如这里定义一个使用ipython的命令：

在`your_project_filename.py`添加:
```
@app.cli.command(short_help='Runs a ipython shell in the app context.')
def ishell():    # 函数名就是命令名字
    from IPython import embed
	# import 你需要的，在ipython中可以直接使用，同时整个文件的变量都可以直接使用
    embed()
    return
```
- app.cli.command装饰器可以将函数转为shell命令
- short_help就是提示信息

```
(venv) $ flask    # 就会出现我们定义的ishell参数了
(venv) $ flask ishell  # 进入我们的ipython环境，注意，在your_project_filename中含有的所有变量都可以在ipython中直接使用，同时也可以自己定义要使用的变量
```

##### 3.2 带参数的命令
```
@app.cli.command()
@click.option('--length', default=25, help='Profile stack length')
@click.option('-profile-dir', default=None, help='Profile directory')
def profile(length, profile_dir):
    print(length, profile_dir)
```
使用如下：
```
(venv) $ flask profile --help    # 查看help信息
(venv) $ flask profile --length 2 -profile-dir eyiaqhkwejhfkhj
(2, u'eyiaqhkwejhfkhj')
```

#### 四、绝对路径导入
在使用flask shell时，如果里面的file使用绝对路径的导入方式，在要app的文件中加入该路径
```
import sys
import os
base_dir = os.path.dirname(os.path.abspath(__file__))
sys.path.append(base_dir)
```
否则会出现无法import的情况

#### 五、其他
##### 5.1 flask-cli和flask-script的选择
当然是选择flask-cli，因为这个是官方内置，不需要安装其他组建，而且flask-script已经停止维护。

---
参考：
- [1][从Flask-Script迁移到Flask-Cli](https://www.cnblogs.com/lynsyklate/p/7693169.html)
- [2][Flask-CLI¶](https://pythonhosted.org/Flask-CLI/)
- [3][Flask Web Development —— 大型应用程序结构（下）](https://segmentfault.com/a/1190000002413794)
- [4][Add IPython support to flask shell #1729](https://github.com/pallets/flask/pull/1729)
- [5][Command Line Interface](http://flask.pocoo.org/docs/0.12/cli/)

flask-cli命令行使用方式

附件: