我目前正在向一个项目添加docstring,这样我就可以利用PyCharm中的Quick Documentation特性。我的项目看起来像:
script\
main.py
HelperClasses/
Helper.py
...
OtherClasses/
CustomClass1.py
CustomClass2.py
...
main.py
导入OtherClasses
中的所有文件,并利用它们实现各种功能,OtherClasses
反过来导入一些HelperClasses
并利用它们的功能。它们看起来像:
main.py
from OtherClasses import CustomClass1
from OtherClasses import CustomClass2
...
CustomClass1.py
from HelperClasses import Helper
...
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)
...
我的问题是,在尝试使用Quick Documentation功能的同时向CustomClass1.py
PyCharm添加代码时,无法找到Helper.py
文件并对其进行适当的索引,以便能够找到docstring。因此,我不能使用Quick Documentation特性来查找someFuncion
的docstring
我相信这是因为从CustomClass1.py
正确的导入应该是from ..HelperClasses import Helper
,但是由于这个脚本是从main.py
导入的,所以导入需要从main.py
的上下文中进行
此外,当我使用from ..HelperClasses import Helper
时,它被正确地索引,但是当运行main.py
时,会抛出一个错误:
ValueError: attempted relative import beyond top-level package
因此,在本例中,是否有任何方法可以保持docstrings工作,同时也有有效的导入
目前没有回答
相关问题 更多 >
编程相关推荐