【问题标题】:How to hide 3rd party imports from pdoc?如何从 pdoc 隐藏 3rd 方导入?
【发布时间】: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


    【解决方案1】:

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2016-10-11
      • 2018-01-02
      • 2017-11-21
      • 1970-01-01
      相关资源
      最近更新 更多