Python 文档字符串：不一致的前导空白错误，没有换行

发布于07月25日

我的文档字符串:

def some_f():
    """
    1. First story
        >>> str(5)
        if you want to see the value:
        >>> print(str(5))
    2. Another story
        bla bla
    """

在使用doctest时，我得到的结果是:

ValueError:File.Class.ome_f的文档字符串的第6行具有不一致的前导空格:‘2.另一个故事’

我已经读到(here和here)，当用户在文档字符串中使用\n或其他特殊字符时，可能会发生这个问题，但这里不是这种情况.不知道为什么会发生这种情况，也不知道如何解决.事实上，它希望我将第二个点向右移动，因为这可以正常工作:

def some_f():
    """
    1. First story
        >>> str(5)
        if you want to see the value:
        >>> print(str(5))
        2. Another story
        bla bla
    """

但这不是我想要的.

推荐答案

问题和标题应该包括这样的说明:出现这个错误是因为您运行的是doctest.testmod()；否则，Python不会关心您的格式.

问题是，doctest期望每一行看起来像是交互提示的内容后面都跟着doctest的预期输出，并且它认为空行或出现>>>的其他值就是预期结果的结束.

留下一个空行以显示预期输出的结束，它将不会关心下一行的空格.


def some_f():
    """
    1. First story
        >>> str(5)
        '5'
        
        if you want to see the value:
        >>> print(str(5))
        5
        
    2. Another story
        bla bla
    """
    pass

if __name__ == '__main__':
    import doctest
    doctest.testmod()

如果在'5'之后没有换行符，这种情况将失败，因为doctest将包括if you want to see the value:作为来自>>>str(5)的预期输出的一部分