flask-script模块的具体使用

目录

• 1 作用
• 2 安装
• 3 所有要运行的命令都放在 manager.py 中
• 4 三种方式 创建命令
• 4.1 方式一 创建 Command子类
  
• 4.2 方式二 使用装饰器 @manager.command
  
• 4.3 方式三 使用装饰器 @manager.option
  

1 作用

通过 flask-script 可以以命令的形式，执行 flask 语句。

提供向 Flask 插入外部脚本的功能，如 运行一个开发服务器、运行 shell、执行数据库脚本。

2 安装

pip install flask-script

3 所有要运行的命令都放在 manager.py 中

from flask import Flask
from flask_script import Manager, Command
from loguru import logger
 
# [ 生成一个 Flask 实例 ]
app = Flask(__name__)  
 
# [ Manager 构造方法，只接受一个参数，
# 就是 Flask 实例，Manager 负责追踪整个 命令 的处理过程 ]
manager = Manager(app)  

4 三种方式 创建命令

4.1 方式一 创建 Command子类

# 定义要执行的命令类型 Hello 继承 Command
class Hello(Command):
    # 重写 Command 类的 run() 方法
    def run(self):  
        ''' 要执行的命令 '''
        logger.info('sub class of Command')  
 
if __name__ == '__main__':
    '''
    将 hello 命令加入到 manager ，
    第一个参数为自己起的的命令简称，
    第二个参数为 Command 子类 Hello 的实例
    '''
    manager.add_command('hello', Hello())  
    manager.run()

在 cmd 执行 python manager.py hello [ hello 就是自己的 命令的简称 ]

这样就会打印出 sub class of Command

4.2 方式二 使用装饰器 @manager.command

'''
@manager.command 其实 manager 就是上面初始化出来的 Manager 类的实例，
如果 Manager 类的实例名称为 manager_1 ，则装饰器也要改成 @manager_1.command
'''
 
 
'''
使用 装饰器 @manager.command 后，命令的简称就是 函数的名字 hello_command，
在 __main__ 中 就不需要 在 通过 manager.add_command() 将 命令简称加入到 command 实例中了
'''
@manager.command
def hello_command(): 
    logger.info('@manager.command')
 
if __name__ == '__main__':
    '''
    在 __main__ 中 就不需要 在 通过 manager.add_command() 将 命令简称加入到 command 实例中了
    '''
    manager.run()  

在 cmd 执行 python manager.py hello_command [ hello_command 就是自己的 命令的简称 ]

这样就会打印出 @manager.command

4.3 方式三 使用装饰器 @manager.option

'''
-u 为命令参数的 简写，--username 为命令参数的 全称
（类似于 Linux 命令的参数，参数简写 为一个 -，参数全称为 -- ），
无论是参数的 简写、还是 全称 都必须以 - 开头，但是 全称也可以只以 一个 - 开头，
但建议以 两个 - 开头，因为更符合编码规范，dest 的值必须与 hello_option 函数（也就是命令）的 入参名
称 完全相同，因为 dest 就是表示这个参数值，传递给 hello_option 命令函数的那个入参的；default 表示
参数的默认值，也就是如果执行 python manager.py hello_option 执行命令时，不带参数，就用参数的默认
值
'''
@manager.option('-u', '--username', dest='username', default='zhangsan')  
@manager.option('-p', '--password', dest='password', default='123456')
def hello_option(username, password):
    logger.info('@manage.option')
    logger.info(f'username = {username}, password = {password}')
 
if __name__ == '__main__':
    '''
    在 __main__ 中 就不需要 在 通过 manager.add_command() 将 命令简称加入到 command 实例中了
    '''

到此这篇关于flask-script模块的具体使用的文章就介绍到这了,更多相关flask-script模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！