Python3 Tkinter クラスの継承で意図した動作ができない

Question

Toplevelを継承したときに、意図した動作をしません。
Frameを継承したら、意図した動作になりました。
Toplevelを継承した際の書き方の問題だと思いますが、どう直せばいいか教えてください。
意図した動作としては、tk.Tk()とtk.Toplevel()のウィンドウを1つずつ表示することです。
実際の動作としては、小さいウィンドウが2つ余計に出てきます。title()が自分では設定していない"tk"となっていて原因が分かりません。

回答よろしくお願いします。

意図した動作をしない

from tkinter import ttk
import tkinter as tk

class Main(tk.Tk):
    def __init__(self):
        self.sub = Sub()
        self.open()
    def open(self):
        super().__init__()
        self.geometry("400x300+0+0")
        self.title("main")
        self.sub.open(self)

class Sub(tk.Toplevel):
    def open(self, master):
        super().__init__()
        self.geometry("200x200+25+25")
        self.title("sub")
        self.attributes("-topmost", True)
        self.grab_set()
        self.transient(master)
        self.protocol("WM_DELETE_WINDOW", self.close)
    
    def close(self):
        self.grab_release()
        self.destroy()
        
def main():
    app = Main()
    app.mainloop()

if __name__ == "__main__":
    main()

Frame継承だと意図した動作

from tkinter import ttk
import tkinter as tk

class Main(tk.Tk):
    def __init__(self):
        super().__init__()
        self.geometry("400x300+0+0")
        self.title("main")
        sub = Sub()
        sub.open(self)

class Sub(tk.Frame):
    def open(self, master):
        self.tl = tk.Toplevel()
        super().__init__(self.tl)
        self.tl.geometry("200x200+25+25")
        self.tl.title("sub")
        self.tl.attributes("-topmost", True)
        self.tl.grab_set()
        self.tl.transient(master)
        self.tl.protocol("WM_DELETE_WINDOW", self.close)
    
    def close(self):
        self.tl.grab_release()
        self.tl.destroy()
        
def main():
    app = Main()
    app.mainloop()

if __name__ == "__main__":
    main()

追記

teamikl様より修正して意図した結果になったソースコード

from tkinter import ttk
import tkinter as tk

class Main(tk.Tk):
    def __init__(self):
        super().__init__()
        self.sub = Sub()
        self.geometry("400x300+0+0")
        self.title("main")
        self.sub.open(self) # ← 書かなくてもToplevelウィンドウが表示される（？）

class Sub(tk.Toplevel):
    def open(self, master):
        self.geometry("200x200+25+25")
        self.title("sub")
        self.attributes("-topmost", True)
        self.grab_set()
        self.transient(master)
        self.protocol("WM_DELETE_WINDOW", self.close)

    def close(self):
        self.grab_release()
        self.destroy()

def main():
    app = Main()
    app.mainloop()

if __name__ == "__main__":
    main()

ボタン押下でToplevelを開くように個人的に変えたプログラム

from tkinter import ttk
import tkinter as tk

"""
    Frame を継承するのが一般的（？）だが、
    Frame を生成・配置する必要はないので、Tk を継承する
"""
class Main(tk.Tk):
    def __init__(self):
        # Tk のコンストラクタ呼び出し
        super().__init__()
        # Sub のインスタンス生成（ここではToplevelウィンドウは表示しない）
        self.sub = Sub()
        # Tk の設定
        self.geometry("400x300+0+0")
        self.title("main")
        # Tk にウィジェット配置
        self.button = ttk.Button(self, text="open", command=self.pushed)
        self.button.grid()

    def pushed(self):
        # open 呼び出しにより、Toplevelウィンドウを生成
        self.sub.open(self)

class Sub(tk.Toplevel):
    """
        継承先クラス Sub のコンストラクタ __init__() の定義が無いと、
        Sub() インスタンス生成時に継承元クラス Toplevel のコンストラクタ __init__() が呼ばれる。
        Sub() インスタンス生成時に継承元のコンストラクタが呼ばれると困るので、
        コンストラクタ（処理としては「何もしない」）を定義する。

        上記対応により継承元のコンストラクタを呼ばなくなったため、
        super().__init__() を別の関数（open）に書くことで、
        そのタイミングで継承元のコンストラクタを呼び出す。
    """
    def __init__(self):
        pass
    def open(self, master):
        # Toplevel のコンストラクタ呼び出し（ここでToplevelウィンドウを表示する）
        super().__init__()
        # Toplevel の設定
        self.geometry("200x200+25+25")
        self.title("sub")
        self.attributes("-topmost", True)
        self.grab_set()
        self.transient(master)
        self.focus_set()
        self.protocol("WM_DELETE_WINDOW", self.close)

    def close(self):
        self.grab_release()
        self.destroy()

def main():
    app = Main()
    app.mainloop()

if __name__ == "__main__":
    main()

Answer 1

問題点: Frame のコードもおかしな点があるのですが、
open() メソッド内で 親クラスの __init__() を呼び出してます。

修正方法

• Main クラスの open() 内の super().__init__() は、コンストラクタ(__init__)に移動する。
• Sub クラスの open() 内の super().__init__() は削除

下のコードも、結果的に目に見える問題にはなってないようですが、
open() 内での super().__init__() は誤りです。

---

tkinter のプログラムでは、
ウィンドウを持つ Tk や Toplevel と中身の Frame は分離したほうが良いです。
Toplevel の継承は、サブウィンドウを単体でテストしたいときに、クラスの再利用が少し手間になります。

Comments

[person]

回答ありがとうございます。

> Frame のコードもおかしな点があるのですが、
open() メソッド内で 親クラスの __init__() を呼び出してます。

コンストラクタで呼び出した方がいいんですね。

> Main クラスの open() 内の super().__init__() は、コンストラクタ(__init__)に移動する。
> Sub クラスの open() 内の super().__init__() は削除

Toplevelの継承では、上記の変更をしても、3つ目のウィンドウが出てきました。

from tkinter import ttk
import tkinter as tk

class Main(tk.Tk):
def __init__(self):
self.sub = Sub()
#self.open()
super().__init__()
self.geometry("400x300+0+0")
self.title("main")
self.sub.open(self)

class Sub(tk.Toplevel):
def open(self, master):
#super().__init__()
self.geometry("200x200+25+25")
self.title("sub")
self.attributes("-topmost", True)
self.grab_set()
self.transient(master)
self.protocol("WM_DELETE_WINDOW", self.close)

def close(self):
self.grab_release()
self.destroy()

def main():
app = Main()
app.mainloop()

if __name__ == "__main__":
main()

[teamikl]

＞Toplevelの継承では、上記の変更をしても、3つ目のウィンドウが出てきました。

インデントのないコメントのコードは実行できないので、質問のコードに反映できますか。

見た感じでは、Tkinter の初期化前に Sub (Toplevel) が呼び出されてます。

self.sub = Sub() # tk.Toplevel
#self.open()
super().__init__() # tk.Tk

初期化前のToplevel 呼び出しでは tk.Tk、初期化+ウィンドウとなるので
デフォルトのウィンドウとToplevel のウィンドウの２枚が開きます。
例えば、以下のコードも同様にウィンドウを３つ開きます。

import tkinter as tk
top = tk.Toplevel()
root = tk.Tk()
root.mainloop()

[person]

super().__init__()
より下に
self.sub = Sub()
を書いたら2枚になりました。
ありがとうございます。

[person]

質問ではToplevelをTkとほぼ同時に表示していますが、
ボタンを押したときなど特定のタイミングでToplevelを表示することを考えたときに不都合が生じたため、少しソースコードを変えました。

その際に

> Sub クラスの open() 内の super().__init__() は削除

とあったのですが、必要そうだと思ったので書きました。
質問文にソースコードを追記したので、そちらもよろしければ確認お願いします。

[teamikl]

__init__ は通常、インスタンス生成時に一度しか呼び出されない為
初期化時のみ必要な処理を書きます。

ウィンドウの表示・非表示は、後からwithdraw/iconifyで変更できるので
必要な初期設定は __init__ 内で済ませて、
openでは表示のみにした方が良いです。

open内で親クラスのコンストラクタを呼び出すのは、(open内でのsuper().__init__)
そもそも一度しか呼ばれることを想定していない関数を、
複数回呼べる事になるので、使い方によっては誤動作の原因になったり
一度しか使えない再利用性の低いクラスになってしまいます。
(※例えば、open()を複数回呼び出したときにどのような挙動になるか、等）

[person]

では、ボタンを押したときなどウィンドウを表示したいときに、
インスタンス生成をするようなイメージでしょうか。

似たような質問を後から見かけました（下記）。
https://steakrecords.com/ja/692785-python-tkinter-successfully-inherit-from-toplevel-python-inheritance-tkinter-toplevel.html

[teamikl]

- ボタンを押したとき、必要になってからインスタンス生成
- 非表示のままインスタンス生成しておき、ボタンを押したとき表示

解決策としてはどちらでもよいですが、上で説明したのは後者の方法です。

URLの質問は、super().__init__()に self を渡している点が問題なので、
エラーになる為、問題の焦点が違います。

今回の問題点は「メソッド内での親クラスのコンストラクタ呼び出し」
通常は一回しか呼び出さないメソッドを、同インスタンスに対して
何度も呼び出せる設計になっている点です。

このコード内では、モーダルダイアログなので、
アプリケーション内で実際にそのような操作はできませんが、
実際にバグを再現した方が解りやすいと思います、
コード中のgrab_setの行をコメントして、
ボタンを何度も押してみて挙動を確かめて見て下さい。

例: 複数subウィンドウを開きます。
最初に開いたウィンドウを閉じようとすると、
必ず最後に開いたウィンドウのみが閉じる。他のウィンドウは閉じられない

Mainクラスから参照されるインスタンス(self.sub)と、
実際のインスタンス(super().__init__()で生成される) が
1対1に結び付いてないのが解ると思います。

「モーダルダイアログにしていて、複数回呼び出す事が出来ないから問題ないのでは？」
という、とりあえず意図通りに動けばよいみたいな観点もありますが、
問題が再現しない等に注意して使わないといけないという事なので、
これはそのままクラスの再利用性が低いことに繋がってます。

====
コードの意図としては、実際のインスタンス化のタイミングを
必要になる時点まで遅らせるというのは理解できます。
（インスタンス化のコストが重たいクラスを使う時等で、
必要になるまで処理を遅らせる、遅延ロード(lazy loading)といった手法もあります）

[teamikl]

多分、この場合（インスタンス生成を遅らせる）は、SubクラスはToplevelを継承せずに
普通に open 内で Toplevel を作るのが良いと思います。

[person]

継承することによるデメリットもあるんですね。
継承しないほうも試してみます。

ありがとうございました。

[teamikl]

継承自体のデメリットではなく、
インスタンス化の時点でウィンドウが表示されるという、
Toplevelクラスの仕様が、
要求(インスタンス化とは別でウィンドウは後から表示したい)
と噛み合ってない点ですね。
継承で実装するなら、表示・非表示の制御は先述した通り withdraw/iconifyで制御できます。

継承によるのデメリットの側面は、例えば
親クラスから引き継いだ属性と名前空間が混同してしまう事により
自分で定義したメソッドとToplevelから継承したメソッドが混ざってしまう、
IDE等で入力候補をだすと大量にメソッドのリストが表示されてしまうなどがあります。