Python包的相对导入时出现错误的解决方法

在练习Python中package的相对导入时，即

from . import XXX

或者

from .. import XXX

时会遇到这样两个错误：

SystemError: Parent module '' not loaded, cannot perform relative import

和

ValueError: attempted relative import beyond top-level package

其实这两个错误的原因归根结底是一样的：在涉及到相对导入时，package所对应的文件夹必须正确的被python解释器视作package，而不是普通文件夹。否则由于不被视作package，无法利用package之间的嵌套关系实现python中包的相对导入。

文件夹被python解释器视作package需要满足两个条件：
　　1、文件夹中必须有__init__.py文件，该文件可以为空，但必须存在该文件。
　　2、不能作为顶层模块来执行该文件夹中的py文件（即不能作为主函数的入口）。
　　补充：在"from YY import XX"这样的代码中，无论是XX还是YY，只要被python解释器视作package，就会首先调用该package的__init__.py文件。如果都是package，则调用顺序是YY，XX。
　　另外，练习中“from . import XXX”和“from … import XXX”中的’.‘和’…’，可以等同于linux里的shell中’.‘和’…'的作用，表示当前工作目录的package和上一级的package。

举个例子：

目录树

　　运行文件：main.py

结果：

I'm Tom's __init__!
I'm Tom's Brother!
Traceback (most recent call last):
File "D:\PythonLearning\TestIm\main.py", line 3, in 
from Tom import tom
File "D:\PythonLearning\TestIm\Kate\kate.py", line 4, in 
from .. import kate
ValueError: attempted relative import beyond top-level package

可以看到from . import tomBrother顺利执行，首先执行了Tom文件夹下的__init__.py文件，后来执行了tomBrother.py文件，但是当执行到“from … import kate”时报错，这是因为我们是在TestIm文件夹下把main.py文件作为主函数的入口执行的，因此尽管TestIm文件夹中有__init__.py文件，但是该文件夹不能被python解释器视作package，即Tom package不存在上层packge，自然会报错，相对导入时超出了最高层级的package。

修改方法：

目录树

运行文件：main.py

结果：

I'm top's __init__!
I'm Tom's __init__!
I'm Tom's Brother!!
I'm Kate's __init__!
I'm Tom!

即主函数入口不在TestIm中，则TestIm和其同样包含__init__.py文件的子文件夹都被python解释器视作package，形成相应的嵌套关系。可以正常使用from . import XXX和from … import XXX。

这里其实还有一篇博客写的也挺好，但是呢。。TMD自己估计也是外行，而且自己没有测试。。暂且喷他一波吧。。
原文如下：
############################# START ###################################
python脚本的package相对导入时，常见两种写法：

from . import XXX
from .. import XXX

但有时会出现这样的错误：

SystemError: Parent module '' not loaded, cannot perform relative import
ValueError: attempted relative import beyond top-level package

二者的问题是一样的，都是目录被视为package时的解释错误。

相对导入时，package所对应的文件夹必须正确的被python解释器视作package，而不是普通文件夹。否则由于不被视作package，无法利用package之间的嵌套关系实现python中包的相对导入。

文件夹被python解释器视作package需要满足两个条件：

该文件夹中必须有__init__.py文件，它可以为空，但必须存在
该文件夹不能作为顶层模块来执行文件夹中的py文件 (即不能作为主函数的入口)
附：在from YY import XX中，无论是XX还是YY，只要被python解释器视作package(文件夹or脚本文件都可成为package)，就会首先调用该package的__init__.py文件。如果都是package，则调用顺序是YY，XX。

举例说明：
目录树

test/
　--__init__.py
　--main.py : from . import module
　--main1.py : from sub1 import sub11
　--main2.py : from sub1 import sub13
　--main3.py : from sub2 import sub21
　--module.py
　--sub1/
　　　--__init__.py : 
　　　--sub11.py : from . import sub12
　　　--sub13.py : from .. import sub21
　　　--sub12.py
　--sub2/
　　　--sub21.py

[sjy@clylab test]$ python3 main.py 报错，违反条件2，test不能被视为package，module无法导入
[sjy@clylab test]$ python3 main1.py 正确，sub1和sub11都是package
[sjy@clylab test]$ python3 main2.py 报错，违反条件2，sub1和sub13是package，但因为test不是package，sub21无法导入
[sjy@clylab test]$ python3 main3.py 报错，违反条件1，sub2不是package

[sjy@clylab sub1]$ python3 sub11.py 报错，sub1不能被视为package，sub12无法导入
[sjy@clylab sub1]$ python3 sub13.py 报错，sub1和test都不是package

一种方法是更改目录树：

parent/
	--main.py : from test import module
	--main2.py : from test.sub1 import sub13
	--main3.py : from test.sub2 import sub21
	--test/
		--__init__.py
	　	--main1.py : from sub1 import sub11
	　	--module.py
		--sub1/
	　		--__init__.py : 
	　		--sub11.py : from . import sub12
	　		--sub13.py : from .. import sub21
	　		--sub12.py
		--sub2/
			--__init__.py : 
	　		--sub21.py

在parent目录下前4条能运行，后2条在test目录下能运行。

另一种方法是利用python的-m参数：

[sjy@clylab test]$python3 -m main

####################### END ############################
先来点评一下，上半部分的理论都是对的，可是例子写的不对，结果也不对。
1、from … import sub21
这尼玛明显不对啊，就算你在sub2文件夹里面加了__init__必定也是白瞎。。你的 … 后面好歹加上路径吧，例如：from …sub2 import sub21 ，这才行话吧，你以为你的sub21.py在哪里。。
除非，或者，你把sub21.py直接放在文件夹sub2同一级的目录下，这样也行。
又或者，你sys填加个临时搜索路径(如果不是同一级工作目录的话)，或者随便哪个路径下面放置sub21.py然后在python包里加入.pth这样的文件也行，(其实我记得这里好像有三种方法设置搜索路径的。。)，然后随便怎么直接import sub21，也可以哈哈哈。。

2、你是可以直接成功运行python main3.py的，就算是空的__init__.py，就算是没有__init__.py，我告诉你，一样可以直接绝对路径导入from sub2 import sub21，甚至直接import sub2.sub21，也可以成功，或者importlib那一套也可以，哈哈哈。。
3、结果不对啊。。还不如看我的，详见我的github：
https://github.com/edwardzcl/my_collection
另外他最后的方法

[sjy@clylab test]$python3 -m main

其实是把模块当做脚本使用。这个可以参考我的其他博客。

还可以看看这个哥们的：

运行结果：【Error】No module named ‘infogan’

运行结果：【Error】Parent module ‘’ not loaded, cannot perform relative import

运行结果：程序正常运行，不报错
这就是一个典型的运行脚本文件，与想要导入的包不在一个目录，还想要强行运行，只能通过添加搜索路径的方式导入了，而且还是绝对路径哈哈。

最后我非常推荐这个博客：

Python杂谈: init.py的作用

我们经常在python的模块目录中会看到 “__init__.py” 这个文件，那么它到底有什么作用呢？

1. 标识该目录是一个python的模块包（module package）

如果你是使用python的相关IDE来进行开发，那么如果目录中存在该文件，该目录就会被识别为 module package 。

2. 简化模块导入操作

假设我们的模块包的目录结构如下：

.
└── mypackage
    ├── subpackage_1
    │   ├── test11.py
    │   └── test12.py
    ├── subpackage_2
    │   ├── test21.py
    │   └── test22.py
    └── subpackage_3
        ├── test31.py
        └── test32.py

如果我们使用最直接的导入方式，将整个文件拷贝到工程目录下，然后直接导入：

from mypackage.subpackage_1 import test11
from mypackage.subpackage_1 import test12
from mypackage.subpackage_2 import test21
from mypackage.subpackage_2 import test22
from mypackage.subpackage_3 import test31
from mypackage.subpackage_3 import test32

复制代码
　　当然这个例子里面文件比较少，如果模块比较大，目录比较深的话，可能自己都记不清该如何导入。（很有可能，哪怕只想导入一个模块都要在目录中找很久）

这种情况下，__init__.py 就很有作用了。我们先来看看该文件是如何工作的。

2.1 __init__.py 是怎么工作的？

实际上，如果目录中包含了 __init__.py 时，当用 import 导入该目录时，会执行 __init__.py 里面的代码。

我们在mypackage目录下增加一个 __init__.py 文件来做一个实验：

.
└── mypackage
    ├── __init__.py
    ├── subpackage_1
    │   ├── test11.py
    │   └── test12.py
    ├── subpackage_2
    │   ├── test21.py
    │   └── test22.py
    └── subpackage_3
        ├── test31.py
        └── test32.py

mypackage/__init__.py 里面加一个print，如果执行了该文件就会输出：

print("You have imported mypackage")

下面直接用交互模式进行 import

>>> import mypackage
You have imported mypackage

很显然，__init__.py 在包被导入时会被执行。

2.2 控制模块导入
　　我们再做一个实验，在 mypackage/__init__.py 添加以下语句：

from subpackage_1 import test11

我们导入 mypackage 试试:

>>> import mypackage
Traceback (most recent call last):
  File "", line 1, in 
  File "/home/taopeng/Workspace/Test/mypackage/__init__.py", line 2, in 
    from subpackage_1 import test11
ImportError: No module named 'subpackage_1'

报错了。。。怎么回事？

原来，在我们执行import时，当前目录是不会变的（就算是执行子目录的文件），还是需要完整的包名。

from mypackage.subpackage_1 import test11

综上，我们可以在__init__.py 指定默认需要导入的模块

其实这里还有一个取巧的办法：

from .subpackage_1 import test11

使用相对导入就可以。

2.3 偷懒的导入方法

有时候我们在做导入时会偷懒，将包中的所有内容导入

from mypackage import *

这是怎么实现的呢？ __all__ 变量就是干这个工作的。

__all__ 关联了一个模块列表，当执行 from xx import * 时，就会导入列表中的模块。我们将 __init__.py 修改为 。

__all__ = ['subpackage_1', 'subpackage_2']

这里没有包含 subpackage_3，是为了证明 __all__ 起作用了，而不是导入了所有子目录。

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__doc__', '__loader__', '__name__', '__package__', '__path__', '__spec__']

子目录的中的模块没有导入！！！

该例子中的导入等价于

from mypackage import subpackage_1, subpackage_2
　　因此，导入操作会继续查找 subpackage_1 和 subpackage_2 中的 init.py 并执行。（但是此时不会执行 import *）

我们在 subpackage_1 下添加 init.py 文件:

__all__ = ['test11', 'test12']

# 默认只导入test11
# 这句话将上面的all覆盖了。。
from mypackage.subpackage_1 import test11

再来导入试试

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'test11']

如果想要导入子包的所有模块，则需要更精确指定。

>>> from mypackage.subpackage_1 import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'test11', 'test12']

3. 配置模块的初始化操作

在了解了 __init__.py 的工作原理后，应该能理解该文件就是一个正常的python代码文件。

因此可以将初始化代码放入该文件中。

参考：
http://www.cnblogs.com/ArsenalfanInECNU/p/5346751.html
https://blog.csdn.net/index20001/article/details/82778321
https://www.cnblogs.com/tp1226/p/8453854.html