python - 为什么这个 doctest 在 Pycharm 中通过,而不是在命令行中?
问题描述
我在 Python 3.9 doctests 中有一个非常奇怪的单元测试失败。通常我必须清理我的问题,但这是在相当低级的代码中,所以我可以将其全部发布在这里。
我可以毫无问题地在 Pycharm 中运行这个 doctest。当我在命令行上运行它时,我得到了一个毫无意义的失败。任何帮助,将不胜感激。
二次求解器.py
import math
import numpy as np
import doctest
def solve(
a: float,
b: float,
c: float):
"""
:return: the roots of the quadratic arranged in a 0-2 floating point value-long array
>>> roots = solve(2., -1., 100.) # noRoots
>>> len(roots)
0
>>> roots = solve(1., 2., 1.) # oneRoot
>>> len(roots)
1
>>> round(roots[0], 9)
-1.0
>>> roots = solve(1., 4., 1.) # twoRoots_1
>>> len(roots)
2
>>> round(roots[0], 9)
-3.732050808
>>> round(roots[1], 9)
-0.267949192
>>> roots = solve(-9., 61., 19.) # twoRoots_2
>>> len(roots)
2
>>> round(roots[0], 9)
-0.298343001
>>> round(roots[1], 9)
7.076120779
"""
# https://math.stackexchange.com/questions/866331/numerically-stable-algorithm-for-solving-the-quadratic-equation-when-a-is-very
desc = b**2 - 4. * a * c
if desc < 0.:
# no roots
return np.array([])
elif desc == 0.:
# one root
root = -b / (2. * a)
return np.array([root])
else:
d = math.sqrt(b**2 - 4. * a * c)
root1 = (-b + d) / (2. * a)
root2 = (-b - d) / (2. * a)
if root1 < root2:
return np.array([root1, root2])
else:
return np.array([root2, root1])
doctest.testmod()
运行时的错误信息python -m doctest $PATH_TO_FILE$/quadratic_solver.py
:
**********************************************************************
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1820, in __main__.DebugRunner
Failed example:
runner.run(test)
Expected:
Traceback (most recent call last):
...
doctest.UnexpectedException: <DocTest foo from foo.py:0 (2 examples)>
Got:
Traceback (most recent call last):
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1336, in __run
exec(compile(example.source, filename, "single",
File "<doctest __main__.DebugRunner[15]>", line 1, in <module>
runner.run(test)
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1844, in run
r = DocTestRunner.run(self, test, compileflags, out, False)
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1483, in run
return self.__run(test, compileflags, out)
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1388, in __run
self.report_unexpected_exception(out, test, example,
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/doctest.py", line 1850, in report_unexpected_exception
raise UnexpectedException(test, example, exc_info)
UnexpectedException: <DocTest foo from foo.py:0 (2 examples)>
**********************************************************************
解决方案
这里的问题是线路doctest.testmod()
。
PyCharm 只是检测到 Python 模块中有 doctest,并使用它自己的 doctest runner 运行它们,所以它只是忽略了该行。
如果您从命令行调用 doctester,它的作用基本相同:它检测所有 doctests 并运行它们,但另外它还尝试对 doctest 执行行进行 doctest。如果您使用详细输出,您可以看到这一点:
python -m doctest -v $PATH_TO_FILE$/quadratic_solver.py
这表明所有 doctests 都正确运行,然后doctest
执行测试。那里的一个类doctest
(即DebugRunner
)本身有一个失败的文档测试(不确定这是否是一个错误,或者只是不打算以这种方式运行)。
这样做的原因是,如果通过库(使用if __name__ == "__main__"
)调用 testrunner 代码,您不会保护它不被执行,在这种情况下是来自 doctester。
因此,要解决此问题,您有两种可能性:
- 删除调用 doctests 的行;这将使它在命令行上与 doctest 一起工作
- 采用:
if __name__ == "__main__":
doctest.testmod()
这将使它与通过 doctest 的调用一起工作:
python -m doctest $PATH_TO_FILE$/quadratic_solver.py
以及只执行模块中 doctest 行的调用:
python $PATH_TO_FILE$/quadratic_solver.py
请注意,第二个变体也适用于您当前的代码,但这也意味着每当您从其他地方导入库时都会执行文档测试,这是您当然不想要的。
推荐阅读
- jquery - 我怎样才能让这个汉堡菜单变成一个 x onclick?
- c++ - C++ template class, template member friend function matching rules
- javascript - nodemailer发送空文件?
- r - R中的Excel Countif - 添加新列保持原始行数
- c# - 在WPF / MVVM Light中在屏幕上绘制矩形的最有效/最快的方法是什么
- django - django 模板子查询集
- java - 如何在 Android 应用程序的图库中显示保存的照片
- amazon-web-services - 重新阅读和更新弹性豆茎工作者的监督者
- google-bigquery - 如果使用子查询,Google Big Query 会收取查询全表的费用
- html - 是否可以在 HTML 链接中指定替代路径?