pythonのtkinterのオプションメニュー更新方法

Question

前提・実現したいこと

初めてPythonのtkinterを利用してツール作成を行っています。
やりたいこととしては、テキストボックスにパスを入力し、ボタンを押下すると
オプションメニューの値が更新される処理を実現したいです。

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

どのようにしてオプションメニューの値を更新すればいいでしょうか。
当然ですが、このまま実行しても変数に値が入るだけで更新はされません。
オプションメニューのインスタンス化する場所を変更する？
詰まっているためご教授頂けると嬉しいです。

該当のソースコード

import sys
import abc
import re
from copy import copy
import tkinter as tk

#test path
test_path = 'xxx'
file_contents = []
#----------------------------------------

class TKroot(tk.Tk):
     def __init__(self):
          super().__init__()
          self.title('xxx')
          self.geometry('1000x600')
          self.config(bg = 'white')


class Application(tk.Frame):
     file_mode = 'r'

     def __init__(self, master = None, **kwargs):
          super().__init__(master, **kwargs)
          self.opt_value = {}
          self.entry_value = {}
          self.create_widget()
          self.pack()

     def create_widget(self): 
          global file_contents

          #create frame 1.
          self.f1 = tk.Frame(self, bg = 'coral')
          self.f1.place(relheight = 0.1, width = 1000, height = 10)
          self.f1_label = tk.Label(self.f1, text = 'path : ')
          self.f1_label.pack(side = tk.LEFT)
          var = tk.StringVar()
          self.f1_entry = tk.Entry(self.f1, width = 100, textvariable = var)
          self.f1_entry.pack(side = tk.LEFT)

          f1_file = self.file_new()
          self.f1_button = tk.Button(self.f1, text = 'update', width = 30, command = lambda : f1_file.control(Read, var))
          self.f1_button.pack(side = tk.RIGHT, padx = 40)

          #create frame 2.
          self.f2 = tk.Frame(self, bg = 'red')
          self.f2.place(width = 1000, y = 70)
          self.f2_label = tk.Label(self.f2, text = 'function name : ')
          self.f2_label.pack(side = tk.LEFT)
          self.f2_opt_variable = tk.StringVar()
          #self.f2_opt_variable.set('chose a function')
          if file_contents == []:
               file_contents.append("test")
               file_contents.append("test")
          self.f2_opt_variable.set(file_contents[0])
          self.f2_file_contents = copy(file_contents)
          self.f2_opt = tk.OptionMenu(self.f2, self.f2_opt_variable, *self.f2_file_contents)
          self.f2_opt.config(width = 80)
          self.f2_opt.pack(side = tk.LEFT)

     def file_new(self):
          return File(Application.file_mode)


class File:
     def __init__(self, file_mode):
          self._file_path = ''
          self._file_mode = file_mode

     def _get_items(self, file_type):
          file_types_read = file_type(self._file_path, self._file_mode)
          return file_types_read.lines()

     def _set_items(self, function_list):
          global file_contents
          file_contents = [s for s in function_list if re.match(r'xxx', s)]

     def control(self, file_type, path_object):
          self._file_path = self._get_filepath(path_object)
          self._set_items(self._get_items(file_type))

     def _get_filepath(self, path_object):
          return path_object.get()

class FileType(abc.ABC):
     @abc.abstractclassmethod
     def lines(self, file_path):
          pass

#------------------------------------途中-------------------------------------
class Write(FileType):
     def __init__(self, args : dict):
          self._file_path = args.get('file_path', test_path)
          self._file_mode = args.get('file_mode', 'w')
          self._file_contens = []

     def lines(self):
          with FileAccess(self._file_path) as file:
               self._file_contens = file._writelines()
          return self._file_contens
#-----------------------------------------------------------------------------
class Read(FileType):
     def __init__(self, args_1, args_2):
          self._file_path = args_1
          self._file_mode = args_2
          self._file_contens = []

     def lines(self):
          with FileAccess(self._file_path) as file:
               self._file_contens = file._readlines()
          return self._file_contens


class FileAccess(object):
     def __init__(self, file_path):
          self._file_path = file_path
          self._file = None

     def _open(self):
          self._file = open(self._file_path)
          #self._file = open(test_path)

     def _close(self):
          self._file.close()

     def __enter__(self):
          self._open()
          return self

     def __exit__(self, exc_type, exc_value, traceback):
          self._close()

     def _readlines(self):
          file_read_contens = self._file.readlines()
          return file_read_contens

     def _writelines(self):
          file_write_contens = self._file.writelines()
          return file_write_contens

def main():
     root = TKroot()
     app = Application(master = root, width = 1000, height = 600)
     app.mainloop()

if __name__ == "__main__":
     main()

試したこと

ここに問題に対して試したことを記載してください。

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。

Comments

[teamikl]

>ボタンを押下すると

Update ボタンを押すとNameError: name 'Read' is not definedとでるので、
肝心な部分が省略されてます。

----
方向性としては、f2_opt_variable を引数として渡すか、
イベントで呼び出す関数をApplicationメソッドにして、
インスタンス経由でアクセスのどちらかになると思います。

[Kisssy]

teamikl様
ご回答ありがとうございます。省略部分を追記しました。
>>>方向性としては、f2_opt_variable を引数として渡すか、
f2_opt_variableを引数として渡す方法を行ってみましたが、オプションメニューの初期値が変更されるだけでデータとなる中身は更新されていませんでした。

>>>イベントで呼び出す関数をApplicationメソッドにして、
>>>インスタンス経由でアクセスのどちらかになると思います。
これは実施していないため憶測で記載し申し訳ありませんが、これも結局は引数で渡さないだけで、上の結果と同じようなことになると思われますがどうでしょうか。

すみません、初心者でいろいろ質問してしまいまして。。。

[teamikl]

> 変数に値が入るだけで更新はされません。

「更新」とは具体的にどんな状態ですか？

＞「オプションメニューの値」
オプションメニュー自体は選択された値を持っていなくて、
変数に指定するのは、表示されているラベルの様です。
選択された値が必要な場合は、コンボボックスの方が適してます。

OptionMenuを項目選択としてつかうには、可能ですが、
項目毎にイベントハンドラを設定する必要があります。

----
一応、f2_opt_variable (StringVar) のかわりに
f2_opt (OptionMenu)を渡すと、他にも色々出来ます。
回答にサンプルで項目を追加する例を記述しました。

[Kisssy]

>>>「更新」とは具体的にどんな状態ですか？
オプションメニューの内部データを更新することです。
回答の返信に結果を記載しました。

>>>選択された値が必要な場合は、コンボボックスの方が適してます。
わざわざイベントハンドラを設定しなくとも、textvariableで手軽に取得できますね。
今回はteamikl様がサンプルを記載くださったため、そちらを利用して実装することにします。

いろいろ答えていただきありがとうございました。本当に助かりました。

Answer 1

"opt["menu"]"の部分

「Menuオブジェクト」にアクセスしてます。

通常のウィンドウに付くメニューと同じです。
ウィンドウのメニューバーではなく、
ウィジェットに紐づいたメニューといった扱いでしょうか。

root = tk.Tk()
menu = root["menu"] = tk.Menu(root)
menu.add_command(label="Quit", command=root.quit)
root.mainloop()

コードによっては root.config(menu=menu) で
メニューバーを登録してるかもしれませんが、
アクセス方法が異なるだけで、内容は同じ。

※ 全てのウィジェットに["menu"]オプションが有るわけではありません。

• [tkinter - 簡易的なリファレンス オプション設定

](https://docs.python.org/ja/3/library/tkinter.html)

• tkinter/__init__.py [source]

# class OptionMenu __init__

        # Menuオブジェクトを作成
        menu = self.__menu = Menu(self, name="menu", tearoff=0)
        self.menuname = menu._w

        # command はキーワード引数でのみ指定可 -> callback変数へ

        # 'command' is the only supported keyword
        callback = kwargs.get('command')
        if 'command' in kwargs:
            del kwargs['command']
        if kwargs:
            raise TclError('unknown option -'+kwargs.keys()[0])


        # 一番目の要素をメニューに追加
        menu.add_command(label=value,
                 command=_setit(variable, value, callback))

        # 残りの要素をメニューに追加
        for v in values:
            menu.add_command(label=v,
                     command=_setit(variable, v, callback))

        # オプションに設定
        self["menu"] = menu

---

OptionMenuをメニューバーと(右クリック時の)コンテキストメニューで再利用

opt["menu"] は Menu オブジェクトなので、
メニューバーや右クリックメニューで再利用できます。

(他のオプションが全く指定できないので、
実用性は高くありません。実演のみ）

#!/usr/bin/env python3.8

import tkinter as tk

root = tk.Tk()
root.geometry("400x400")

# ウィンドウのメニュー
menu = tk.Menu(root)
root["menu"] = menu
# root.config(menu=menu)

menu.add_command(label="Quit", command=root.quit)


var = tk.StringVar()
def fileMenu(cmd):
    print("FILE", cmd)
    if cmd == "Open":
        pass
    elif cmd == "Save":
        pass
    elif cmd == "Quit":
        root.quit()

opt = tk.OptionMenu(root, var, *["Open", "Save", "Quit"], command=fileMenu)
opt.pack()

# ウィンドウのメニューに OptionMenuを追加
menu.add_cascade(label="File", menu=opt["menu"])

# 右クリックでメニューを表示
def popup(e):
    try:
        opt["menu"].tk_popup(e.x_root, e.y_root, 0)
    finally:
        opt["menu"].grab_release()

root.bind("<Button-3>", popup)

root.mainloop()

Answer 2

OptionMenu に項目を追加するサンプル

#!/usr/bin/env python3.8

import tkinter as tk


class Application(tk.Frame):
    def __init__(self, master=None, **kwargs):
        super().__init__(master, **kwargs)
        
        var = tk.StringVar()
        var2 = tk.StringVar()
        entry = tk.Entry(self, textvar=var)
        button = tk.Button(self, text="Update", command=self.onUpdateButton)
        menu = tk.OptionMenu(self, var2, *["AAA", "BBB"], command=self.onMenuCommand)

        var.set("CCC")

        entry.pack(side=tk.LEFT)
        button.pack(side=tk.RIGHT)
        menu.pack()

        self.var = var
        self.var2 = var2
        self.opt = menu
        self.pack()

    def onMenuCommand(self, cmd):
        print(cmd)

    def onUpdateButton(self):
        try:
            text = self.var.get()
            self.opt["menu"].add_command(
                label=text, command=tk._setit(self.var2, text, self.onMenuCommand))
        finally:
            self.var.set("")


if __name__ == '__main__':
    Application(master=tk.Tk()).mainloop()

OptionMenu には、通常のメニューと同じように項目を追加出来ます。

…が、内部関数(_setit) が必要になる事から、恐らく想定されてない用途なので、
（項目がネストしないなら、）Comboboxを入力禁止にして使う方が良いかもしれないです。

---

追記: OptionMenuの要素を更新する例

## class Application create_widgets

          self.f1_button = tk.Button(self.f1, text = 'update', width = 30, command = lambda : f1_file.control(Read, var, self))


## class File

     def control(self, file_type, path_object, app):
          self._file_path = self._get_filepath(path_object)
          self._set_items(self._get_items(file_type))

          # ※ このコードはここには書かず Applicationクラスのメソッドにした方がよい。
          opt = app.f2_opt["menu"]
          opt.delete(0, "last")
          for line in file_contents:
               opt.add_command(label=line.strip()) # TODO: add command=
          app.f2_opt_variable.set("")

Comments

[Kisssy]

OptionMenu に項目を追加するサンプルの見本コードありがとうございます。（他で参考にさせていただきます）
今回の場合はメニューにデータの追加を行いたいわけではなくデータ全てを更新したいです。
こちらの情報提示不足でした。
やりたいことは、
１　入力ボックスにパス（ソースコードのファイル）を入力する
２　ボタン（更新）を押下
３　指定したソースコードのデータを解析（正規表現）し、抽出
４　オプションメニューにその抽出データを格納、表示する
です。

[teamikl]

add_command の他にもメニューに対する操作は可能ですが、
更新となると、delete してから add という流れになりますね。

OptionMenu に対する操作は示せたと思いますので、
手順としては
1. StringVar と OptionMenu 両方を渡す
2. 要素を全削除 opt["menu"].delete(0, "last")
3. add_command で追加
4. 注意点: command引数は全要素に追加する必要あり。
　OptionMenu は選択された値を持たないので、
　どの値が選ばれたかの情報は、イベントハンドラに関連付けておく必要があります。
上で提示したサンプルのようにtk._setitを使うと、選択された値を変数に格納できます。

※ OptionMenu がコンストラクタ内部でやってる処理と同じです。
レイアウトを固定できるなら、OptionMenuのインスタンスを作り直すのも手です。

[Kisssy]

teamiklさんのアドバイス通りに実装し、期待通りの動作ができることを確認できました。

>>>レイアウトを固定できるなら、OptionMenuのインスタンスを作り直すのも手です。
固定できます。一通り終わればリファクタをするつもりですので、その際に作り直す予定です。

ご丁寧なアドバイスありがとうございました。これで続きが作れそうです。
すみません、最後にもう一つ質問してもよろしいでしょうか。
一箇所わからない箇所がありまして、"opt["menu"]"の部分です。
これはなにをやっているのでしょうか。いまいちピンときていません。

[teamikl]

＞最後にもう一つ質問

コードを載せたため、回答にして返信しました。