通过脚本将flask扩展到seed数据库
Flask-Seeder的Python项目详细描述
砂箱播种机
Flask Seeder是一个Flask扩展,用于帮助对数据库进行初始数据播种,例如在第一次部署应用程序时。
这个扩展的主要关注点是帮助填充数据一次,例如在演示应用程序中,数据库可能会一次又一次地被清除,但是您仍然希望用户可以使用一些基本数据。
安装
pip install Flask-Seeder
这将安装flask seeder扩展并添加一个flask seed
子命令,检查它以查看支持哪些参数!
播种机
flask seeder提供了一个基类Seeder
,其中包含一个数据库句柄。
通过对Seeder
进行子类化并实现一个run()
方法,您可以访问数据库句柄对象,并可以开始在数据库中植入数据。
所有播种机必须位于seeds/
目录中的某个位置,并从Seeder
继承,否则将无法检测到它们。
当所有播种机都已完成(成功与否)时,Flask Seeder将默认向数据库提交所有更改。此行为可以用--no-commit
或设置环境变量FLASK_SEEDER_AUTOCOMMIT=0
重写。
伪造者和生成器
flask seeder提供了一个Faker
类,该类基于真实模型控制伪对象的创建。通过告诉Faker
如何创建对象,您可以轻松地创建许多不同的唯一对象,以便在为数据库设定种子时提供帮助。
有不同的生成器可以帮助生成伪对象的值。 当前支持的生成器是:
- 整数:在两个值之间创建一个随机整数
- sequence:如果多次调用,则按顺序创建整数
- 名称:从列表中创建随机名称
data/names/names.txt
可以通过子类化Generator
来滚动自己的生成器,并实现返回生成值的generate()
方法。
示例用法
示例仅显示相关的代码片段
app.py:
fromflaskimportFlaskfromflask_sqlalchemyimportSQLAlchemyfromflask_seederimportFlaskSeedercreate_app():app=Flask(__name__)db=SQLAlchemy()db.init_app(app)seeder=FlaskSeeder()seeder.init_app(app,db)returnapp
seeds/demo.py:
fromflask_seederimportSeeder,Faker,generator# SQLAlchemy database modelclassUser(Base):def__init__(self,id_num=None,name=None,age=None):self.id_num=id_numself.name=nameself.age=agedef__str__(self):return"ID=%d, Name=%s, Age=%d"%(self.id_num,self.name,self.age)# All seeders inherit from SeederclassDemoSeeder(Seeder):# run() will be called by Flask-Seederdefrun(self):# Create a new Faker and tell it how to create User objectsfaker=Faker(cls=User,init={"id_num":generator.Sequence(),"name":generator.Name(),"age":generator.Integer(start=20,end=100)})# Create 5 usersforuserinfaker.create(5):print("Adding user: %s"%user)self.db.session.add(user)
shell
$ flask seed run Running database seeders Adding user: ID=1, Name=Fancie, Age=76 Adding user: ID=2, Name=Shela, Age=22 Adding user: ID=3, Name=Jo, Age=33 Adding user: ID=4, Name=Laureen, Age=54 Adding user: ID=5, Name=Tandy, Age=66 DemoSeeder... [OK] Committing to database!