模块(Module)和包(Package)
为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在Python中,一个.py文件就称之为一个模块(Module)。
使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突。
如果不同的人编写的模块名相同怎么办?为了避免模块名冲突,Python又引入了按目录来组织模块的方法,称为包(Package)。
举个例子,一个abc.py
的文件就是一个名字叫abc
的模块,一个xyz.py
的文件就是一个名字叫xyz
的模块。
现在,假设我们的abc
和xyz
这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany
,按照如下目录存放:
1 | mycompany |
引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py
模块的名字就变成了mycompany.abc
,类似的,xyz.py
的模块名变成了mycompany.xyz
。
请注意,每一个包目录下面都会有一个__init__.py
的文件,这个文件是必须存在的,否则,Python就把这个目录当成普通目录,而不是一个包。__init__.py
可以是空文件,也可以有Python代码,因为__init__.py
本身就是一个模块,而它的模块名就是mycompany
。
类似的,可以有多级目录,组成多级层次的包结构。比如如下的目录结构:
1 | mycompany |
文件www.py
的模块名就是mycompany.web.www
,两个文件utils.py
的模块名分别是mycompany.utils
和mycompany.web.utils
。
自己创建模块时要注意命名,不能和Python自带的模块名称冲突。例如,系统自带了sys模块,自己的模块就不可命名为sys.py,否则将无法导入系统自带的sys模块。
Absolute Import
1 | from src.packone import test1 |
绝对引用通过package的绝对路径引入module,且路径要从最上一层的package写起。
from xxx import *
1 | # constants.py |
如果通过from core.constants import *
,则core.constants(对应constants.py文件)中定义的所有变量和函数,都可以在 views.py 中直接使用(无需通过 constants.MAX_ENTITY_NUMBER_LIMIT_FOR_DB_QUERY
来调用,就好像把constants.py文件全文复制到了views.py 中)
1 | #views.py |
import xxx
Note:datetime模块中有一个 datetime 方法。
1 | import datetime |
结论:通过 import
语句引用一个模块后,要通过[模块名].[方法名]()
来调用。
from [模块名] import xxx
1 | from datetime import datetime |
结论:通过 from xxx import xxx
语句引用一个模块后,直接可以调用这个模块的方法,即通过 [方法名]()
,而方法名前不再需要声明该方法所属的模块。
Relative Import
1 | from . import yyy |
相对引入方式使用一个点号来标识引入类库的精确位置。与linux的相对路径表示相似,一个点表示当前目录,每多一个点号则代表向上一层目录。
文件在文件夹中
1 | $ tree |
1 | from .core import models |
类似的,这里也是通过 from xxx import xxx
语句引用一个模块,所以可以直接调用 models
模块的方法,即通过 [方法名]()
,而方法名前不再需要声明该方法所属的模块。