问题描述
具体来说,在临时脚本上生成文档的最佳实践是什么?
例如:
import someThirdPartyLibrary
def main():
someThirdPartyLibrary.somefunc()
if __name__ == '__main__':
main()
需要在环境中安装 someThirdPartyLibrary
否则 pdoc 将失败。
选项似乎是:
A.将所有 3rd 方库安装到我正在运行 pdoc 的任何环境中。这似乎完全没有必要,因为 pdoc 不需要实际运行代码只加载它。
B.在 main 中隐藏导入并违反 PEP8
def main():
import someThirdPartyLibrary
someThirdPartyLibrary.somefunc()
if __name__ == '__main__':
main()
C.比 A 和 B 更好的东西是最佳实践吗?
解决方法
这可能不是您要找的答案,但 pdoc 需要导入您的代码来解析(动态)注释。因此,我真的建议只使用选项 A:安装所有第三方库。