【发布时间】:2021-09-11 03:28:48
【问题描述】:
从像 pdoc 这样的文档生成器中隐藏导入的正确方法是什么?
具体来说,在即席脚本上生成文档的最佳做法是什么?
例如:
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 更好的最佳做法?
【问题讨论】:
标签: python-3.x python-3.8 docstring pdoc