Flask Script扩展提供向Flask插入外部脚本的功能,包括运行一个开发用的服务器,一个定制的Python shell,设置数据库的脚本,cronjobs,及其他运行在web应用之外的命令行任务;使得脚本和系统分开;
Flask Script和Flask本身的工作方式类似,只需定义和添加从命令行中被Manager实例调用的命令;
官方文档:http://flask-script.readthedocs.io/en/latest/
创建并运行命令
首先,创建一个Python模板运行命令脚本,可起名为manager.py;
在该文件中,必须有一个Manager实例,Manager类追踪所有在命令行中调用的命令和处理过程的调用运行情况;
Manager只有一个参数——Flask实例,也可以是一个函数或其他的返回Flask实例;
调用manager.run()启动Manager实例接收命令行中的命令;
manager.py
from flask_script import Manager
from app import create_app, db
app = create_app("settings.ProductionConfig")
manager = Manager(app) # 实例化Manager实例
# 第一种创建命令方式,init_db函数名即为命令名,函数中参数则为命令参数 `python manage.py init_db 123`
@manager.command
def init_db(arg):
print(arg)
with app.app_context():
db.create_all()
# 第二种创建命令方式
def hello(arg):
print(arg)
manager.add_command('hello', hello())
# 第三种——使用Command实例的@option修饰符,复杂情况下,建议使用@option;可以有多个@option选项参数;
@manager.option('-n', '--name', dest='name', help='Your name', default='world')
@manager.option('-u', '--url', dest='url', default='www.csdn.com')
def hello(name, url):
print('hello', name)
print(url)
# flask_migrate使用
'''
在实际的开发环境中,经常会发生数据库修改的行为。一般我们修改数据库不会直接手动的去修改,而是去修改ORM对应的模型,然后再把模型映射到数据库中。这时候如果有一个工具能专门做这种事情,就显得非常有用了,而flask-migrate就是做这个事情的。flask-migrate是基于Alembic进行的一个封装,并集成到Flask中,而所有的迁移操作其实都是Alembic做的,他能跟踪模型的变化,并将变化映射到数据库中。
'''
from flask_migrate import Migrate, MigrateCommand
# 要让Flask-Migrate能够管理app中的数据库,需要使用Migrate(app,db)来绑定app和数据库
migrate = Migrate(app, db)
# 创建命令
manager.add_command('db', MigrateCommand)
"""
数据库迁移命令
python manage.py db init
python manage.py db migrate
python manage.py db upgrade
"""
if __name__ == "__main__":
manager.run() # 启动