python - Pydoc 找不到已安装的模块

Question

我正在尝试使用 pydoc 生成 HTML 文档。该项目分为几个子文件夹，所有子文件夹都包含 __init__.py 文件。

我主文件夹中__init__.py的内容如下:

import sys
sys.path.insert(1, '.')

我可以毫无问题地运行该应用程序。子文件夹中的文件可以看到主文件夹中的文件，并且所有导入的模块都可以正常运行。

但是，pydoc 给我带来了问题。如果我尝试对子文件夹中的文件使用它，他们将看不到主文件夹中的文件。

此外，看不到已安装的模块。例如，在我的 ftp_operations 文件(位于主文件夹中)上运行 pydoc -w 说它找不到 Paramiko，它在应用程序中运行得很好。

我见过一些类似的问题，但大多数答案都涉及添加我已有的 __init__.py 文件。我也尝试了 pdoc3，结果相同。我究竟做错了什么？我正在使用 Python 3.7。

提前致谢!

Answer 1

您使用的是虚拟环境吗？ pydoc 默认情况下将调用系统 Python 可执行文件(它可能无法找到您的模块)，即使该命令是从虚拟环境中调用的也是如此。

如果你希望使用虚拟环境使用pydoc生成文档，你需要调用python -m pydoc [OPTIONS]来确保正确的python可执行文件是叫。或者，您可以编辑 pydoc 脚本的 shebang 行以引用您的环境。

例如，pydoc 脚本应该类似于:

#!/some/system/path/bin/python3.7

import pydoc
if __name__ == '__main__':
    pydoc.cli()

并且会变成这样:

#!/usr/bin/env python

import pydoc
if __name__ == '__main__':
    pydoc.cli()