微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何从 pdoc 中隐藏第 3 方导入?

如何解决如何从 pdoc 中隐藏第 3 方导入?

从文档生成器(如 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 更好的东西是最佳实践吗?

解决方法

这可能不是您要找的答案,但 pdoc 需要导入您的代码来解析(动态)注释。因此,我真的建议只使用选项 A:安装所有第三方库。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。