跳到内容

文档字符串中的转义序列 (D301)

源自 pydocstyle 代码检查器。

有时提供修复。

作用

检查包含反斜杠但未定义为原始字符串字面量的文档字符串。

为什么这不好？

在 Python 中，反斜杠通常用于转义字符串中的字符。但是，在原始字符串（以 r 为前缀）中，反斜杠被视为字面字符。

PEP 257 建议对于包含反斜杠的文档字符串，使用原始字符串（即，r"""原始三引号"""）。使用原始字符串可确保任何反斜杠都被视为字面字符，而不是转义序列，从而避免混淆。

示例

def foobar():
    """Docstring for foo\bar."""


foobar.__doc__  # "Docstring for foar."

建议改为

def foobar():
    r"""Docstring for foo\bar."""


foobar.__doc__  # "Docstring for foo\bar."

参考