unicode_literals 和 Python 2.7 中的 doctest 和 Python 3.5

unicode_literals and doctest in Python 2.7 AND Python 3.5

考虑以下演示脚本:

# -*- 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),导入语句在 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+ 上都通过,而没有丑陋的黑客攻击? 我也使用这些文档字符串来生成文档,所以我更愿意或多或少地保留它们。

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

您仍然可以使用 doctest 字符串,因为它们可能对文档很有帮助。着眼于未来,为Python 3编写。同时,为另一个unit-testing框架编写单元测试。不要依赖 doctest 作为 Python 2 版本的 application/module.

这是纯 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'', want), re.sub(
                    self.RE, r'', 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"
  • 相同
  • 在 运行 doctests 时使用 print("foo") 或 pr("foo") 进行调试。这仅在您仅将打印用于调试目的时才有效。

我已经从我不记得的地方偷了大部分。感谢这些互联网的无名英雄。