使用 Sphinx 记录带有命令行参数的脚本时出现异常

Question

有什么方法可以使用 Sphinx 来记录 python 脚本的命令行输入？我能够记录函数或方法的输入，但我不知道如何记录脚本的输入。我一直在尝试通过在源文件中添加 .. automodule:: scriptLDOnServer 行来遵循我用于函数的相同语法，其中 scriptLDOnServer 是我的 python 脚本（对应于我的主脚本）。

问题是我收到这样的错误：

__import__(self.modname)
File "/home/ubuntu/SVNBioinfo/trunk/Code/LD/scriptLDOnServer.py", line 10, in <module>
    genotype_filename=sys.argv[7];
IndexError: list index out of range

Sphinx 似乎正在尝试获取命令行输入，但在我的源文件中没有输入，因此导入失败。有没有办法解决这个问题？我应该在源代码中为脚本而不是模块使用另一个命令吗？

对不起，不是很清楚，但很难解释这个问题。

Answer 1

导入文件时失败，因为您试图在导入时访问sys.argv[7]。这不是你应该做的事情。此类可能失败的代码应该放在if __name__ == '__main__': 块或函数中，这样在导入代码时就不会执行。

这通常成立。您永远不应该*编写无法导入的代码或具有被导入的任何副作用的代码。

_{* 适用条件。但是你最好在打破这个规则之前有很好的理由。}