先说问题
在使用过程到遇到问题，提示没有flask._compat模块
(flask-projs) [root@test-xxxx-01-vm]# python app.py
Traceback (most recent call last):
File "/data/colinspace/temp/flask-demo/demoproj/app.py", line 5, in <module>
from flask_script import Manager
File "/data/colinspace/.pyenv/versions/flask-projs/lib/python3.9/site-packages/flask_script/__init__.py", line 15, in <module>
from flask._compat import text_type
ModuleNotFoundError: No module named 'flask._compat'
刚开始没有仔细看错误信息，惯性的去网上查找解决方案，大多都说是高版本存在问题，需要降配处理。
先说结果： 其实不用降配处理，因为从错误中就可以发现问题所在
检查了下本地安装的版本
Flask 2.2.2
Flask-Script 2.0.6
尝试降配到 1.1.4 、1.1.3 和 1.1.2 然后运行，又出现了很多其他类似的问题，比如
ImportError: cannot import name 'json' from 'itsdangerous'
或者
ImportError: cannot import name 'escape' from 'jinja2'
安装网上的说法又升级、重新安装先关模块还是存在问题。
最终仔细看到错误发生在
flask_script/__init__.py文件，找flask._compat模块，结果在site-packages/flask/下面没有看到_compat.py文件，在site-packages/flask_script/下看到了
所以认定是 flask_script/__init__.py文件 15行 from flask._compat import text_type 书写有误。修改为
# site-packages/flask_script/__init__.py
from flask_script._compat import text_type
然后运行程序正常
再谈 Flask-Script
官方文档 https://flask-script.readthedocs.io/en/latest/ 建议大家阅读
看作者对 Flask-script的介绍
Flask脚本扩展支持在Flask中编写外部脚本。这包括运行开发服务器、定制的Python shell、设置数据库的脚本、cronjobs以及属于web应用程序本身之外的其他命令行任务。
简单理解是开发基于命令行的工具，用来实现非application逻辑的功能，比如应用首次安装之后的数据初始化
官网的demo很简单，先看集成Flask-script之后，未开发自定义command之前
from flask import Flask
from flask_script import Manager
app = Flask(__name__)
manager = Manager(app)
if __name__ == '__main__':
# 注意这里被 manager.run()接管， 而不是app.run()
manager.run()
这个时候执行 python app.py 不会直接启动一个 http server，而是输出如下:
usage: app.py [-?] {shell,runserver} ...
positional arguments:
{shell,runserver}
shell Runs a Python shell inside Flask application context.
runserver Runs the Flask development server i.e. app.run()
optional arguments:
-?, --help show this help message and exit
看到默认是包含了两个命令
shell 是启动一个 flask的shell交互环境
runserver 顾名思义就是为了启动服务
我们执行 python app.py runserver --help 来看看这个命令都支持那些参数
usage: app.py runserver [-?] [-h HOST] [-p PORT] [--threaded] [--processes PROCESSES] [--passthrough-errors] [-d] [-D]
[-r] [-R] [--ssl-crt SSL_CRT] [--ssl-key SSL_KEY]
Runs the Flask development server i.e. app.run()
optional arguments:
-?, --help show this help message and exit
-h HOST, --host HOST
-p PORT, --port PORT
--threaded
--processes PROCESSES
--passthrough-errors
-d, --debug enable the Werkzeug debugger (DO NOT use in production code)
-D, --no-debug disable the Werkzeug debugger
-r, --reload monitor Python files for changes (not 100% safe for production use)
-R, --no-reload do not monitor Python files for changes
--ssl-crt SSL_CRT Path to ssl certificate
--ssl-key SSL_KEY Path to ssl key
所以这个时候执行 python app.py runserver -h 192.168.3.108 -p 5000 就可以启动类似之前 app.run()方式启动一个http server
自定义command
# encoding: utf-8
from flask import Flask
from flask_script import Manager
from flask_script import Command, Option
app = Flask(__name__)
manager = Manager(app)
# 通过定义方法的形式
@manager.command
def sayHi():
print("Hi Flask-script")
# 通过函数方法定义有参数的命令
# 注意这里不要在添加 `@manager.command`
# 如果需要多个参数，则定义多个 manager.option 即可
# 关于dest参数，实际测试的过程发现好像可有可无，官网建议还是带上
@manager.option('-n', '--name', dest='name', default="DefaltName", help='name to say Hello')
@manager.option('-a', '--age', dest='age', default=18, help='user age')
def sayHello(age, name):
print(f"Hello {name}, you are {age} old")
# 给 manager 添加额外的参数
# 会在optional arguments中除了help之外，多出现一行 `-c CONFIG, --config CONFIG`
# 而且注意：
# manager.add_option 添加的参数是在 app.py 紧跟后面，注意和自定义命令的参数做区分
manager.add_option('-c', '--config', dest='config', required=False)
# 基于子类的方法定义自定义命令
# 需要配合 manager.add_command() 使用
class Hello(Command):
def __init__(self, default_name='James', default_age=18):
self.default_name = default_name
self.default_age = default_age
def get_options(self):
"""
除了 get_options() 方法来获取命令参数，也可以定义 option_list 变量
option_list = (
Option('-n', '--name', dest='name', default=self.default_name),
Option('-a', '--age', dest='age', default=self.default_age)
)
"""
return [
Option('-n', '--name', dest='name', default=self.default_name),
Option('-a', '--age', dest='age', default=self.default_age)
]
def hellp(self, name, age):
print(f"Hello {name}, you are {age} old [From SubClass Command]")
manager.add_command('cHello', Hello())
if __name__ == '__main__':
# 注意这里被 manager.run()接管， 而不是app.run()
manager.run()
代码中都有详细备注说明。大家可以阅读注释和自己实操一遍，应该就能掌握
执行结果展示:
直接执行 python app.py 不添加任何参数时
具体命令执行结果展示
# python app.py sayHi
Hi Flask-script
# python app.py sayHello
Hello DefaltName, you are 18 old
# python demo.py sayHello --name Betty --age 30
Hello Betty, you are 30 old
# python app.py CHello --name Harry --age 31
Hello Harry, you're 31 old [From SubClass Command]
扩展
flask-script的作者也建议 从Flask 0.11开始，Flask包括一个内置CLI工具，这可能更适合您的需要
所以除了这个插件的学习，我们也可以了解下Flask内置CLI工具，官方文档参考 https://flask.palletsprojects.com/en/2.2.x/cli/。
在实际开发中，视情况而选择，后续介绍 Flask内置的CLI工具使用
