带有换行符的 Python doctest：不一致的前导空格错误

Question

在编写 python 文档测试时，如何在测试中正确地在字符串中引入换行符？这是一个简单的例子：

def remove_newlines(text):
    """
    >>> remove_newlines("line1 \n"
    ...                 "still line 1\r"
    ...                 "now line2 \n"
    ...                 "more line2\n")
    line1 still line1
    now line2 more line2
    """
    return text.replace('\n', '')

import doctest
doctest.run_docstring_examples(remove_newlines, globals())

其输出为：

Traceback (most recent call last):
...
ValueError: line 3 of the docstring for NoName has inconsistent leading whitespace: '"'

Answer 1

在我的情况下，只需在我的文档字符串前面加上 'r' 就可以了。 Python 3.5.1。

Answer 2

您需要转义反斜杠。

文档字符串本身就是一个字符串，其中\n 表示换行符。在

def foo():
    """
    print "Hello world\n";
    """
    pass

文档字符串不包含有效的 Python 语句，而是在引用的字符串中包含换行符

Answer 3

docstring docs 实际上暗示了这个问题，但并不完全清楚。

其他几个 stackoverflow 线程 here 和 here 很有帮助，但根据我自己的搜索条件，不容易找到。

这是我的实际解决方案：

def remove_CRs(text):
    r"""
    >>> output = remove_CRs("line1 \r"
    ...                     "still line1\n"
    ...                     "now line2 \r"
    ...                     "more line2\r")
    >>> print(output)
    line1 still line1
    now line2 more line2
    """
    return text.replace('\r', '')

import doctest
doctest.run_docstring_examples(remove_CRs, globals())

与原来的代码sn-p相比有三处变化：

1. 文档字符串必须是原始 python 字符串。
2. 我不得不在函数输出上使用print()。
3. 我不得不克服自己对\n 和\r 之间区别的困惑。 （那个在我身上。）

希望这可以节省其他人我花在这上面的几个小时。