Python 模块与包

Python 是通过模块与包来实现模块化开发

模块、包

• 模块 ( Module ): 项目中每个.py文件都可被视为一个模块
• 包 ( Package ): 包含一系列相关模块文件的目录

目录结构

[工作区目录]
│
├─ [包]
│  ├─ __init__.py
│  ├─ [模块].py
│  ├─ [模块].py
│  └─ ...
│
├─ [包]
│  ├─ __init__.py
│  ├─ [模块].py
│  ├─ [模块].py
│  ├─ ...
│  └─ [包]
│      ├─ __init__.py
│      ├─ [模块].py
│      ├─ [模块].py
│      └─ ...
│
└─ ...

模块

模块的导入

通过关键字import导入模块文件

导入的模块中的成员可在当前模块中直接使用

完全导入

import 模块

from 模块 import *

from 包.子包 import 模块

from 包.子包.模块 import *

部分导入

from 模块 import 成员
from 模块 import 成员1, 成员2

from 包.子包.模块 import 成员
from 包.子包.模块 import 成员1, 成员2

别名导入

import 模块 as 别名

from 模块 import 成员 as 别名

from 包.子包 import 模块 as 别名

from 包.子包.模块 import 成员 as 别名

相对导入 vs 绝对导入

# 相对当前模块文件的相对路径进行导入
from . import 模块
from .. import 模块

# 相对于整个工作区的绝对路径进行导入
from 包.子包 import 模块

---

模块的导出

模块文件默认导出其中全部成员

每个模块文件都有一个内置变量__all__用于当前模块对外导出的成员

约定名字前面有前缀_的成员仅在当前模块内使用

完全导出

# 定义成员1
# 定义成员2
# 定义成员3

部分导出

# 定义成员1
# 定义成员2
# 定义成员3

__all__ = ["定义成员1", "定义成员2"]

例子：模块内利用内置变量__all__对外导出部分成员

目录结构

[项目目录]
├─ ...
├─ main.py
└─ tools.py

main.py

from tools import *

a()   # "aaaaa"
b()   # 报错 NameError

tools.py

__all__ = ["a"]


def a():
    print("aaaaa")


def b():
    print("bbbbb")

---

__name__

每个模块文件都有一个内置变量__name__

当模块文件被直接执行时该变量值为"__main__"

例子：利用内置变量__name__判断当前模块的测试代码是否应该自动执行

def say_hello():
    print("Hello")


def say_something(msg):
    print(msg)


if __name__ == "__main__":      
    """
    测试代码
    下文代码在模块被导入时不会自动调用，仅在直接执行该文件时才调用
    """
    say_hello()
    say_something("test...")

包

__init__.py

目录中存在__init__.py文件时该目录被视为一个 Python 包

该文件主要用于汇总以及限定当前包目录中的模块以方便导入、定义包级别的初始化逻辑

该文件也可以为空，用于仅仅说明当前目录为一个包

__init__.py

"""
包的说明文档
包的说明文档
"""
from .模块1 import *
from .模块2 import *
from .模块3 import 成员1, 成员2
# ...

目录结构

[工作区目录]
│
└─ [包]
   ├─ __init__.py
   ├─ [模块1].py
   ├─ [模块2].py
   ├─ [模块3].py
   └─ ...