1. 程式人生 > 程式設計 >Python如何測試stdout輸出

Python如何測試stdout輸出

問題

你的程式中有個方法會輸出到標準輸出中(sys.stdout)。也就是說它會將文字列印到螢幕上面。 你想寫個測試來證明它,給定一個輸入,相應的輸出能正常顯示出來。

解決方案

使用 unittest.mock 模組中的 patch() 函式, 使用起來非常簡單,可以為單個測試模擬 sys.stdout 然後回滾, 並且不產生大量的臨時變數或在測試用例直接暴露狀態變數。

作為一個例子,我們在 mymodule 模組中定義如下一個函式:

# mymodule.py

def urlprint(protocol,host,domain):
  url = '{}://{}.{}'.format(protocol,domain)
  print(url)

預設情況下內建的 print 函式會將輸出傳送到 sys.stdout 。 為了測試輸出真的在那裡,你可以使用一個替身物件來模擬它,然後使用斷言來確認結果。 使用 unittest.mock 模組的 patch() 方法可以很方便的在測試執行的上下文中替換物件, 並且當測試完成時候自動返回它們的原有狀態。下面是對 mymodule 模組的測試程式碼:

from io import StringIO
from unittest import TestCase
from unittest.mock import patch
import mymodule

class TestURLPrint(TestCase):
  def test_url_gets_to_stdout(self):
    protocol = 'http'
    host = 'www'
    domain = 'example.com'
    expected_url = '{}://{}.{}\n'.format(protocol,domain)

    with patch('sys.stdout',new=StringIO()) as fake_out:
      mymodule.urlprint(protocol,domain)
      self.assertEqual(fake_out.getvalue(),expected_url)

討論

urlprint() 函式接受三個引數,測試方法開始會先設定每一個引數的值。 expected_url 變數被設定成包含期望的輸出的字串。

unittest.mock.patch() 函式被用作一個上下文管理器,使用 StringIO 物件來代替 sys.stdout . fake_out 變數是在該程序中被建立的模擬物件。 在with語句中使用它可以執行各種檢查。當with語句結束時,patch 會將所有東西恢復到測試開始前的狀態。 有一點需要注意的是某些對Python的C擴充套件可能會忽略掉 sys.stdout 的配置而直接寫入到標準輸出中。 限於篇幅,本節不會涉及到這方面的講解,它適用於純Python程式碼。 如果你真的需要在C擴充套件中捕獲I/O,你可以先開啟一個臨時檔案,然後將標準輸出重定向到該檔案中。

以上就是Python如何測試stdout輸出的詳細內容,更多關於Python測試stdout輸出的資料請關注我們其它相關文章!