flask-script笔记

flask-script 使用

Flask-Script 的作用是可以通过命令行的方式来操作 Flask。例如通过命令跑一个开发版本的服务器、设置数据库、定时任务等。
要使用 Flask-Script,可以通过 pip install flask-script来安装。

demo

# manage.py

from flask_script import Manager
from you_app import app

manager = Manager(app)

@manager.command
def hello():
    print('hello')

if __name__ == '__main__':
    manager.run()

把代码放在 manager.py 文件中,然后在终端执行 python manage.py hello命令,就可以看到终端输出 'hello'。

定义命令的三种方法

1. 使用 @command 装饰器

示例代码如上面的demo。

2. 使用类继承自 Command 类:

from flask_script import Command,Manager
from your_app import app

manager = Manager(app)

class Hello(Command):
    """print hello world"""
    def run(self):
        print('hello,world')

manager.add_command('hello',Hello())

使用类的方式,有3点要注意:

  1. 必须继承自 Command 基类
  2. 必须实现 run 方法
  3. 必须通过 add_command 方法添加命令

3. 使用 option 装饰器:

如果需要在使用命令的时候传递参数,那么使用 @option 装饰器更加方便:

@manager.option('-n','--name',dest='name')
def hello(name):
    print('hello {}'.format(name))

调用时使用:

python manage.py -n ck 
# 或者
python manage.py --name ck

可以输出:

hello ck

添加参数到命令中

以上3中创建命令的方式都可以添加参数

* option 装饰器

@manager.option('-n', '--name', dest='name')
@manager.option('-a', '--age', dest='age',defaut=20)
def add_user(name, age):
    print('您添加的用户姓名是:{} 年龄是:{}'.format(name, age))

可以通过 deault指定参数默认值

* command 装饰器:

也可以添加参数,只是不是那么灵活

@manage.command
def hello(name='flask')
    print('hello {}'.format(name))

* 类继承:

通过类继承的命令也能添加参数,示例如下:

class Hello(Command):
    option_list = {
        Option('--name','-n',dest='name')
    }
    def run(self,name):
        print('hello,world')

如果要在指定参数的时候,动态地做一些事情,可以使用 get_option 方法,示例如下:

class Hello(Command):
    def __init(self,default_name='ck'):
        self.default_name = default_name

    def get_option(self):
        return {
            Option('-n','--name',dest='name',default=default_name),
        }

    def run(self.name):
        print('hello,{}'.format(name))

案例:

案例1: 添加后台管理人员到数据库

# file:
#! /usr/bin/env python
# -*- coding:utf-8 -*-
# author:chenkuan 
# time:2019/10/17
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
import config

app = Flask(__name__)
app.config.from_object(config)
db = SQLAlchemy(app)


class BackUser(db.Model):
    __tablename__ = 'backend_user'
    id = db.Column(db.Integer, autoincrement=True, primary_key=True)
    user = db.Column(db.String(50), nullable=False)
    email = db.Column(db.String(50), nullable=False)


db.create_all()  # 用这种简单粗暴的方式来映射到数据库,开发环境不能这样操作


@app.route('/')
def index():
    return 'index'


if __name__ == '__main__':
    app.run()

# file: manager.py
from flask_script import Manager
from app import app, BackUser, db


@manager.option('-u', '--username', dest='username')
@manager.option('-e', '--email', dest='email')
def add_back_user(username, email):
    """
    添加 后台用户到数据库
    :param username: 用户名
    :param email: 用户邮箱
    :return:
    """
    user = BackUser(user=username, email=email)
    db.session.add(user)
    db.session.commit()


if __name__ == '__main__':
    manager.run()

使用方式: python manager.py add_back_user -u '管理员' -e '18181347287@163.com'

案例2: 做数据库迁移映射(方便管理)

# file: db_script.py

from flask_script import Manager

db_manager = Manager()


@db_manager.command
def init():
    # 模拟操作
    print('迁移仓库创建完毕...')


@db_manager.command
def revision():
    # 模拟操作
    print('迁移脚本生成成功...')


@db_manager.command
def upgrade():
    # 模拟操作
    print('脚本映射到数据库成功...')

# file:manager.py

from flask_script import Manager
from app import app, BackUser, db
from db_script import db_manager

manager = Manager(app)
manager.add_command('db', db_manager)



if __name__ == '__main__':
    manager.run()

使用方式: python manager.py db init/revision/upgrade

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,817评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,329评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,354评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,498评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,600评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,829评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,979评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,722评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,189评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,519评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,654评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,940评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,762评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,993评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,382评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,543评论 2 349

推荐阅读更多精彩内容

  • Flask-Script: Flask-Script的作用是可以通过命令行的形式来操作Flask。例如通过命令跑一...
    yungege阅读 561评论 1 0
  • Flask-Script: 如果想深入学习Flask,可以观看这套免费Flask教学视频:零基础:Flask入门到...
    编程小蝉阅读 840评论 0 1
  • URL和视图 安装Homebrew 在终端输入以下代码,安装Homebrew: Python安装 mac环境下默认...
    云中的Jason阅读 1,265评论 0 4
  • 官网 中文版本 好的网站 Content-type: text/htmlBASH Section: User ...
    不排版阅读 4,370评论 0 5
  • 这几天想学新东西,就看了flask框架,本身对python不太了解,网上的很多教程看了,总是在某些地方卡住。翻到一...
    易木成华阅读 2,224评论 0 11