配置Django以查找所有模块中的所有doctests?

时间:2009-10-23 19:19:45

标签: django doctest django-testing

如果我运行以下命令:

>python manage.py test

Django在我的应用程序中查看tests.py,并在该文件中运行任何doctests或单元测试。它还会查看__ test __字典以运行额外的测试。所以我可以链接来自其他模块的doctests:

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

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

如果我想要包含更多doctests,那么在这本字典中有没有比枚举它们更简单的方法?理想情况下,我只想让Django在myapp应用程序的所有模块中找到所有doctests。

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

5 个答案:

答案 0 :(得分:2)

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

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文件中,这样他们就不会与我的应用程序代码混淆了。修改它只是在每个模块中查找doc测试并在找到它们时运行它们很容易。

答案 1 :(得分:2)

使用django-nose,因为nose会自动以递归方式查找所有测试。

答案 2 :(得分:1)

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

tests.py:

def find_modules(package):
    """Return list of imported modules from given package"""
    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 ('__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包。

答案 3 :(得分:1)

感谢Alex和Paul。这就是我想出的:

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

答案 4 :(得分:1)

我不能加快Djano的测试速度,但据我所知,它使用自动unittest发现,就像python -m unittest discover和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