f-string-文档字符串 (B021)

源自 flake8-bugbear linter。

作用

检查通过 f-string 编写的文档字符串。

为什么这不好？

Python 会将 f-string 解释为连接字符串，而不是文档字符串。 因此，“文档字符串”将无法通过 __doc__ 属性访问，也不会被任何自动化文档工具拾取。

示例

def foo():
    f"""Not a docstring."""

建议改为

def foo():
    """A docstring."""

参考

• PEP 257 – 文档字符串约定
• Python 文档: 格式化字符串字面值