python - pdoc 无法从其他模块导入函数

Question

我正在使用 python 2.7 并尝试使用 pdoc 为我们的测试项目收集文档。

pdoc 位于:D:\dev\Python27\Scripts这里的回归项目:C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Tests我们正在使用 proboscis 进行测试，我正在尝试为单独的测试组创建 html 文档，在我的例子中是一个单独的 python 文件。我运行这样的命令:

D:\dev\Python27\Scripts>python pdoc --html "C:\views\md_LDB_RegressionTests_v03.
1_laptop\mts\Tests\LDB\Regression\Tests\tests\check_system_management\check_capa
bilities_encoding_problems.py"

得到这样的答案:

Traceback (most recent call last):
  File "pdoc", line 458, in <module>
    module = imp.load_source('__pdoc_file_module__', fp, f)
  File "C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Te
sts\tests\check_system_management\check_capabilities_encoding_problems.py", line
 4, in <module>
    from common.builders.system_request import default_create_system, create_cap
ability
ImportError: No module named common.builders.system_request

pdoc 无法从我们的回归中的其他模块导入函数...我们项目的结构如下所示:

-Tests (C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Tests)
  -"common" package (with init file)
     -"builders" packege
        -system_request.py
  -"test" package
      -check_system_management package
         -check_capabilities_encoding_problems.py - this is the file i want to get documentation to

当然还有很多其他包，但我不确定现在描述所有结构是否有意义

check_capabilities_encoding_problems.py 的导入部分如下所示:

import urllib
from hamcrest import assert_that, all_of
from proboscis import test, before_class, after_class
from common.builders.system_request import default_create_system, create_capability
from common.entity.LDBChecks import LDBChecks

如何指向 pdoc 去寻找其他模块的功能？谢谢!

Answer 1

您可以设置 PYTHONPATH 环境变量。这是一条说明 python 在哪里可以找到第 3 方模块和包的路径。