kvファイル上の2クラス間におけるScreenManagerを使っての画面遷移

Question

前提・実現したいこと

ScreenManagerを使って画面遷移のサンプルを作成する。

◆ここに質問の内容を詳しく書いてください。

kvファイル上の2クラス間の画面遷移方法を教えて頂けますでしょうか。
正直ほぼAPIのサンプル通りに書いているのに、なぜ動かないのかわかりません。。。
こんな初歩的な所で躓いており、お恥ずかしい限りですが、宜しくお願い致します。

該当のソースコード

【ScreenManager.py】

from kivy.app import App
from kivy.uix.screenmanager import ScreenManager, Screen

class MenuScreen(Screen):
    pass

class SettingsScreen(Screen):
    pass

sm = ScreenManager()
sm.add_widget(MenuScreen(name='menu'))
sm.add_widget(SettingsScreen(name='settings'))

class ScreenApp(App):
    def build(self):
        return sm

if __name__ == "__main__":
    ScreenApp().run()


【screen.kv】

<MenuScreen>:
    BoxLayout:
        Button:
            text: 'Goto settings'
            on_press: root.manager.current = 'settings'
        Button:
            text: 'Quit'

<SettingsScreen>:
    BoxLayout:
        Button:
            text: 'My settings button'
        Button:
            text: 'Back to menu'
            on_press: root.manager.current = 'menu'

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

Python 3.7
Kivy 1.10.1

追記

事象に対する対処法は見つかりましたが、
原因は分かっておりません。。。

Answer 1

widgetにKv言語で書かれた物を反映させるには、widgetのinstanceを作る前にKv言語のコードを読み込ませないといけないです。TestAppクラスが自身の名前を元にtest.kvを読みに行くのはTestApp().run()の中(この部分)なので、TestApp().run()を呼ぶ前に作ったMenuScreenとSettingsScreenのinstanceはKv言語で書かれた定義が無い状態になりますね。

なので最初の失敗例を正しく動作させるにはMenuScreenとSettingsScreenのinstanceを作る前に以下のように明示的にKv言語のコードを読み込めばいいです。

from kivy.lang import Builder

Builder.load_file('test.kv')
sm = ScreenManager()
sm.add_widget(MenuScreen(name='menu'))
sm.add_widget(SettingsScreen(name='settings'))

(このやり方の場合、test.kvは別の名前に変えたほうがいいかもしれないです。)

Comments

[penpal]

丁寧にご教示頂きありがとうございます。大変勉強になりました。
おっしゃる通りScreenManagerクラスのinstanceを作成する前にBuilder.load_fileでkvファイルを読み込むと正常に動作しました。
事前に読み込みを行ってから、ScreenManagerクラスのinstanceにScreenを追加してないと、app.run()の中でWindow.add_widget(self.root)を呼ぶ際に、
引数のrootのchildrenにいるname = "menu"に紐づくScreenに、kvファイルで定義したBoxLayoutクラスのinsutanceが入ってない状態になるんですね。

[gottadiveintopy]

"Window.add_widget(self.root)を呼ぶ際" ではなくて widgetのinstanceを作る時 ですね。

Answer 2

自己解決しました。

ScreenManagerのインスタンス化をScreenAppのbuild内で行う必要があったみたいです。

◆誤り
sm = ScreenManager()
sm.add_widget(MenuScreen(name='menu'))
sm.add_widget(SettingsScreen(name='settings'))

class ScreenApp(App):
    def build(self):
        return sm

◆正しい
class ScreenApp(App):
    def build(self):
        sm = ScreenManager()
        sm.add_widget(MenuScreen(name='menu'))
        sm.add_widget(SettingsScreen(name='settings'))
        return sm

ちなみに、API Referenceの公式サンプルは以下のようになっております。
pyファイルとkvファイルに分割すると、ScreenManagerをbuild内で
インスタンス化する必要が出てくる原因はよくわかりません。。。

どなたか、原因が分かる方はいらっしゃいますでしょうか。

from kivy.app import App
from kivy.lang import Builder
from kivy.uix.screenmanager import ScreenManager, Screen

# Create both screens. Please note the root.manager.current: this is how
# you can control the ScreenManager from kv. Each screen has by default a
# property manager that gives you the instance of the ScreenManager used.
Builder.load_string("""
<MenuScreen>:
    BoxLayout:
        Button:
            text: 'Goto settings'
            on_press: root.manager.current = 'settings'
        Button:
            text: 'Quit'

<SettingsScreen>:
    BoxLayout:
        Button:
            text: 'My settings button'
        Button:
            text: 'Back to menu'
            on_press: root.manager.current = 'menu'
""")

# Declare both screens
class MenuScreen(Screen):
    pass

class SettingsScreen(Screen):
    pass

# Create the screen manager
sm = ScreenManager()
sm.add_widget(MenuScreen(name='menu'))
sm.add_widget(SettingsScreen(name='settings'))

class TestApp(App):

    def build(self):
        return sm

if __name__ == '__main__':
    TestApp().run()