在python文档字符串中记录可能在其他函数中发生的异常

Question

在Python中，除了当前函数/方法主体中引发的异常之外，我们是否应该在docstrings中记录可在其他函数/类中引发的异常？

不好。：我正在考虑Google Python文档字符串样式https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

自从我不使用Java以来​​已经有很长的时间了，但是您会在那里明确地说出方法可以通过“ throws”关键字引发哪种异常。

例如：

original_filename = file.headers['content-disposition'].partition('filename=').last

Answer 1

是的，您应该记录bar()（和foo()）可以引发MyException。这样一来，对于即将使用bar()的任何人来说，在调用它时都可能发生异常。