您好,欢迎访问一九零五行业门户网

如何使用Flask Blueprint和SQLAlchemy编写Python应用程序

安装准备python3 -v && pip3 -vpip3 install pipenv
pipenvpipenv shell
pycharm的环境配置在这里就不做过多解释了,这里针对后续的代码进行讲解。
开始实践flask 原理是在app初始化时,将蓝图和app进行绑定来实现web路由功能,路由的实现是所有项目中的第一步。
入口文件在项目开始之前,定义一个入口文件,让请求实例化app,入口文件需要做的是初始化配置文件、引入控制器、初始化数据库等操作。
def create_app(): app = flask(__name__) # 导入config中的配置文件 app.config.from_object('app.config.setting') app.config.from_object('app.config.secure') return app
在启动文件中进行调用,启动文件中需要加入判断,原因后续再做解释。
from app.app import create_appapp = create_app()if __name__ == '__main__': app.run(debug =true,port=81,host= '0.0.0.0')
路由flask是用蓝图实现的路由功能,在入口文件中添加注册蓝图的方法,实现引入和注册。
from flask import blueprintlogin = blueprint('login', __name__)@login.route('/login')def loginindex(): return "login hello"
在app实例初始化时,引入蓝图模块
from flask import flaskdef create_app(): app = flask(__name__) # 导入config中的配置文件 app.config.from_object('app.config.setting') app.config.from_object('app.config.secure') # 注册并导入蓝图 register_blue(app) return appdef register_blue(app): from app.api.login import login app.register_blueprint(login)
优化路由器在每一个路由器中可以添加一个装载器,在初始化来依次加载flask中的蓝图,已到达优化路由器的目的。
class baseroutes: def __init__(self, name): self.name = name self.loader = [] def route(self, rule, **options): def decorator(f): self.loader.append((f, rule, options)) return f return decorator def register(self, bp, url_prefix=''): # 依次注册蓝图 for f, rule, options in self.loader: endpoint = options.pop("endpoint", f.__name__) bp.add_url_rule(url_prefix + rule, endpoint, f, **options)
api文件中使用优化后的装载器代码如下:
from app.libs.baseroutes import baseroutesapi = baseroutes('login')@api.route('/login/loginhandle', methods=['get', 'post'])def loginhandle(): return "login hello"
sqlalchemy对web的路由完成后,我们开始对数据库的增删改查进行进一步的实践和探索,flask使用sqlalchemy进行对数据库的操作,这里我们以mysql数据库为例。
使用sqlalchemy需要安装数据库+驱动包两个组件,安装 flask-sqlalchemy + pymysql 两个组件,会使我们的开发变的更加简洁和方便。
database类的定义对于flask的所有应用和插件而言,都需要注册在app实力中,使用对象进行操作,先定义数据库操作的基类,让其他的模块注册在base中。
base中写入所有db中的公共方法,以减少重复造轮子的过程。
base 中实例化sqlalchemy
from flask_sqlalchemy import sqlalchemydb = sqlalchemy()class base(db.model): # 忽略基类的主键 __abstract__ = true
普通数据类继承base类,以user类为例,使用之前引入db包
from app.models.base import baseclass user(base): __tablename__ = 'user' id = column(integer, primary_key=true, autoincrement=true) name = column(string(50), nullable=false, default="") email = column(string(120), nullable=false, default="") _password = column('password',string(64)) @property def password(self): return self._password @password.setter def password(self, raw): self._password = generate_password_hash(raw)
入口文件加载db在加载数据时需要加载数据库初始化的配置,使用sqlalchemy_database_uri指定,有指定的格式。
sqlalchemy_database_uri = 'mysql+pymysql://root:123456@127.0.0.1:3306/admin?charset=utf8'
sqlalchemy_database_uri =数据库+驱动名称://用户名:密码@ip地址:端口号/数据库名称
def create_app(): app = flask(__name__) app.config.from_object('app.config.secure') # 初始化数据库 db.init_app(app) with app.app_context(): db.create_all() return app
说明和解释一下with关键字的作用,在python中主要使用的是栈数据结构来运行app实例,with关键字能很好的区分上下文,当资源断开时会自动释放和回收,对程序能启到优化的作用。
mysql的驱动可以使用cymysql,也可以使用pymysql,网上使用pymysql的教程会偏多一点,使用驱动时,如果拿不定主意去github上使用stat数多的插件,选大众型的,这样解决方案也会多一点。
模块中定义方法model中可以定义模型,常量,直接操作数据库的原子方法,也可以使用db.session的形式来读取数据。
from sqlalchemy import column, integer, string, smallintegerfrom app.models.base import base, dbclass tp_manager(base): status_normal = 1 status_stop = 0 # ... @classmethod def get_manager_by_name(cls, username): r = cls.query.filter(cls.username == username, cls.status == cls.status_normal).one() return r @classmethod def get_db(cls): r = db.session.query(cls).filter(cls.status == cls.status_normal).all() return r
在路由中的使用在路由中使用时,需要引入models中对应的model包,下面是一个简单使用的demo,用户的权限可以使用falsk-login组件来存储用户信息。
from flask import request, session, jsonifyfrom app.libs.baseroutes import baseroutesfrom app.validators.form.login import loginformfrom app.models.admin.tp_manager import tp_managerapi = baseroutes('login')@api.route('/login/loginhandle', methods=['post'])def loginhandle(): form = loginform(request.form) if form.validate(): # 验证通过的逻辑 r = tp_manager.get_manager_by_name(form.username.data) if r: msg = '操作成功' session['manager_id'] = r.id else: msg = '账号和密码错误' return jsonify({"code": 200, "data": [], "msg": msg}) else: # 错误暂时忽略... return form.errors
顺便写一句,flask在使用session前,在配置文件中需要配置secret_key,不然会报错,key值自定义即可。
secret_key = '需要加密的key值'
sqlalchemy实现mysql编码、列类型在sqlalchemy 对mysql实现了基本操作以后,我发现设置出来的默认值没有生效,字符集编码也被设置成了默认的latin1,优化mysql的列类型,实现mysql连接池、接入mongo、redis等nosql数据库成了下一步要研究的问题。
默认值和索引设置python源码包里的解释很清晰 还附带了例子 ,在column中是这样设置的:
column(integer, index=true, nullable=false, server_default="0",comment="昵称")
server_default orm设置初始化mysql的值,unique指定的是否为唯一索引,default是在sqlalchemy进行curd操作时进行的默认值,server_defaul和default的值必须是字符串类型的。
index是设置索引,nullable设置是否为空,comment设置的是备注信息。
兼容mysql列类型但是摆在眼前一个问题,你想使用tinyint类型,字符集怎么设置?
from sqlalchemy.dialects.mysql import varchar, text, bigint, integer, smallint, tinyint, decimal, float, \ double, datetime, timestamp, decimal
以使用最多的int和varchar为例,使用之前要导入对应的包:
from sqlalchemy import column, index, integerfrom sqlalchemy.dialects.mysql import varchar, text, bigint, integer, smallint, tinyint, decimal, float, \ double, datetime, timestamp, decimalfrom app.models.base import base, dbclass wm_user_user(base): status_normal = 1 __tablename__ = 'wm_user_user' user_status = column(tinyint(display_width=1,unsigned=true), nullable=false, server_default="1", comment="1为正常,0为审核中") user_nickname = column(varchar(length=50), index=true, nullable=false, comment="昵称") # 添加配置设置编码 __table_args__ = { 'mysql_charset': 'utf8mb4', 'mysql_collate': 'utf8mb4_general_ci' }
tinyint类型中有三个参数:
display_width 设置的是列类型宽度,设置完以后会显示tinyint(1),第二个unsigned 是否是取正值的取值范围,第三个zerofill是否填充,值是一个数字类型,下面是tinyint的源码使用说明。
"""construct a tinyint.:param display_width: optional, maximum display width for this number.:param unsigned: a boolean, optional.:param zerofill: optional. if true, values will be stored as strings left-padded with zeros. note that this does not effect the values returned by the underlying database api, which continue to be numeric."""
简单在介绍一下,以varchar为代码的字符串类型,字符串类型是必须显示声明字符串长度,用length实现,不加入length的值在初始化会发生错误。
自定义数据库名和字符集编码__tablename__设置的是自定义数据表名,底下的设置的是数据表字符集编码,要使用utf8mb4编码和utf8mb4_general_ci编码,这里就不做过多的解释了。
__tablename__ = 'wm_user_user'# ...__table_args__ = { 'mysql_charset': 'utf8mb4', 'mysql_collate': 'utf8mb4_general_ci'}
以上就是如何使用flask blueprint和sqlalchemy编写python应用程序的详细内容。
其它类似信息

推荐信息