Flask-Script Manager

Posted fengff

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Flask-Script Manager相关的知识,希望对你有一定的参考价值。

Flask Script扩展提供向Flask插入外部脚本的功能,包括运行一个开发用的服务器,一个定制的Python shell,设置数据库的脚本,cronjobs,及其他运行在web应用之外的命令行任务;使得脚本和系统分开;

Flask Script和Flask本身的工作方式类似,只需定义和添加从命令行中被Manager实例调用的命令;

官方文档:http://flask-script.readthedocs.io/en/latest/

1 创建并运行命令

首先,创建一个Python模板运行命令脚本,可起名为manager.py;
在该文件中,必须有一个Manager实例,Manager类追踪所有在命令行中调用的命令和处理过程的调用运行情况;

Manager只有一个参数——Flask实例,也可以是一个函数或其他的返回Flask实例;
调用manager.run()启动Manager实例接收命令行中的命令;

#-*-coding:utf8-*-  
from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
  
if __name__ == ‘__main__‘:  
    manager.run()  

其次,创建并加入命令;
有三种方法创建命令,即创建Command子类、使用@command修饰符、使用@option修饰符;

第一种——创建Command子类
Command子类必须定义一个run方法;
举例:创建Hello命令,并将Hello命令加入Manager实例;

#-*-coding:utf8-*-  
from flask_script import Manager  
from flask_script import Command  
from debug import app  
  
manager = Manager(app)  
  
class Hello(Command):  
    ‘hello world‘  
    def run(self):  
        print ‘hello world‘  
  
manager.add_command(‘hello‘, Hello())  
  
if __name__ == ‘__main__‘:  
    manager.run()  

执行如下命令:

python manager.py hello
> hello world

第二种——使用Command实例的@command修饰符

#-*-coding:utf8-*-  
from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
 
@manager.command  
def hello():  
    ‘hello world‘  
    print ‘hello world‘  
  
if __name__ == ‘__main__‘:  
    manager.run()  

该方法创建命令的运行方式和Command类创建的运行方式相同;

python manager.py hello
> hello world

第三种——使用Command实例的@option修饰符
复杂情况下,建议使用@option;
可以有多个@option选项参数;

#-*-coding:utf8-*-  
from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
 
@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):  
    ‘hello world or hello <setting name>‘  
    print ‘hello‘, name  
    print url  
  
if __name__ == ‘__main__‘:  
    manager.run()  

运行方式如下:

python manager.py hello
>hello world
>www.csdn.com

python manager.py hello -n sissiy -u www.sissiy.com
> hello sissiy
>www.sissiy.com


作者:氨基钠
链接:https://www.jianshu.com/p/8148e81b42de
来源:简书
简书著作权归作者所有,任何形式的转载都请联系作者获得授权并注明出处。

以上是关于Flask-Script Manager的主要内容,如果未能解决你的问题,请参考以下文章

02.flask-script

Flask:Flask-script插件

8---Flask-Script

使用 flask-script

Flask-Script模块

flask-script插件