配置 Django 以查找所有模块中的所有文档测试？

Question

如果我运行以下命令：

>python manage.py test

Django 会查看我的应用程序中的tests.py，并运行该文件中的任何文档测试或单元测试。它还查看 __ test __ 字典以运行额外的测试。因此，我可以从其他模块链接文档测试，如下所示：

#tests.py
from myapp.module1 import _function1, _function2

__test__ = {
    "_function1": _function1,
    "_function2": _function2
}

如果我想包含更多文档测试，是否有比在本字典中枚举它们更简单的方法？理想情况下，我只想让 Django 找到 myapp 应用程序中所有模块中的所有文档测试。

是否有某种反射黑客可以让我到达我想要的地方？

Answer 1

我不久前自己解决了这个问题：

apps = settings.INSTALLED_APPS

for app in apps:
    try:
        a = app + '.test'
        __import__(a)
        m = sys.modules[a]
    except ImportError: #no test jobs for this module, continue to next one
        continue
    #run your test using the imported module m

这使我可以将每个模块的测试放在自己的 test.py 文件中，这样它们就不会与我的应用程序代码的其余部分混淆。修改它很容易，只需在每个模块中查找文档测试并在找到它们时运行它们。

Answer 2

使用django-nose，因为nose会自动递归地查找所有测试。

Answer 3

我不太了解 Djano 的测试速度，但据我了解，它使用自动 unittest discovery，就像 python -m unittest discovery 和 Nose 一样。

如果是这样，只需将以下文件放在发现可以找到的地方（通常只需将其命名为 test_doctest.py 或类似名称即可）。

将 your_package 更改为要测试的包。所有模块（包括子包）都将进行文档测试。

import doctest
import pkgutil

import your_package as root_package


def load_tests(loader, tests, ignore):
    modules = pkgutil.walk_packages(root_package.__path__, root_package.__name__ + '.')
    for _, module_name, _ in modules:
        try:
            suite = doctest.DocTestSuite(module_name)
        except ValueError:
            # Presumably a "no docstrings" error. That's OK.
            pass
        else:
            tests.addTests(suite)
    return tests

Answer 4

以下是解决方案的关键要素：

tests.py：

def find_modules(package):
    """Return list of imported modules from given package"""
    files = [re.sub('\.py
要添加递归，请使用 os.walk() 遍历模块树并查找 python 包。
, '', f) for f in os.listdir(os.path.dirname(package.__file__))
             if f.endswith(".py") and os.path.basename(f) not in ('__init__.py', 'test.py')]
    return [imp.load_module(file, *imp.find_module(file, package.__path__)) for file in files]

def suite(package=None):
    """Assemble test suite for Django default test loader"""
    if not package: package = myapp.tests # Default argument required for Django test runner
    return unittest.TestSuite([doctest.DocTestSuite(m) for m in find_modules(package)])

要添加递归，请使用 os.walk() 遍历模块树并查找 python 包。

Answer 5

感谢亚历克斯和保罗。这就是我想出的：

# tests.py
import sys, settings, re, os, doctest, unittest, imp

# import your base Django project
import myapp

# Django already runs these, don't include them again
ALREADY_RUN = ['tests.py', 'models.py']

def find_untested_modules(package):
    """ Gets all modules not already included in Django's test suite """
    files = [re.sub('\.py
, '', f) 
             for f in os.listdir(os.path.dirname(package.__file__))
             if f.endswith(".py") 
             and os.path.basename(f) not in ALREADY_RUN]
    return [imp.load_module(file, *imp.find_module(file, package.__path__))
             for file in files]

def modules_callables(module):
    return [m for m in dir(module) if callable(getattr(module, m))]

def has_doctest(docstring):
    return ">>>" in docstring

__test__ = {}
for module in find_untested_modules(myapp.module1):
    for method in modules_callables(module):
        docstring = str(getattr(module, method).__doc__)
        if has_doctest(docstring):

            print "Found doctest(s) " + module.__name__ + "." + method

            # import the method itself, so doctest can find it
            _temp = __import__(module.__name__, globals(), locals(), [method])
            locals()[method] = getattr(_temp, method)

            # Django looks in __test__ for doctests to run
            __test__[method] = getattr(module, method)