［Python］Tkinter Treeviewの値取得でゼロ落ち

こんばんは。ざわです。

Pythonで実装したツールで、画面の一覧データをCSVファイルに出力したら

頭に0（ゼロ）がついているデータの 0部分がゼロ落ちして出力される現象がありました。

GUIにtkinter、一覧（表）は tkinter.ttk.Treeview ウィジェットを使っています。

原因など調べてみた結果と対応策について書いていきたいと思います。

現象

ゼロ落ち現象となるサンプルコードはこちらになります。

# サンプルコード
import tkinter as tk
from tkinter import ttk
import pandas as pd

# CSV出力ボタン押下
def btnCsvOutput_Click():  
    data = [tree.item(item)['values'] for item in tree.get_children()]
    df = pd.DataFrame(data)
    df.to_csv('sample.csv', encoding='shift-jis', header=False, index=False)

# メインウィンドウ生成
root = tk.Tk()
root.title('sample')
root.geometry('400x300')

# Treeview
column = ('ID', 'Name')
tree = ttk.Treeview(root, columns=column)
# 列設定
tree.column('#0',width=0, stretch='no')
tree.column('ID', anchor='w', width=100)
tree.column('Name',anchor='w', width=100)
# 列見出し設定
tree.heading('#0',text='')
tree.heading('ID', text='ID',anchor='w')
tree.heading('Name', text='Name', anchor='w')
# レコード追加
tree.insert(parent='', index='end', iid=0 ,values=('00001', 'AAAAA'))
tree.insert(parent='', index='end', iid=1 ,values=('00100', 'BBBBB'))
tree.insert(parent='', index='end', iid=2 ,values=('000XXXXX', 'CCCCC'))

# ウィジェット配置
tree.pack(pady=10)

btnCsvOutput = tk.Button(root, text='CSV出力', width=10, command=btnCsvOutput_Click)
btnCsvOutput.pack(pady=10)

root.mainloop()

これを実行した画面がこちら。

CSV出力した結果がこちら。

画面の表のID列には コードの29～31行目のレコード追加処理で書いた通り 0がついた状態で表示されていますが、

CSVには 0が消えて出力されています。

ただ、CSVの3行目のように 数値以外の文字が含まれる場合はゼロ落ちしていません。

対応方法

さて、何が原因でどう修正したらいいかなと調べた結果、こちらのサイトが参考になりました。

（フォーマットして0埋めしたら？というご意見もあると思いますが桁数が固定でないためフォーマットでは対処できず・・）

原因は、tkinter.ttk.Treeviewでは、整数に変換できる文字列は整数に変換してしまうようで、

それに該当するのが ttkの _convert_stringval()関数（＊1）のようです。

参考サイトでは、

自身のコードに、条件文によって整数に変換しない _convert_stringval()関数を実装し、

ttk._convert_stringvalをその関数で置き換えるようにしています。（＊2）

＊1：ttk.py の元の関数

def _convert_stringval(value):
    """Converts a value to, hopefully, a more appropriate Python object."""
    value = str(value)
    try:
        value = int(value)
    except (ValueError, TypeError):
        pass

    return value

　ttk.py はPythonのインストール先の tkinterフォルダにあります。

　（例 ： C:\Users\{ユーザID}\AppData\Local\Programs\Python\Python310\Lib\tkinter）

＊2：上記のサンプルコードに _convert_stringval()関数を追加した例

# サンプルコード
import tkinter as tk
from tkinter import ttk
import pandas as pd

def _convert_stringval(value):
    """Converts a value to, hopefully, a more appropriate Python object."""
    if hasattr(value, 'typename'):
        value = str(value)
        try:
            value = int(value)
        except (ValueError, TypeError):
            pass
    return value

ttk._convert_stringval = _convert_stringval

# CSV出力ボタン押下
def btnCsvOutput_Click():  
    data = [tree.item(item)['values'] for item in tree.get_children()]
    df = pd.DataFrame(data)
    df.to_csv('sample.csv', encoding='shift-jis', header=False, index=False)

# メインウィンドウ生成
root = tk.Tk()
root.title('sample')
root.geometry('400x300')

（以下略）

6～14行目に _convert_stringval()関数を追加しています。

（この関数は、ttkのimport後、ttk.Treeviewを使用するコードより前に追加すること）

8行目の if文が元関数から変更（追記）したコードになります。

16行目で ttk._convert_stringval を自身の関数で置き換えています。

これを実行してCSV出力した結果がこちら。

ID列のデータがゼロ落ちせず、正しく出力されるようになりました。

ここまで、ttk._convert_stringval()関数を変更する方法を書いてきましたが、

他のコードに影響を及ぼしそうでttkの関数を変更したくない、という場合もあるかと思います。

そういった場合の対応案として、Treeviewにinsertする時点でデータを pandasのDataFrameにセット（保持）しておき、

CSV出力処理時に Treeviewから出力データを取得するのではなく、保持したDataFrameデータを出力すればいいかと思います。

それではまたー。