python - PyCharm 未正确从导入中提取文档字符串

Question

我目前正在将文档字符串添加到项目中，以便我可以利用 PyCharm 中的快速文档功能。我的项目看起来像：

script\
    main.py
    HelperClasses/
        Helper.py
        ...
    OtherClasses/
        CustomClass1.py
        CustomClass2.py
        ...

main.py导入其中的所有文件OtherClasses并利用它们实现各种功能，OtherClasses然后导入其中的一些文件HelperClasses并利用它们的功能。它们看起来像：

主文件

from OtherClasses import CustomClass1
from OtherClasses import CustomClass2

... 

CustomClass1.py

from HelperClasses import Helper
... 

助手.py

def someFunction(x, y, z):
    """
    Does something with x, y and z.
    :param x: X value
    :param y: Y value
    :param z: Z value
    :return: Some other value
    """
    return doSomething(x, y, z)

... 

我的问题是，在向PyCharm添加代码时尝试使用快速文档功能时无法找到文件并正确索引以启用文档字符串。因此，我无法使用快速文档功能来查找.CustomClass1.pyHelper.pysomeFuncion

我相信这是因为从CustomClass1.py正确的导入将是from ..HelperClasses import Helper因为此脚本是从main.py导入中导入的，因此需要从main.py.

此外，当我使用from ..HelperClasses import Helper它时，它被正确索引，但是当main.py运行时，会引发错误：

ValueError: attempted relative import beyond top-level package

因此，有没有办法让文档字符串保持工作，同时在这个例子中也有有效的导入？

标签： pythonimportpycharmpython-importdocstring