Python模块单元测试的最佳文件结构组织?

时间:2011-10-07 09:38:40

标签: python unit-testing

可悲的是,我发现在Python中保留单元测试的方法太多了,而且通常没有很好的文档记录。

我正在寻找一种“终极”结构,可以完成以下大部分要求:

  • 可通过测试框架发现,包括:
    • pytest
    • nosetests
    • tox
  • 测试应该是outside the module files,而不是模块本身的另一个目录(维护),可能在包级别的tests/目录中。
  • 应该可以只执行一个测试文件(测试必须能够知道应该测试的模块在哪里)

请提供进行虚假测试的示例测试文件,指定文件名和目录。

1 个答案:

答案 0 :(得分:17)

这是我一直在使用的方法:

目录结构

# All __init__.py files are empty in this example.
app
    package_a
        __init__.py
        module_a.py
    package_b
        __init__.py
        module_b.py
    test
        __init__.py
        test_app.py
    __init__.py
main.py

<强> main.py

# This is the application's front-end.
#
# The import will succeed if Python can find the `app` package, which
# will occur if the parent directory of app/ is in sys.path, either 
# because the user is running the script from within that parect directory
# or because the user has included the parent directory in the PYTHONPATH
# environment variable.

from app.package_a.module_a import aaa
print aaa(123, 456)

<强> module_a.py

# We can import a sibling module like this.
from app.package_b.module_b import bbb
def aaa(s, t):
    return '{0} {1}'.format(s, bbb(t))

# We can also run module_a.py directly, using Python's -m option, which
# allows you to run a module like a script.
#
#    python -m app.package_a.module_a
if __name__ == '__main__':
    print aaa(111, 222)
    print bbb(333)

<强> module_b.py

def bbb(s):
    return s + 1

<强> test_app.py

import unittest

# From the point of view of testing code, our working modules
# are siblings. Imports work accordingly, as seen in module_a.
from app.package_a.module_a import aaa
from app.package_a.module_a import bbb

class TestApp(unittest.TestCase):

    def test_aaa(self):
        self.assertEqual(aaa(77, 88), '77 89')

    def test_bbb(self):
        self.assertEqual(bbb(99), 100)

# Simiarly, we can run our test modules directly as scripts using the -m option,
# or using nose.
#
#    python -m app.test.test_app
#    nosetests app/test/test_app.py

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