如何測試或模擬「如果__name__ ==‘__main__’」內容

Question

說我有以下模塊：

def main(): 
    pass 

if __name__ == "__main__": 
    main() 

我想寫的下半部分單元測試（我想實現100％的覆蓋率）。我發現執行import/__name__設置機制的內置模塊，但我無法弄清楚如何模擬或以其他方式檢查是否調用了函數。

這是我到目前爲止已經試過：

import runpy 
import mock 

@mock.patch('foobar.main') 
def test_main(self, main): 
    runpy.run_module('foobar', run_name='__main__') 
    main.assert_called_once_with() 

Answer 1

我將選擇另一個替代方案，即從覆蓋率報告中排除if __name__ == '__main__'，當然，只有在測試中已經有main（）函數的測試用例時，纔可以這樣做。

至於爲什麼我選擇排除而不是爲整個腳本編寫一個新的測試用例是因爲如果我說你已經有了main（）函數的測試用例，那麼你添加了另一個測試用例該腳本（僅用於100％覆蓋）將只是一個重複的腳本。

對於如何排除if __name__ == '__main__'你可以寫一個覆蓋配置文件，並添加部分報告：關於覆蓋配置文件

[report] 

exclude_lines = 
    if __name__ == .__main__.: 

更多信息，可以發現here。

希望這可以幫助。

Answer 2

您可以使用imp模塊，而不是import語句做到這一點。 import聲明的問題是'__main__'的測試作爲導入聲明的一部分運行，然後您有機會分配到runpy.__name__。

例如，你可以使用imp.load_source()像這樣：

import imp 
runpy = imp.load_source('__main__', '/path/to/runpy.py') 

的第一個參數被分配到導入模塊的__name__。

Answer 3

一種方法是將模塊作爲腳本運行（例如os.system（...）），並將它們的stdout和stderr輸出與預期值進行比較。

Answer 4

哇，我有點遲到了，但我最近就遇到了這個問題，我想，我想出了一個更好的解決方案，所以這裏是......

我工作的一個包含有十幾個劇本都與此完全相同copypasta結束模塊：

if __name__ == '__main__': 
    if '--help' in sys.argv or '-h' in sys.argv: 
     print(__doc__) 
    else: 
     sys.exit(main()) 

不可怕，肯定的，但不可測試無論是。我的解決辦法是在我的模塊中的一個寫一個新功能：

def run_script(name, doc, main): 
    """Act like a script if we were invoked like a script.""" 
    if name == '__main__': 
     if '--help' in sys.argv or '-h' in sys.argv: 
      sys.stdout.write(doc) 
     else: 
      sys.exit(main()) 

，然後把這種寶石在每個腳本文件的末尾：

run_script(__name__, __doc__, main) 

從技術上講，此功能將無條件是否運行您的腳本作爲模塊導入或作爲腳本運行。這是好的，但因爲該功能實際上並不做任何東西，除非該腳本正在作爲腳本運行。因此，代碼覆蓋率看到函數運行，並說「是的，100％的代碼覆蓋率！」同時，我寫了三個測試覆蓋本身的功能：

@patch('mymodule.utils.sys') 
def test_run_script_as_import(self, sysMock): 
    """The run_script() func is a NOP when name != __main__.""" 
    mainMock = Mock() 
    sysMock.argv = [] 
    run_script('some_module', 'docdocdoc', mainMock) 
    self.assertEqual(mainMock.mock_calls, []) 
    self.assertEqual(sysMock.exit.mock_calls, []) 
    self.assertEqual(sysMock.stdout.write.mock_calls, []) 

@patch('mymodule.utils.sys') 
def test_run_script_as_script(self, sysMock): 
    """Invoke main() when run as a script.""" 
    mainMock = Mock() 
    sysMock.argv = [] 
    run_script('__main__', 'docdocdoc', mainMock) 
    mainMock.assert_called_once_with() 
    sysMock.exit.assert_called_once_with(mainMock()) 
    self.assertEqual(sysMock.stdout.write.mock_calls, []) 

@patch('mymodule.utils.sys') 
def test_run_script_with_help(self, sysMock): 
    """Print help when the user asks for help.""" 
    mainMock = Mock() 
    for h in ('-h', '--help'): 
     sysMock.argv = [h] 
     run_script('__main__', h*5, mainMock) 
     self.assertEqual(mainMock.mock_calls, []) 
     self.assertEqual(sysMock.exit.mock_calls, []) 
     sysMock.stdout.write.assert_called_with(h*5) 

布拉姆！現在您可以編寫一個可測試的main()，將其作爲腳本調用，具有100％的測試覆蓋率，並且不需要忽略覆蓋報告中的任何代碼。