Flask Blueprint と SQLAlchemy を使用して Python アプリケーションを作成する方法

インストール準備

python3 -V && pip3 -V
pip3 install pipenv

pipenv

pipenv shell

PyCharmの環境構成についてはここではあまり説明しません。 ↑ コードを説明します。

練習を始める

Flask の原理は、アプリの初期化時にブループリントとアプリをバインドして Web ルーティング機能を実装することです。ルーティングの実装はすべてのプロジェクトの最初のステップです。

エントリー ファイル

プロジェクトを開始する前に、リクエストでアプリをインスタンス化できるようにエントリー ファイルを定義します。エントリー ファイルで行う必要があるのは、構成ファイルの初期化、コントローラーの導入、データベースやその他の操作。

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')

Routing

Flask はブループリントを利用して実装されたルーティング機能で、エントリファイルにブループリントを登録するメソッドを追加して導入と登録を実現します。

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

アプリ インスタンスの初期化時にブループリント モジュールを導入する

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 を使用するには、データベース ドライバー パッケージの 2 つのコンポーネントをインストールする必要があります。Flask-SQLAlchemy と PyMySQL の 2 つのコンポーネントをインストールすると、開発がより簡単かつ便利になります。

データベース クラスの定義

すべての Flask アプリケーションとプラグインは、アプリに登録し、オブジェクトを使用して操作する必要があります。最初にデータベース操作の基本クラスを定義し、他のクラスを使用します。モジュールはBaseに登録されます。

すべての DB のパブリック メソッドを Base に書き込み、車輪の再発明のプロセスを削減します。

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)

Entry ファイルをロードする 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 では、スタック データ構造は主にアプリ インスタンスの実行に使用されます。with キーワードはコンテキストを非常によく区別できます。リソースが切断されると、リソースは自動的に解放されてリサイクルされ、プログラムを最適化できます。

Mysql ドライバーは、cymysql または pymysql を使用できます。インターネット上には、pymysql の使用に関するチュートリアルが他にもあります。ドライバーを使用する際、迷った場合は、github にアクセスし、統計情報が多数あるプラグインを使用してください。 、人気のあるものを選択すると、さらに多くの解決策が表示されます。

モジュールで定義されたメソッド

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

ルーティングで使用する

ルーティングで使用する場合は、モデルに対応するモデル パッケージを導入する必要があります。以下は簡単なデモです。ユーザー権限で 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 がセッションを使用する前に、構成ファイルで SECRET_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, 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 型には 3 つのパラメータがあります:

display_width は列の型の幅を設定します。設定後は tinyint(1) が表示されます。2 番目の符号なしは正の値の範囲で、3 番目のゼロフィルは埋められます。値は数値型です。以下は 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 アプリケーションを作成する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。