如何测试或模拟“如果__name__ =='__main__'”内容

说我有一个包含以下内容的模块：

def main():
    pass

if __name__ == "__main__":
    main()

我想为下半部分编写一个单元测试（我想实现100％的覆盖率）。我发现执行导入/设置机制的内置的runpy模块__name__，但无法弄清楚如何模拟或检查main（）函数是否被调用。

到目前为止，这是我尝试过的：

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()

我将选择另一种替代方法，将其if __name__ == '__main__'从覆盖率报告中排除，当然，只有在测试中已经具有main（）函数的测试用例的情况下，您才能这样做。

至于为什么我选择排除而不是为整个脚本编写新的测试用例的原因是，因为正如我所说的那样，您已经为您的main()函数准备了一个测试用例，所以您为脚本添加了另一个测试用例（只是为了拥有一个测试用例）。 100％的覆盖率）将只是重复项。

有关如何排除的信息，if __name__ == '__main__'您可以编写coverage配置文件并添加到部分报告中：

[report]

exclude_lines =
    if __name__ == .__main__.:

可以在此处找到有关coverage配置文件的更多信息。

希望这会有所帮助。

您可以使用imp模块而不是import语句来执行此操作。该import语句的问题在于，在'__main__'有机会分配给之前，for的测试将作为import语句的一部分运行runpy.__name__。

例如，您可以这样使用imp.load_source()：

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

第一个参数分配给__name__导入模块的。

哇，我参加聚会有点晚了，但是我最近遇到了这个问题，我想我想出了一个更好的解决方案，所以这里...

我正在开发一个包含十几个脚本的模块，这些脚本都以这个完全相同的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())

然后将这个gem放在每个脚本文件的末尾：

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)

lam！现在，您可以编写一个testable main()，将其作为脚本调用，具有100％的测试覆盖率，并且无需忽略覆盖率报告中的任何代码。

一种方法是将模块作为脚本运行（例如os.system（...）），并将其stdout和stderr输出与期望值进行比较。

Python 3解决方案：

import os
from importlib.machinery import SourceFileLoader
from importlib.util import spec_from_loader, module_from_spec
from importlib import reload
from unittest import TestCase
from unittest.mock import MagicMock, patch
    

class TestIfNameEqMain(TestCase):
    def test_name_eq_main(self):
        loader = SourceFileLoader('__main__',
                                  os.path.join(os.path.dirname(os.path.dirname(__file__)),
                                               '__main__.py'))
        with self.assertRaises(SystemExit) as e:
            loader.exec_module(module_from_spec(spec_from_loader(loader.name, loader)))

使用定义自己的小功能的替代解决方案：

# module.py
def main():
    if __name__ == '__main__':
        return 'sweet'
    return 'child of mine'

您可以测试：

# Override the `__name__` value in your module to '__main__'
with patch('module_name.__name__', '__main__'):
    import module_name
    self.assertEqual(module_name.main(), 'sweet')

with patch('module_name.__name__', 'anything else'):
    reload(module_name)
    del module_name
    import module_name
    self.assertEqual(module_name.main(), 'child of mine')

我的解决方案是通过不提供必需的CLI参数，提供格式错误的参数，以无法找到所需文件的方式设置路径等方式使用imp.load_source()并强制提早引发异常main()。

import imp    
import os
import sys

def mainCond(testObj, srcFilePath, expectedExcType=SystemExit, cliArgsStr=''):
    sys.argv = [os.path.basename(srcFilePath)] + (
        [] if len(cliArgsStr) == 0 else cliArgsStr.split(' '))
    testObj.assertRaises(expectedExcType, imp.load_source, '__main__', srcFilePath)

然后，在测试类中，您可以使用以下功能：

def testMain(self):
    mainCond(self, 'path/to/main.py', cliArgsStr='-d FailingArg')

我发现此解决方案很有帮助。如果使用函数保留所有脚本代码，效果很好。该代码将作为一条代码行处理。整个行是否都为覆盖率计数器执行并不重要（尽管这并不是100％覆盖率实际期望的值）。技巧也被接受为pylint。;-)

if __name__ == '__main__': \
    main()