You need to enable JavaScript to run this app. 如何让PyCharm识别通过`__doc__`赋值指定的doctest?
优惠活动
大模型
产品
解决方案
定价
更多

如何让PyCharm识别通过`__doc__`赋值指定的doctest?

不同doctest写法在PyCharm测试运行器的识别差异

可被PyCharm正常识别的常规doctest场景

按照Python标准函数docstring语法嵌入的doctest,可被PyCharm内置测试运行器正常识别、加载并执行,示例代码:

def f(x):
   """
   Increments by one.
   >>> f(2)
   3
   """
   return x + 1

PyCharm无法识别的特殊doctest场景

如果绕开标准docstring语法,直接通过给函数的__doc__属性赋值的方式写入doctest内容,PyCharm内置测试运行器将无法将这类内容判定为可执行的doctest用例。
这类写法的兼容性差异不会影响其他第三方测试工具的识别,比如执行pytest --doctest-modules -v命令时,这类doctest可以被正常解析运行。对应示例代码:

f = lambda x: x + 1
f.__doc__ = """
Increments by one.
>>> f(2)
3
"""

内容的提问来源于stack exchange,提问作者thorwhalen

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.01 03:45:04