温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

怎么使用Flask Blueprint和SQLAlchemy编写Python应用程序

发布时间:2023-05-09 10:27:50 来源:亿速云 阅读:197 作者:iii 栏目:编程语言

本篇内容主要讲解“怎么使用Flask Blueprint和SQLAlchemy编写Python应用程序”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么使用Flask Blueprint和SQLAlchemy编写Python应用程序”吧!

    安装准备

    python3 -V && pip3 -V
    pip3 install pipenv
    pipenv
    pipenv 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_app
    app = create_app()
    if __name__ == '__main__':
        app.run(debug =True,port=81,host= '0.0.0.0')
    路由

    Flask是用蓝图实现的路由功能,在入口文件中添加注册蓝图的方法,实现引入和注册。

    from flask import Blueprint
    login = Blueprint('login', __name__)
    @login.route('/login')
    def loginIndex():
        return "login Hello"

    在app实例初始化时,引入蓝图模块

    from flask import Flask
    def create_app():
        app = Flask(__name__)
        # 导入config中的配置文件
        app.config.from_object('app.config.setting')
        app.config.from_object('app.config.secure')
        # 注册并导入蓝图
        register_blue(app)
        return app
    def 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 BaseRoutes
    api = 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 SQLAlchemy
    db = SQLAlchemy()
    class Base(db.Model):
        # 忽略基类的主键
        __abstract__ = True

    普通数据类继承Base类,以User类为例,使用之前引入db包

    from app.models.base import Base
    class 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, SmallInteger
    from app.models.base import Base, db
    class 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, jsonify
    from app.libs.BaseRoutes import BaseRoutes
    from app.validators.form.login import LoginForm
    from app.models.admin.tp_manager import tp_manager
    api = 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、redisNoSql数据库成了下一步要研究的问题。

    默认值和索引设置

    python源码包里的解释很清晰 还附带了例子 ,在Column中是这样设置的:

    Column(Integer, index=True, nullable=False,  server_default="0",comment="昵称")

    server_default Orm设置初始化Mysql的值,unique指定的是否为唯一索引,default是在SQLAlchemy进行CURD操作时进行的默认值,server_defauldefault的值必须是字符串类型的。

    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, Integer
    from sqlalchemy.dialects.mysql import VARCHAR, TEXT, BIGINT, INTEGER, SMALLINT, TINYINT, DECIMAL, FLOAT, \
        DOUBLE, DATETIME, TIMESTAMP, DECIMAL
    from app.models.base import Base, db
    class 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应用程序”有了更深的了解,不妨来实际操作一番吧!这里是亿速云网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

    向AI问一下细节

    免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

    AI