当 epydoc 加载我的代码时，如何从 epydoc 获取堆栈跟踪？

Question

当我将代码加载到 epydoc 并仅加载顶部模块时，它会失败：

Error: TypeError: 'NoneType' object is not callable (line 10)

其中它引用的 NoneType 是我尝试在线加载的子模块9. 如何让 epydoc 解释为什么它无法在第 9 行加载模块，而不是仅仅继续前进并遇到错误？

根据诺斯科的要求。这是类似的示例，其中没有给出堆栈跟踪：

# foo.py
import bar
bar.baz()

# bar.py

def baz():
    print 'baz'

import os
os.environ['DOES_NOT_EXIST']

运行方式：

python2.6 epydoc --html foo.py

产生不太有用的内容：

    +--------------------------------------
    | In /home/ross/foo.py:
    | Import failed (but source code parsing was successful).
    |     Error: KeyError: 'DOES_NOT_EXIST' (line 1)

I want epydoc to tell me that the failure is on line 6 of bar.py. I don't want it to complain about foo.py's import of bar.py. I can't reproduce my specific problem in a small example, but my fundamental request is that when epydoc fails, I want it to print a stack trace to point to the issue. Whether it is loading a sub-module or calling not finding a key in a dictionary.

注意：这个问题的根源是我试图记录的代码是 SCons 的输入，它具有不同的环境设置问题。这就是为什么当我在 epydoc 中运行时它不起作用，但在使用 scons -f SConstruct.py 运行时脚本仍然有效。我还尝试使用 sphinx 生成文档。当我使用 sphinx 运行时，它实际上显示了堆栈跟踪。也许我会选择sphinx...

Answer 1

因此，如果我理解正确的话，您正在运行 epydoc 的模块会导入一个有错误的模块（不是您想要为其生成文档的模块）？

如果您需要完成的只是查看文件中出现错误的行以便进行调试，您也可以传入此文件，并且将列出发生错误的行号 em> 模块。

因此，运行：

epydoc --check foo.py bar.py

将输出：

+------------------------------------------------------------------------------------------------------------
| In /home/mark/Desktop/foo.py:
| Import failed (but source code parsing was successful).
|     Error: KeyError: 'DOES_NOT_EXIST' (line 2)
|   
+------------------------------------------------------------------------------------------------------------
| In /home/mark/Desktop/bar.py:
| Import failed (but source code parsing was successful).
|     Error: KeyError: 'DOES_NOT_EXIST' (line 7)
|   

由于 Bar.py 也被分析，因此列出了该文件中发生错误的行号。

现在，如果您正在寻找更强大的解决方案，因为这是您需要处理的常见问题，那么您将不得不开始破解epydoc内部结构。我自己也这样做过，所以我建议你尽可能避免掉进这个兔子洞。如果可以选择切换到 Sphinx，我会推荐这条路线。