导入模块之前的nose-doctest模块夹具

时间:2014-10-18 14:04:48

标签: python testing nose doctest

我使用nose进行测试收集,我也想使用它的doctest插件。我有一个模块,需要一个夹具才能导入。因此,我不能使用鼻子的模块固定装置,因为它们是从被测模块加载的。有没有办法在模块外面为nose-doctest指定模块夹具?

对于某些用例,一个选项是检测在doctest下运行并在模块的开头应用fixture。我很想知道这个用例的答案。

但是,在某些情况下,这不起作用:当导入因SyntaxError而失败时,不会运行任何模块代码。在我的例子中,我主要开发的代码兼容python 2和python 3(没有2to3)。然而,有一些python 3特定模块,当在python 2下运行时根本不应该由鼻子检查。我最好的选择是什么?

编辑:MWE (针对SyntaxError情况)

我有一个包含许多小模块的包,其中一些使用python 3语法。 这是包结构:

~/pckg/
  __init__.py
  py3only.py
  ... (other modules)
  tests/
    test_py3only.py

有些测试编写为unittest.TestCase,但我也希望测试文档字符串中的代码示例。 ~/pckg/__init__.py是空的。

〜/ pckg / py3only.py:

def fancy_py3_func(a:"A function argument annotation (python 3 only syntax)"):
    """ A function using fancy syntax doubling it's input.

    >>> fancy_py3_func(4)
    8
    """
    return a*2

〜/ pckg /测试/ test_py3only.py:

import sys, unittest

def setup_module():
    if sys.version_info[0] < 3:
        raise unittest.SkipTest("py3only unavailable on python "+sys.version)

class TestFancyFunc(unittest.TestCase):
    def test_bruteforce(self):
        from pckg.py3only import fancy_py3_func
        for k in range(10):
            self.assertEqual(fancy_py3_func(k),2*k)

在python 3上测试,所有内容都经过测试并通过(从封闭文件夹运行,例如~):

~ nosetests3 -v --with-doctest pckg
Doctest: pckg.py3only.fancy_py3_func ... ok
test_bruteforce (test_py3only.TestFancyFunc) ... ok

在python 2上,~/pckg/tests/test_py2only.py的模块夹具正确检测到情况并跳过测试。不过,我们从SyntaxError获得了~/pckg/py3only.py

~ nosetests -v --with-doctest pckg 
Failure: SyntaxError (invalid syntax (py3only.py, line 1)) ... ERROR
SKIP: py3only unavailable on python 2.7.6 (default, Mar 22 2014, 22:59:56)

类似于~/pckg/tests/test_py3only.py:setup_module()的函数可以解决这个问题,如果我可以让nose在它的doctest插件尝试导入该模块之前运行该代码。

看起来我最好的办法是编写一个适当的顶级测试脚本来处理测试集合......

2 个答案:

答案 0 :(得分:2)

可以使用nose-exclude nose插件排除特定的测试文件,目录,类或方法。它有--exclude-*个选项。

要处理缺少的模块,您必须使用sys.modules修补mock

F.e,Calc模块中有一个mycalc类,但我无法访问它,因为它已丢失。还有两个模块,mysuper_calcmysuper_calc3,后者是Python 3特定的。这两个模块导入mycalcmysuper_calc3不应该在Python 2下测试。如何在模块中对它们进行doctest测试,那是在纯文本文件中?我认为这是OP的情况。

计算值/ mysuper_calc3.py

from sys import version_info
if version_info[0] != 3:
    raise Exception('Python 3 required')
from mycalc import Calc
class SuperCalc(Calc):
    '''This class implements an enhanced calculator
    '''
    def __init__(self):
        Calc.__init__(self)

    def add(self, n, m):
        return Calc.add(self, n, m)

计算值/ mysuper_calc.py

from mycalc import Calc

class SuperCalc(Calc):
    '''This class implements an enhanced calculator
    '''
    def __init__(self):
        Calc.__init__(self)

    def add(self, n, m):
        return Calc.add(self, n, m)

现在模拟mycalc

>>> from mock import Mock, patch
>>> mock = Mock(name='mycalc')

模块mycalc包含类Calc,其方法为add。我使用SuperCalc测试add实例2+3方法。

>>> mock.Calc.add.return_value = 5  

现在可以在sys.modules块中有条件地导入补丁mysuper_calc3with

>>> with patch.dict('sys.modules',{'mycalc': mock}):
...     from mysuper_calc import SuperCalc
...     if version_info[0] == 3:
...         from mysuper_calc3 import SuperCalc

calc / doctest / mysuper_calc_doctest.txt

>>> from sys import version_info
>>> from mock import Mock, patch
>>> mock = Mock(name='mycalc')
>>> mock.Calc.add.return_value = 5

>>> with patch.dict('sys.modules',{'mycalc': mock}):
...     from mysuper_calc import SuperCalc
...     if version_info[0] == 3:
...         from mysuper_calc3 import SuperCalc
>>> c = SuperCalc()
>>> c.add(2,3)
5

文件mysuper_calc_doctest.txt必须单独放在自己的目录中,否则nosetests会在非测试模块中搜索doctest

PYTHONPATH=.. nosetests --with-doctest --doctest-extension=txt --verbosity=3

Doctest:mysuper_calc_doctest.txt ... ok


在0.038s中进行1次测试

nosetests的包装器,用于检测Python 3,它将没有语法错误的.py文件传递给nosetests

mynosetests.py

import sys
from subprocess import Popen, PIPE
from glob import glob

f_list = []

py_files = glob('*py')
try:
    py_files.remove(sys.argv[0])
except ValueError:
    pass

for py_file in py_files:
    try:
        exec open(py_file)
    except SyntaxError:
        continue
    else:
        f_list.append(py_file)

proc = Popen(['nosetests'] + sys.argv[1:] + f_list,stdout=PIPE, stderr=PIPE)
print('%s\n%s' % proc.communicate())
sys.exit(proc.returncode)

答案 1 :(得分:1)

Nose有以下选项:

  --doctest-fixtures=SUFFIX
                    Find fixtures for a doctest file in module with this
                    name appended to the base name of the doctest file

也许您可以将灯具隔离到单独的文件中?