python模块引用梳理

文件组织结构：

复制代码

t

├── __init__.py

├── main.py

├── t1

│ ├── A.py

│ └── __init__.py

└── t2

├── B.py└── __init__.py

复制代码

A.py

def test():

print 't.t1.A.test()'

B.py

def test():

print 't.t2.B.test()'

执行：

python t/main.py

问题1：

在main.py中引用t2/B的test方法，如何写？

方式1： from xxx import xxx

from t2 import B

B.test()

这个写法很糟糕， 但能解决目前问题。糟糕的地方在于隐晦的引入t2。更好的方式是相对引用。

from .t2 import B

B.test()

但如果用 python t/main.py执行会报错，此处原因请参考这。原因是相对引用默认作为包的方式才能运行。

正确执行方法(linux shell下)： python -m t.main

这个写法也不够好！B在具体的代码行，看不出其出处。更好的方式是

from . import t2

t2.B.test()

但运行时会报错！

AttributeError: 'module' object has no attribute 'B'

大致意思是， 模块对象没有B属性！这点从java/.net转过来的也许有一点不习惯！

pythony引入一个模块(import m) <==> 引入m/__init__.py文件，里面有啥就有啥，反之亦然。

破解方法：

1. 不太好的方法有上一个代码例子， 即： from ... import ...2. 在模块的__init__.py文件中自动引入这些文件， 推荐最为最佳实践！ 此处修改 t/t2/__init__.py文件

import B

这样问题就完美结果了。总结下，最佳实践demo如下：

t/main.py

-- coding:utf-8 --

from . import t2

t2.B.test()

t/t2/__init__.py

-- coding:utf-8 --

from . import B

即：

相对引用尽量引入更顶层包通过命名空间引用具体的方法或者类被引用包（子包）需要在__init__.py中声明(import)可以被外部直接访问的文件

问题2：

在t2/B中如何引用t1/A的test方法？

t/t2/B.py

from .. import t1

t1.A.test()

同时声明A

t/t1/__init__.py

from . import A

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。

举个例子：

目录树

testIm/

--__init__.py

--main.py : from Tom import tom

--Tom/

--__init__.py : print("I'm Tom's __init__!")

--tom.py : from . import tomBrother, from .. import Kate,print("I'm Tom!")

--tomBrother.py print(I'm Tom's Brother!)

--Kate/

--__init__.py : print("I'm Kate's __init__!")

--kate.py

运行文件：main.py

结果：

复制代码

I'm Tom's __init__!

I'm Tom's Brother!

Traceback (most recent call last):

File "D:PythonLearningTestIm2main.py", line 3, in

from cat import cat

File "D:PythonLearningTestIm2catcat.py", line 4, in

from .. import dog

ValueError: attempted relative import beyond top-level package

复制代码

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

修改方法：

目录树

test/

--main.py : from testIm.Tom import tom

--testIm/

--__init__.py

--Tom/

--__init__.py : print("I'm Tom's __init__!")

--tom.py : from . import tomBrother, from .. import Kate,print("I'm Tom!")

--tomBrother.py print(I'm Tom's Brother!)

--Kate/

--__init__.py : print("I'm Kate's __init__!")

--kate.py

运行文件：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。