【Python】【Tkinter】Checkboxの値を複数取得したい

Question

前提・実現したいこと

Tkinterのチェックボックスを複数配置し、チェックボックスを押したときに値(True、False)を取得する関数をつくりたいです。

発生している問題・エラーメッセージ

Tkinterで9×5の配置で、チェックボックスを配置する処理および値を取得する処理はexec関数を用いて、実装しました。
また、チェックボックスの項目は45個あります。
以下は、実装したときのコードです。

from tkinter import *
from tkinter import ttk

root = Tk()
root.title('Checkbutton')

frame1 = ttk.Frame(root, padding=(10))
frame1.grid()

# 9 × 5の行列
for i in range(9): # 行
    for j in range(5): # 列
        exec('v{} = BooleanVar()'.format(j+5*i+1))
        exec('v{}.set(False)'.format(j+5*i+1))
        exec("""cb{} = ttk.Checkbutton(
        frame1, padding=10, text='test{}',
        variable=v{},
        command=lambda: print('v{} = %s' % v{}.get()))""".format(j+5*i+1, j+i*5+1, j+5*i+1, j+5*i+1, j+5*i+1, j+5*i+1))
        exec("cb{}.grid(row={}, column={})".format(j+5*i+1, i, j))
        print("cb{}.grid(row={}, column={})".format(j+5*i+1, i, j))

root.mainloop()

実行すると、以下のような画面が表示され、チェックボックスを押したり押さなかったりすると、v1 = True,v2 = True、v3 = False、v3 = Trueが取得できます。

しかし、以下のコードのように関数化すると、取得できなくなります。

from tkinter import *
from tkinter import ttk

root = Tk()
root.title('Checkbutton')


def main():
    # Frame
    frame1 = ttk.Frame(root, padding=(10))
    frame1.grid()

    # 9 × 5の行列
    for i in range(9): # 行
        for j in range(5): # 列
            exec('v{} = BooleanVar()'.format(j+5*i+1))
            exec('v{}.set(False)'.format(j+5*i+1))
            exec("""cb{} = ttk.Checkbutton(
            frame1, padding=10, text='test{}',
            variable=v{},
            command=lambda: print('v{} = %s' % v{}.get()))""".format(j+5*i+1, j+i*5+1, j+5*i+1, j+5*i+1, j+5*i+1, j+5*i+1))
            exec("cb{}.grid(row={}, column={})".format(j+5*i+1, i, j))
            print("cb{}.grid(row={}, column={})".format(j+5*i+1, i, j))
main()

root.mainloop()

関数化すると、例えばtest1のチェックボックスを押したとき、以下のエラーが表示されます。

例
NameError: name 'v1' is not defined

どうすれば、関数化したときに値を取得できるのでしょうか。

追記

本当は、exec関数を使わず、一つ一つ変数を宣言した方がエラーになりにくいと思うのですが、変数の数が多くなるのが嫌なので、exec関数をどうしても使いたいです。
また、関数しなければ、正常に動作はしますが、作成している関数をもとに他の処理に組み込みたいので、関数にする方法があれば教えて頂きたいです。
よろしくお願いします。

Answer 1

変数の数が多くなるのが嫌なので、exec関数をどうしても使いたいです。

理由が変数の数でしたら、
ここは間違いなく、exec関数を使わない方が良いです。

変数の数を増やす必要はなく、リストや辞書で管理します。
寧ろ、変数の数は exec を使った方が増えてます。
exec の用途としても適切ではありません。

以下のコードのように関数化すると、取得できなくなります。

原因は、tk.BooleanVar が main関数内のローカル変数であるため、
関数を使ってない場合は、全てグローバル変数になってました。

グローバル変数にすると、他の場所で使った時誤動作の原因になるので
これ自体はお勧めしませんが、動作は確認できると思います。

exec('global v{0}\nv{0} = BooleanVar()'.format(j+5*i+1))

追記: 他の変更点、root ～ mainloop() はmain関数内に移します。

ローカル変数にするには、exec の引数にローカル変数の辞書を指定できます
が、これも推奨の解決策という訳ではありません。コードがより複雑になります。

Checkbutton, BooleanVar の管理には、リストか辞書を使いましょう。

Answer 2

複数のcheckbuttonの作り方は

• checkbuttonはループで生成します。
• checkbuttonを含めて生成された変数などは辞書に保持しておきます。

チェックされたwidgetを特定してその状態をprintするには

• チェック状態が変化する前のイベントで、イベント発生させたwidgetをおさえておきます。
• チェック状態が変化した後のイベントで、widgetから必要なデータを取り出してprintします。

from tkinter import *
from tkinter import ttk

root = Tk()
root.title('Checkbutton')

frame1 = ttk.Frame(root, padding=(10))
frame1.grid()

# チェック状態が変わる前
def prev_cb(e):
    # イベント発生元のwidgetをおさえておく
    global cur_cb
    cur_cb = e.widget

# チェック状態が変わった後
def after_cb():
    row, col, var = cbs[cur_cb]
    print( f'{row+1},{col+1}={var.get()}')

# １つのcheckbuttonを初期化
def init_check( frm, row, col):
    var = BooleanVar()
    var.set(False)
    cb = ttk.Checkbutton( frm, padding=10, text=f'{row+1}x{col+1}', variable=var, command=after_cb)
    cb.bind('<1>', prev_cb)
    cb.grid(row=row, column=col)
    return cb, var

cbs = {}      # widgetなどを保持するための辞書
cur_cb = None # イベント発生したcheckbutton
for row in range(2): # 行
    for col in range(3): # 列
        cb, var = init_check( frame1, row, col)
        cbs[cb] = (row, col, var) # 必要な変数をwidgetに紐づけて保持しておく

root.mainloop()

teamiklさん提案のfunctools.partialを使った例

from tkinter import *
from tkinter import ttk
import functools

root = Tk()
root.title('Checkbutton')

frame1 = ttk.Frame(root, padding=(10))
frame1.grid()

def after_cb(row, col, var):
    print( f'{row+1},{col+1}={var.get()}')

# １つのcheckbuttonを初期化
def init_check( frm, row, col):
    var = BooleanVar()
    var.set(False)
    f = functools.partial(after_cb, row, col, var)
    #print(id(f))
    cb = ttk.Checkbutton( frm, padding=10, text=f'{row+1}x{col+1}', variable=var, command=f)
    cb.grid(row=row, column=col)

for row in range(2): # 行
    for col in range(3): # 列
        init_check( frame1, row, col)

root.mainloop()

Comments

[teamikl]

辞書での管理に+1

質問の要件にある「関数化して再利用」する際は、
グローバル変数が問題になる事があるので、
command へのイベント発生元の渡し方は、
functools.partial を使うとグローバル変数の利用を避けられます。
(もしくは、クラス実装してインスタンス変数にするが率直な解決策）

def after_cb(row, col, var):
　...

command=functools.partial(after_cb, row, col, var)

[can110]

コメントありがとうございます。
面白い使い方ですね。勉強になりました。

[fafw]

teamiklさん、can110さん回答ありがとうございました。
まだまだ初心者で、変数を辞書で管理できることは知りませんでした。
また、functools.partialは初めて見ました。
調べてみるとfunctools.partialはクロージャーみたいな役割があるんですね。
勉強になりました。

提案して頂いたコードですが、for文の部分に関してまとめて関数化しても大丈夫そうですか？
def main():
for row in range(2): # 行
for col in range(3): # 列
init_check( frame1, row, col)
main()

[teamikl]

そのコードでは、frame1 がグローバル変数になっているので、
関数の引数にすれば大丈夫です。
def main(frame):
　# 略
　init_check(frame, row, col)
main(frame1)

[fafw]

ありがとうございました。
おかげさまで解決できました。