【Flask】Flask-SQLAlchemyでデータベースを操作しよう｜Chapter5-7

pip install Flask-SQLAlchemy

import secrets							# セキュアなランダム値生成用の標準ライブラリ（Python 3.6以降推奨）
from pathlib import Path				# pathlibライブラリのPathクラスをインポート
from flask import Flask                 # Flaskをインポート
from flask_sqlalchemy import SQLAlchemy # SQLAlchemy：DBとPythonクラスを紐づけるライブラリ

app = Flask(__name__)                   # Flaskアプリケーションのインスタンス生成

# ------ Flaskに関する設定 ------
# セッション保護用のランダムな秘密鍵を設定
app.config['SECRET_KEY'] = secrets.token_hex(24) #24バイトのランダムバイト列を作成し、SECRET_KEYというキー名で辞書に追加

# DBファイルの設定
base_dir = Path(__file__).parent	# このスクリプトファイルがあるフォルダのパスを取得して、変数base_dirに代入
database = base_dir / 'data.sqlite'	# base_dir内のdata.sqliteというファイルへのパスを作成し、変数databaseに代入

app.config['SQLALCHEMY_DATABASE_URI'] = database	 # DBのパスをSQLALCHEMY_DATABASE_URIというキー名で辞書に追加
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False # SQLAlchemyの「変更追跡機能」を無効化にしてメモリ使用を軽減

# db変数を使用してSQLAlchemyを操作
db = SQLAlchemy(app) # SQLAlchemyオブジェクトをインスタンス生成して変数dbへ代入
    # このdbを使って「モデル定義」や「データベースへの登録・更新・削除」などの操作ができるようになる

# 読み終わった本テーブル
class BookLog(db.Model): # db.Modelクラスを継承したBookLogクラスの定義
    # テーブル名
    __tablename__ = 'book_logs'
    # Columnクラスを使ってテーブルの列を２つ定義
    id = db.Column(db.Integer, primary_key=True, autoincrement=True) # 書籍ID（種キー, 連番）
    title = db.Column(db.String(200), nullable=False)				 # 書籍のタイトル（入力必須）
    # 表示用関数
    def __str__(self):
        return f"書籍ID：{self.id} タイトル：{self.title}"

# ------ DB作成 ------
def init_db():              # DBを作成するinit_db()関数を定義
    with app.app_context(): # Flaskの「アプリケーションコンテキスト」を有効化
                            # これにより「db.session」を使った操作が可能になる
        print('テーブルを削除してから作成')
        db.drop_all()       # 既存のテーブルを全て削除（初期化）
        db.create_all()     # モデル（BookLog）に基づいてテーブルを作成

        # データ作成
        print("データ登録：実行")
        book_log01 = BookLog(title='ノルウェイの森') # BookLogクラス（モデル）をインスタンス生成し、book_log01に代入
        book_log02 = BookLog(title='1Q84')			# 同上
        book_log03 = BookLog(title='容疑者Xの献身')  # 同上
        db.session.add_all([book_log01, book_log02, book_log03]) # まとめて登録
        db.session.commit() # データベースに保存

# ------ テーブル操作（CRUD操作） ------
# 登録
def insert(): # データを登録するinsert()関数を定義
    print('1件登録')
    with app.app_context(): # Flaskの「アプリケーションコンテキスト」を有効化
        book_log04 = BookLog(title='博士の愛した数式') # BookLogクラスをインスタンス生成し、book_log04に代入
                                                      # 「title='博士の愛した数式'」はPythonのキーワード引数
        db.session.add(book_log04) # book_log04をセッションに追加
        db.session.commit()        # セッションをデータベースに反映（保存）
        print('登録 ->', book_log04)

# 全件参照
def select_all(): # データを全件参照するselect_all()関数を定義
    print('全件取得')
    with app.app_context():
        book_logs = BookLog.query.all() # BookLogクラスのquery属性のall()メソッドで全データを取得し、変数book_logsに代入
        for book_log in book_logs:
            print (book_log)

# 1件参照
def select_filter_pk(pk): # データを1件参照するselect_filter_pk()関数を定義
    print('1件取得')
    with app.app_context():
        target = BookLog.query.filter_by(id = pk).first()
            # BookLog.queryでクエリを開始し、filter_by(id=pk)でIDが一致するものを絞り込み
            # .first()で最初の1件だけ取得してtargetに代入（該当なしならNoneになる）
        print('取得結果 ->', target)

# 更新
def update(pk): # データを更新するupdate()関数を定義
    print('更新実行')
    with app.app_context():
        target = BookLog.query.filter_by(id = pk).first() # query属性で検索条件を指定し、idがpkと一致する最初の1件を取得してtargetに代入
        print('更新前 ->', target)
        target.title = 'タイトルを変更'
        db.session.add(target) # targetをセッションに追加
        db.session.commit()    # セッションをデータベースに反映（保存）

# 削除
def delete(pk): # データを削除するdelete()関数を定義
    print('削除処理')
    with app.app_context():
        target = BookLog.query.filter_by(id = pk).first() # query属性で検索条件を指定し、idがpkと一致する最初の1件を取得してtargetに代入
        db.session.delete(target) # targetをセッションから削除
        db.session.commit()       # セッションをデータベースに反映（保存）
        print('削除 ->', target)

# ------ 実行 ------
if __name__ == '__main__':
    init_db()
    insert()
    update(1)
    select_filter_pk(1)
    delete(2)
    select_all()