如何在Tkinter应用程序上运行unittest?

时间:2010-11-03 02:28:17

标签: python unit-testing tdd tkinter

我刚开始学习TDD,我正在使用Tkinter GUI开发程序。唯一的问题是,一旦调用.mainloop()方法,测试套件就会挂起,直到窗口关闭。

以下是我的代码示例:

# server.py
import Tkinter as tk

class Server(tk.Tk):
    def __init__(self):
        tk.Tk.__init__(self)
        self.mainloop()

# test.py
import unittest
import server

class ServerTestCase(unittest.TestCase):
    def testClassSetup(self):
       server.Server()
       # and of course I can't call any server.whatever functions here

if __name__ == '__main__':
    unittest.main()

测试Tkinter应用程序的适当方法是什么?或者只是'不'?

4 个答案:

答案 0 :(得分:8)

底线:在导致UI事件的操作之后,使用以下代码抽取事件,然后再执行需要该事件影响的操作。

IPython提供了一个优雅的解决方案,没有线程,它gui tk魔术命令实现位于terminal/pt_inputhooks/tk.py

而不是root.mainloop(),它在循环中运行root.dooneevent(),每次迭代检查退出条件(到达的交互式输入)。这样,当IPython忙于处理命令时,偶数循环不会运行。

通过测试,没有外部事件要等待,测试总是"忙碌",所以必须手动(或半自动)在&#34运行循环;适当的时刻"。它们是什么?

测试表明,如果没有事件循环,可以直接更改小部件(使用<widget>.tk.call()和包装它的任何内容),但事件处理程序永远不会触发。因此,只要事件发生就需要运行循环,并且我们需要它的效果 - 即在需要更改结果的操作之前进行任何更改操作之后。

从上述IPython程序派生的代码将是:

def pump_events(root):
    while root.dooneevent(_tkinter.ALL_EVENTS|_tkinter.DONT_WAIT):
        pass

这会处理(执行处理程序)所有挂起事件,以及直接由这些事件产生的所有事件。

tkinter.Tk.dooneevent()代表Tcl_DoOneEvent()。)

作为旁注,请改用:

root.update()
root.update_idletasks()

不一定会这样做,因为两个函数都没有处理所有种类的事件。由于每个处理程序都可能生成其他任意事件,因此我无法确定是否已处理完所有事件。

这是一个测试简单弹出对话框以编辑字符串值的示例:

class TKinterTestCase(unittest.TestCase):
    """These methods are going to be the same for every GUI test,
    so refactored them into a separate class
    """
    def setUp(self):
        self.root=tkinter.Tk()
        self.pump_events()

    def tearDown(self):
        if self.root:
            self.root.destroy()
            self.pump_events()

    def pump_events(self):
        while self.root.dooneevent(_tkinter.ALL_EVENTS | _tkinter.DONT_WAIT):
            pass

class TestViewAskText(TKinterTestCase):
    def test_enter(self):
        v = View_AskText(self.root,value=u"йцу")  # the class implementing the dialog;
                                                  # not included in the example
        self.pump_events()
        v.e.focus_set()
        v.e.insert(tkinter.END,u'кен')
        v.e.event_generate('<Return>')
        self.pump_events()

        self.assertRaises(tkinter.TclError, lambda: v.top.winfo_viewable())
        self.assertEqual(v.value,u'йцукен')


# ###########################################################
# The class being tested (normally, it's in a separate module
# and imported at the start of the test's file)
# ###########################################################

class View_AskText(object):
    def __init__(self, master, value=u""):
        self.value=None

        top = self.top = tkinter.Toplevel(master)
        top.grab_set()
        self.l = ttk.Label(top, text=u"Value:")
        self.l.pack()
        self.e = ttk.Entry(top)
        self.e.pack()
        self.b = ttk.Button(top, text='Ok', command=self.save)
        self.b.pack()

        if value: self.e.insert(0,value)
        self.e.focus_set()
        top.bind('<Return>', self.save)

    def save(self, *_):
        self.value = self.e.get()
        self.top.destroy()


if __name__ == '__main__':
    import unittest
    unittest.main()

答案 1 :(得分:2)

有一种称为猴子修补的技术,您可以在运行时更改代码。

你可以修补TK类,这样主循环就不会真正启动程序。

你的test.py中有类似的东西(未经测试!):

import tk
class FakeTk(object):
    def mainloop(self):
        pass

tk.__dict__['Tk'] = FakeTk
import server

def test_server():
    s = server.Server()
    server.mainloop() # shouldn't endless loop on you now...

mock这样的模拟框架使这一点变得不那么痛苦了。

答案 2 :(得分:2)

你可以做的一件事是在一个单独的线程中生成mainloop并使用你的主线程来运行实际的测试;观看主循环线程。确保在执行断言之前检查Tk窗口的状态。

多线程处理任何代码都很难。您可能希望将Tk程序分解为可测试的部分,而不是立即对整个事物进行单元测试(这实际上不是单元测试)。

我最后建议至少在控制级别进行测试,如果你的程序不低,它会对你有很大的帮助。

答案 3 :(得分:2)

此答案适用于 Python 3.7 及更高版本(任何版本都有异步方法)

在您的 main.py 或您启动主 UI 的任何位置:

def start_application() -> Application:
    root = tk.Tk()
    app = Application(master=root)
    app.load_settings()
    return app # will return the application without starting the main loop.

if __name__=='__main__':
    start_application().mainloop()

在您的 tests.py 中:

from myapp.main import start_application

class TestGui(unittest.TestCase):
    
    # this will run on a separate thread.
    async def _start_app(self):
        self.app.mainloop()
    
    def setUp(self):
        self.app = start_application()
        self._start_app()
    
    def tearDown(self):
        self.app.destroy()
    
    def test_startup(self):
        title = self.app.winfo_toplevel().title()
        expected = 'The Application My Boss Wants Me To Make'
        self.assertEqual(title, expected)

这不会显示任何内容,但它会通过。此外,预计会有警告 显示我们没有等待 _start_application。在这种情况下可以忽略这一点。 (如果您想成为多线程的忠实拥护者,那么您将不得不进行自己的线程管理……恕我直言,单元测试的工作量太大了)。