Python 模块介绍，以及创建和导入模块

Python 模块

你可以简单的将 Python 脚本文件视为模块，虽然这并非得到模块的唯一方式，但却是最为常见的。模块包含了一系列代码，他们可能是变量，函数或类的定义，虽然没有强制性的约束，但同一模块中的代码关联性较高。比如，模块math拥有大量用于数学运算的函数。

# 模块 hello
print('这里是模块 hello！')

Python 模块的特性

在 Python 脚本文件中，你可以定义变量，函数，类等内容，这些内容即为模块的特性（Attribute），他们通过形式为m.name，m.name=value的语句被访问，其中m为模块，name为特性（名称，标识符），value为特性的新值。

当然，模块特性可以被称呼为变量，函数或类，这并没有什么问题。

# 判断 import.py 是否为程序入口点
if __name__ == '__main__':
	# 显示模块的文件路径
	print(__file__)


# 导入模块 teacher
import school.teacher
# 通过 __dict__ 读取 teacher 的 count 特性
print(school.teacher.__dict__['count'])

# Windows 中的输出结果
…\modules\import.py
0

Python 模块的私有特性

模块有没有私有特性，是模棱两可的，你可以为特性指定以一个或更多下划线（_）开头的名称，以表示该特性不适合被外部访问。但事实上，并不会阻止此类情况的发生，通过模块访问以下划线开头的特性是被允许的。

模块中以下划线（_）开头的特性，可能不会被from…import语句导入，这一点会在稍后给予说明。

Python 模块的文档字符串

与函数类似，模块也具有文档字符串，他被存储在模块的__doc__特性中，以向开发人员说明模块的相关信息。文档字符串本质上是书写在模块中的字符串字面量，他必须是模块的第一行有效代码，可以采用紧密相邻或加入空白的方式进行拼接，但不应包含需要运算的内容或操作。

'这里是模块 '"teacher"
# …

创建 Python 模块

当你创建一个py脚本时，也就创建了一个模块，这是最为简单和常见的方式。除此之外，你还可以通过ModuleType类来动态的创建模块。

# …
# 模块 teacher 中的变量 count，level
count = 0
level = 1


# 模块 teacher 中的函数 show
def show():
	print(f'教师的数量为 {count}')


# 使用 _ 开头，表示不适合外部访问
__avg_age = 33
def _add_avg_age(years):
	# 修改模块变量 __avg_age
	global __avg_age
	__avg_age += years

导入 Python 模块

要在一个模块中使用另一个模块或模块的某个特性，必须先进行导入操作，通常要用到import或from…import语句。这两种语句的用法不同，但均会将目标绑定至当前的命名空间，其对应的标识符默认为被绑定目标的名称。

使用 import 语句导入 Python 模块

import语句的基本格式如下，当你使用,时，相当于执行多个import语句，比如，import sys,os相当于执行了import sys和import os。

import <module>[ as <identifier>][, …]

module 部分

module为需要导入模块的完全限定名，当完全限定名包含多个模块时，这些模块将被依次导入。

identifier 部分

identifier是用于绑定操作的自定义标识符。

# 使用 as 关键字指定标识符
import school.teacher as t


# 可以通过 t 来使用 teacher 模块
t.count = 100
t.show()


# 通过模块调用所谓的私有特性
t._add_avg_age(1)
print(f'现在的平均年龄是 {t.__avg_age}')

教师的数量为 100
现在的平均年龄是 34

import school


def show_teacher():
	# 标识符 school 绑定在函数的命名空间中
	import school.teacher
	# 通过标识符 school 访问模块 teacher 的 show 函数
	school.teacher.show()


# 调用函数后，teacher 模块将成为 school 的一个特性
show_teacher()
# 通过 school 的特性访问模块 teacher
print(f'Teacher 模块？{school.teacher}')

教师的数量为 0
Teacher 模块？<module 'school.teacher' from '…'>

使用 from…import 语句导入 Python 模块

与import语句不同，from…import语句可以使用模块的相对名称（以.开头）或完全限定名，并且导入的目标不仅限于模块，还包括模块的特性，其语法格式如下。当你使用,时可以导入多个目标，比如，from sys import int_info,float_info，分别导入了sys模块的int_info和float_info特性。

form <module> import <target>[ as <identifier>][, …]

module 部分

module是一个完全限定名或相对名称（以.开头），用于查找需要导入的目标所在的模块或父级包，这些模块或包将被依次导入。

target 部分

target是开发人员真正希望导入的目标，他可以指模块，也可以指模块的特性。

identifier 部分

identifier是用于绑定操作的自定义标识符。

# teacher 模块的特性 count，level，show 将被绑定至当前命名空间
from school.teacher import *


# 此处的 count 指向 teacher 模块的 count 特性
print(f'我在模块 modules 中读取的教师数量为 {count}')
show()


# 这里会定义新的变量 count，而不是对 teacher 中的 count 进行赋值
count = 100
# 调用 show 后，并不会显示 100
show()


# ERROR * 并不会导入私有特性
print(__avg_age)

我在模块 modules 中读取的教师数量为 0
教师的数量为 0
教师的数量为 0
…
NameError: name '__avg_age' is not defined

# 模块 student 将通过父级包导入其他模块
import school.student

# 以相对路径导入 teacher 模块的特性
from .teacher import *


print('在 student 模块中调用 show')
show()


# 以相对路径导入 guard 模块
from . import guard
print(f'守卫人员是 {guard.name}')

在 student 模块中调用 show
教师的数量为 0
守卫人员是 汪汪大队

# 模块变量 name
name = '汪汪大队'

# 由于 teacher 模块之前已经被导入，因此他是包 school 的特性
from school import *


# 这里可以使用 teacher
print(teacher)
# ERROR 访问 school 的子模块 student 会导致异常
print(student)

<module 'school.teacher' from '…'>
…
NameError: name 'student' is not defined

源码

src/zh/modules·codebeatme/python·GitHub