【Python】【MySQL】tkinter：MySQLから取得したデータをtreeviewに出力する

■実装するプログラムの概要

tkinterのGUI画面にて、「検索」ボタンを作成する。
「検索」ボタン押下時、以下の処理を実装する。

  • プルダウン「ALL」を選択した場合は、DBデータ全件をtreeviewに出力する。
  • プルダウン「ID」を選択した場合は、テキストボックスに対象のIDを入力し、該当のDBデータのみをtreeviewに出力する。

・ALLの処理概要図

・IDの処理概要図

■制約事項・前提条件

  • DB接続時、SQL実行時は例外処理を行う。
    例外が発生した場合は、メッセージボックスとコンソールにエラーを表示する。
  • 画面のプルダウンが「ALL」の場合、テキストボックスに値が入力されていても無視する。
  • 画面のプルダウンが「ID」の場合、テキストボックスに入力した値をWHERE句に指定する。
    なお、条件は「user_id = XXX」（※1）とする。

（※1）テーブルの構成については、「・テーブル仕様」参照。

■プログラム設計

本プログラムにて実装する処理は以下の通り。

関数名処理概要
MySQL接続処理ローカル環境に存在する、自作のDBへ接続する処理。
検索処理SQL（SELECT）を実行する処理。
画面のプルダウンが「ALL」の場合
→WHERE句なし。
画面のプルダウンが「ID」の場合
→WHERE句あり。
検索ボタン押下時の処理画面の「検索」ボタンを押下した時、以下の処理を行う。
①「MySQL接続処理」呼び出し
②「検索処理」呼び出し
③検索結果をTreeViewに表示

▼MySQL接続処理

「MySQL接続処理」における、「プログラム処理フロー図」および「DB接続情報」を示す。

・プログラム処理フロー図

・DB接続情報

項目値概要
useruser001MySQL接続時のユーザ
passwordaaaMySQL接続時のユーザに対するパスワード
host127.0.0.1DBが存在するホスト
※今回はローカルホスト
port3306MySQL接続時のポート
databasetest_schema接続するデータベース
※ここではテストスキーマ
auth_pluginmysql_native_passwordパスワード認証方式

▼検索処理

「検索処理」における「プログラム処理フロー図」および「テーブル仕様」について示す。

・プログラム処理フロー図

・テーブル仕様

column型PKNNUQAI備考
table_idINT○○–○テーブル内管理ID
user_idVARCHAR(45)–○○–ユーザID
user_nameVARCHAR(45)–○––ユーザ名

PK：Primary Key
NN：Not Null
UQ：Unique
AI：Auto Increment

▼検索ボタン押下時の処理

「検索ボタン押下時の処理」における、「プログラム処理フロー図」について示す。

・プログラム処理フロー図

■サンプルコード

import mysql.connector
import tkinter as tk
from tkinter import ttk
import tkinter.messagebox as msg


# MySQLの接続情報
MYSQL_USER = 'user001'
MYSQL_PASSWORD = 'aaa'
MYSQL_HOST = '127.0.0.1'
MYSQL_PORT = '3306'
MYSQL_DATABASE = 'test_schema'
MYSQL_AUTH = 'mysql_native_password'

# SQL(SELECT)
SQL_SELECT_ALL = "SELECT * FROM test_table"
SQL_SELECT_WHERE = SQL_SELECT_ALL + " WHERE table_id = %s"

# プルダウンの設定値
BASE_LIST_SELECT_KBN = ['ALL', 'ID']

# Mysql接続処理
def connector_mysql():
    # 接続情報の初期化
    con = None

    try:
        # mysqlに接続
        con = mysql.connector.connect(
            user=MYSQL_USER
            , password=MYSQL_PASSWORD
            , host=MYSQL_HOST
            , database=MYSQL_DATABASE
            , auth_plugin=MYSQL_AUTH
        )
        
    except Exception as e:
        # 例外エラーはコンソールへ出力
        print(e)
        
    finally:
        return con

# 検索処理
def select_table(conn):
    # 検索結果初期化
    rows = None
    
    try:
        # カーソル作成：出力形式は辞書型
        cursor = conn.cursor(dictionary=True)
        
        # プルダウン[ALL]：WHERE句なしで検索
        if select_kbn.get() == BASE_LIST_SELECT_KBN[0]:
            # select実行
            cursor.execute(SQL_SELECT_ALL)

        # プルダウン[ID]：WHERE句つきで検索
        elif select_kbn.get() == BASE_LIST_SELECT_KBN[1]:
            # 入力値を取得
            param = select_id.get()
            # select 実行
            cursor.execute(SQL_SELECT_WHERE, (param,))   

        # 全件取得
        rows = cursor.fetchall()  

        # カーソルクローズ
        cursor.close
    
    except Exception as e:
        # 例外エラーはコンソールへ出力
        print(e)
    
    finally:
        return rows


# 検索ボタン押下処理
def btn_select_click():
    # treeviwの初期化
    tree.delete(*tree.get_children())

    # Mysql接続処理
    connector = connector_mysql()
    
    # Mysql接続失敗処理
    if connector == None:
        msg.showinfo("DB接続エラー", "データベース接続に失敗しました。")
              
        return
    
    # 検索処理
    row_data = select_table(connector)
    
    # 検索失敗処理    
    if row_data == None:
        msg.showinfo("検索エラー", "SELECTに失敗しました。")
        
        return

    # 検索結果出力
    if len(row_data) == 0:
        msg.showinfo("検索結果", "検索結果：0件です")
    else:
        for row in row_data:
            tree.insert(
                parent="", index="end", values=(row["user_id"], row["user_name"]))


# メイン処理
if __name__ == '__main__':
    # ウィンドウの設定
    base = tk.Tk()
    base.title("ID検索")
    canvas = tk.Canvas(base, width=550, height=400, bd=0, highlightthickness=0)
    canvas.pack()

    #入力値を保持
    select_kbn = tk.StringVar()
    select_id = tk.StringVar()

    #検索フォーム
    cb_select_kbn = ttk.Combobox(
        base, 
        state="readonly", 
        width=5, 
        values=BASE_LIST_SELECT_KBN, 
        textvariable=select_kbn)
    cb_select_kbn.set(BASE_LIST_SELECT_KBN[0])
    cb_select_kbn.place(x=100, y=20)
    tx_String_search_data = tk.Entry(base, textvariable=select_id)
    tx_String_search_data.place(x=180, y=20)

    # 検索ボタン
    btn_search_all = tk.Button(base, text="検索", command=btn_select_click)
    btn_search_all.place(x=380, y=25)

    # Treeviewの設定
    tree = ttk.Treeview(base, columns=(0, 1))
    tree["show"] = "headings"
    tree.column(0, width=200)
    tree.column(1, width=300)
    tree.heading(0, text='ID')
    tree.heading(1, text='Name')
    tree.place(x=10, y=100)

    # 画面表示
    base.mainloop()

■実行結果

▼正常系

・プルダウン「ALL」を選択した場合

・プルダウン「ID」を選択した場合

▼異常系

・DBを停止した状態で「検索」ボタンを押下した場合

・存在しないテーブル名で「検索」ボタンを押下した場合

一時的に、以下の定数（SQL文）を変更する。

# 変更前
SQL_SELECT_ALL = "SELECT * FROM test_table"

# 変更後
SQL_SELECT_ALL = "SELECT * FROM test_tables"

■参考

▼外部リンク

・MySQL（Select文）ーPython

Python で MySQL - データ取得 (select)
Python を初めて学ぶ人のための学習サイトです。 プログラミングに慣れていない方にもわかりやす説明しています。
python.softmoco.com

▼内部リンク

・GitHub

anotools_module/python/tkinter/ConnectMysql at master · eiiga/anotools_module
Contribute to eiiga/anotools_module development by creating an account on GitHub.
github.com

・TreeView

【Python】 tkinter csvファイルを読み込み、検索結果をTreeviewに表示する
■csvファイルを読み込み、検索結果をTreeviewに表示するpandasにてcsvファイル読み込み、tkinter、Treeviewを使用して、読み込んだデータをTreeviewに表示させる。表示方法は以下の通り。入力フォームを作成し、...
anotools.com
2021.07.21
タイトルとURLをコピーしました