Question

考虑以下演示脚本：

# -*- coding: utf-8 -*-
from __future__ import division
from __future__ import unicode_literals

def myDivi():
    """
    This is a small demo that just returns the output of a divison.
    >>> myDivi()
    0.5
    """
    return 1/2

def myUnic():
    """
    This is a small demo that just returns a string.
    >>> myUnic()
    'abc'
    """
    return 'abc'

if __name__ == "__main__":
    import doctest
    extraglobs = {}
    doctest.testmod(extraglobs=extraglobs)

doctest传递Python 3.5，但在Python 2.7.9上失败奇怪的是，divison测试工作，但unicode测试失败。

我见过各种问题，包括以下内容

但它们都有些不同（例如它们已经过时（指Py 2.6或Py 3.0），import语句在doctest而不是全局，使用pytest而不是标准doctest，切换到不同的断言等）
不过，我尝试了基于这些问题的各种替代方案，包括例如：

if __name__ == "__main__":
    import doctest
    import __future__
    extraglobs = {'unicode_literals': __future__.unicode_literals}
    doctest.testmod(extraglobs=extraglobs)

或

def myUnic():
    """
    This is a small demo that just returns a string.
    >>> myUnic()
    u'abc' # doctest: +ALLOW_UNICODE
    """
    return 'abc'

但它仍然无法在Python 2或3上运行，或者出现其他错误有没有办法让它传递3.5+和2.7.9+，没有丑陋的黑客？我也使用这些文档字符串来生成文档，所以我更愿意保留它们或多或少。

Answer 1

这可以用纯doctest完成工作：

if __name__ == "__main__":
    import doctest, sys, logging, re
    from doctest import DocTestFinder, DocTestRunner
    # Support print in doctests.
    L_ = logging.getLogger(":")
    logging.basicConfig(level=logging.DEBUG)
    pr = print = lambda *xs: L_.debug(" ".join(repr(x) for x in xs))

    # Make doctest think u"" and "" is the same.
    class Py23DocChecker(doctest.OutputChecker, object):
        RE = re.compile(r"(\W|^)[uU]([rR]?[\'\"])", re.UNICODE)

        def remove_u(self, want, got):
            if sys.version_info[0] < 3:
                return (re.sub(self.RE, r'\1\2', want), re.sub(
                    self.RE, r'\1\2', got))
            else:
                return want, got

        def check_output(self, want, got, optionflags):
            want, got = self.remove_u(want, got)
            return super(Py23DocChecker, self).check_output(
                want, got, optionflags)

        def output_difference(self, example, got, optionflags):
            example.want, got = self.remove_u(example.want, got)
            return super(Py23DocChecker, self).output_difference(
                example, got, optionflags)

    finder = DocTestFinder()
    runner = DocTestRunner(checker=Py23DocChecker())
    for test in finder.find(sys.modules.get('__main__')):
        runner.run(test)
    runner.summarize()

对待u“ foo”与“ foo”相同
运行doctest时，使用print（“ foo”）或pr（“ foo”）进行调试。仅当您仅将打印用于调试目的时，此方法才有效。

我大部分是从我不记得的地方偷来的。感谢互联网上这些鲜为人知的英雄。

Answer 2

与Martijn Pieters在Multi version support for Python doctests中的评论一致，我建议依靠使用一些真正的单元测试框架进行测试。

您仍然可以使用doctest字符串，因为它们可能对文档很有用。考虑未来，并为Python 3编写它们。同时，为另一个单元测试框架编写单元测试。不要依赖doctest用于应用程序/模块的Python 2版本。

Python 2.7和Python 3.5

2 个答案: