当直接run某个.py文件,而这个.py文件中有诸如:
from . import x
from .. import y
的导入语句时,就会报上述相对路径错误。
根源可归结为下面一句话:
Relative imports use a module’s name attribute to determine that module’s position in the package hierarchy.
也就是说,相对路径是根据当前module的名称属性来决定所导入的相对模块的位置的。
首先我们回顾一下绝对导入(即导入时的module名不以.开头)的搜寻路径(python 2.7文档6.1.2 The Module Search Path有详细阐述)。
1、built-in模块
2、在sys.path指定的目录中查找。sys.path在启动python解释器时按照下面的顺序初始化
a、当前运行脚本所在的目录
b、PYTHONPATH(即标准库,类似于'C:\\WINDOWS\\SYSTEM32\\python27.zip', 'C:\\Python27\\DLLs', 'C:\\Python27\\lib', 'C:\\Python27\\lib\\plat-win', 'C:\\Python27\\lib\\lib-tk', 'C:\\Python27',)
c、安装依赖的一些缺省值(类似于C:\\Python27\\lib\\site-packages)
你可以在代码中修改sys.path的值来改变搜寻路径,比如sys.path.append( "/specified/path"),当然也许你想将这个特定的搜寻路径放在sys.path的开头,这样具有更高的优先级,可以这样做sys.path.insert(0, "/specified/path")。
话说回来,相对导入是根据当前module的名称属性来决定所导入的相对模块的位置的,也就是根据当前module的__name__属性来计算相对导入模块的位置,如果你直接运行module.py(a.k.a python module.py),那么当前module.py的__name__属性值为"__main__"(比如你经常在其中添加 if __name__ == "__main__": do_something()),显然根据"__main__"来计算相对路径肯定得不到你想要的结果。
假设如下的代码层次结构:
package/
__init__.py
subpackage1/
__init__.py
moduleX.py(from .. import moduleA)
moduleA.py
run.py (import package.subpackage1.moduleX)
如果python run.py,则运行到moduleX中时,moduleX的__name__属性值就是package.subpackage1.moduleX,这时根据导入,会得到package.subpackage1.moduleX..moduleA,即package.subpackage1.moduleA也是准确的。
简而言之,当你运行某个python文件时,这个python脚本最好处于你的代码的顶部(top-level),且该python脚本都采用绝对路径导入(因为该python脚本的__name__此时是"__main__",仍无法使用相对路径)。在底层的目录中的python脚本就可以使用.开头的相对路径了。但要注意的是,为了采用相对路径能找到对应的module,目录中必须有__init__.py,这才会构造成一个package,即便__init__.py是个空文件!
一个绕过上述规则的方法(https://www.python.org/dev/peps/pep-0366/): __package__. When it is present, relative imports will be based on this attribute rather than the module __name__ attribute。你可以在代码中这样写:
if __name__ == "__main__" and __package__ is None:
__package__ = "expected.package.name"
即明确为module指所属的package名称。
参考:
1、https://blog.csdn.net/qiusuoxiaozi/article/details/79061885
2、https://www.python.org/dev/peps/pep-0366/
网友评论