【Python】import模块和包

模块和包

一. 模块

Python 模块(Module)，是一个 Python 文件，以 .py 结尾，包含了 Python 对象定义和Python语句。

模块能定义函数，类和变量，模块里也能包含可执行的代码。

1.1. 导入模块

1.1.1 导入模块的方式

• import [相对父路径名.相对子路径名.]模块名
• from 模块名 import 功能名
• from 模块名 import *
• import 模块名 as 别名
• from 模块名 import 功能名 as 别名

1.1.2 导入方式详解

1.1.2.1 import

语法

# 1. 导⼊模块
import 模块名
import 模块名1, 模块名2...

# 2. 调⽤功能
模块名.功能名()

体验

import math
print(math.sqrt(9)) # 3.0

1.1.2.2 from..import..

语法

from 模块名 import 功能1, 功能2, 功能3...

体验

from math import sqrt
print(sqrt(9))

1.1.2.3 from .. import *

语法

from 模块名 import *

体验

from math import *
print(sqrt(9))

1.1.2.4 as定义别名

语法

# 模块定义别名
import 模块名 as 别名

# 功能定义别名
from 模块名 import 功能 as 别名

体验

# 模块别名
import time as tt

tt.sleep(2)
print('hello')

# 功能别名
from time import sleep as sl
sl(2)
print('hello')

1.2 制作模块

在Python中，每个Python文件都可以作为一个模块，模块的名字就是文件的名字。也就是说自定义模块名必须要符合标识符命名规则。

1.2.1 定义模块

新建一个Python文件，命名为 my_module1.py ，并定义 testA 函数。

def testA(a, b):
    print(a + b)

1.2.2 测试模块

在实际开发中，当一个开发人员编写完一个模块后，为了让模块能够在项目中达到想要的效果，这个开发人员会自行在py文件中添加一些测试信息。例如，在 my_module1.py 文件中添加测试代码。

def testA(a, b):
    print(a + b)

testA(1, 1)

此时，无论是当前文件，还是其他已经导入了该模块的文件，在运行的时候都会自动执行 testA 函数的调用。

解决办法如下：

def testA(a, b):
    print(a + b)

# 只在当前⽂件中调⽤该函数，其他导⼊的⽂件内不符合该条件，则不执⾏testA函数调⽤
if __name__ == '__main__':
    testA(1, 1)

1.2.3 调用模块

import my_module1
my_module1.testA(1, 1)

1.2.4 注意事项

如果使用 from .. import .. 或 from .. import * 导入多个模块的时候，且模块内有同名功能。当调用这个同名功能的时候，调用到的是后面导入的模块的功能。

体验

# 模块1代码
def my_test(a, b):
    print(a + b)

# 模块2代码
def my_test(a, b):
    print(a - b)

# 导⼊模块和调⽤功能代码
from my_module1 import my_test
from my_module2 import my_test

# my_test函数是模块2中的函数
my_test(1, 1)

1.3 模块定位顺序

当导入一个模块，Python解析器对模块位置的搜索顺序是：

1. 当前目录
2. 如果不在当前目录，Python则搜索在shell环境变量PYTHONPATH下的每个目录。
3. 如果都找不到，Python会察看默认路径。UNIX下，默认路径一般为/usr/local/lib/python/模块搜索路径存储在system模块的sys.path变量中。变量里包含当前目录，PYTHONPATH和由安装过程决定的默认目录。

注意

• 自己的文件名不要和已有模块名重复，否则导致模块功能无法使用
• 使用 from 模块名 import 功能 的时候，如果功能名字重复，调用到的是最后定义或导入的功能。

1.4 __all__

如果一个模块文件中有 __all__ 变量，当使用 from xxx import * 导入时，只能导入这个列表中的元素。

my_module1模块代码

__all__ = ['testA']

def testA():
    print('testA')

def testB():
    print('testB')

导入模块的文件代码

from my_module1 import *
testA()
testB()

二. 包

包将有联系的模块组织在一起，即放到同一个文件夹下，并且在这个文件夹创建一个名字为 __init__.py 文件，那么这个文件夹就称之为包。

需要在py脚本所在的文件夹下添加一个__init__.py文件，只有这样，该文件夹才会成为一个package包，否则不能被其他模块导入调用，只有包才可以被其他模块导入调用。

2.1 制作包

[New] — [Python Package] — 输入包名 — [OK] — 新建功能模块(有联系的模块)。

注意：新建包后，包内部会自动创建 __init__.py 文件，这个文件控制着包的导入行为。

2.1.1 快速体验

1. 新建包 mypackage
2. 新建包内模块： my_module1 和 my_module2
3. 模块内代码如下

# my_module1
print(1)

def info_print1():
    print('my_module1')

# my_module2
print(2)

def info_print2():
    print('my_module2')

2.2 导入包

2.2.1 方法一

import 包名.模块名
包名.模块名.目标

2.2.1.1 体验

import my_package.my_module1
my_package.my_module1.info_print1()

2.2.2 方法二

注意：必须在 __init__.py 文件中添加 __all__ = [] ，控制允许导入的模块列表。

from 包名 import *
模块名.目标

2.2.2.1 体验

from my_package import *
my_module1.info_print1()

import导入不同目录下的模块

假设有如下目录结构：

-- dir0
　　| file1.py
　　| file2.py
　　| dir3
　　　| file3.py
　　| dir4
　　　| file4.py

dir0文件夹下有file1.py、file2.py两个文件和dir3、dir4两个子文件夹，dir3中有file3.py文件，dir4中有file4.py文件。

1.导入同级模块

python导入同级模块（在同一个文件夹中的py文件）直接导入即可。

import xxx

如在file1.py中想导入file2.py，注意无需加后缀".py"：

import file2
# 使用file2中函数时需加上前缀"file2."，即：
# file2.fuction_name()

2.导入下级模块

导入下级目录模块也很容易，需在下级目录中新建一个空白的__init__.py文件再导入：

from dirname import xxx

如在file1.py中想导入dir3下的file3.py，首先要在dir3中新建一个空白的__init__.py文件。

-- dir0
　　| file1.py
　　| file2.py
　　| dir3
　　　| __init__.py
　　　| file3.py
　　| dir4
　　　| file4.py

再使用如下语句：

# plan A
from dir3 import file3

或是

# plan B
import dir3.file3
# import dir3.file3 as df3

但使用第二种方式则下文需要一直带着路径dir3书写，较为累赘，建议可以另起一个别名。

3.导入上级模块

要导入上级目录下模块，可以使用sys.path：

import sys
sys.path.append("..")
import xxx　

如在file4.py中想引入import上级目录下的file1.py：

import sys
sys.path.append("..")
import file1

sys.path的作用：当使用import语句导入模块时，解释器会搜索当前模块所在目录以及sys.path指定的路径去找需要import的模块，所以这里是直接把上级目录加到了sys.path里。

“..”的含义：等同于linux里的‘..’，表示当前工作目录的上级目录。实际上python中的‘.’也和linux中一致，表示当前目录。

---

使用绝对路径：

import os
import sys
src_folder = os.path.dirname(os.path.abspath(__file__)）
sys.path.append(src_folder.parent + "/tools")

4.导入隔壁文件夹下的模块

如在file4.py中想引入import在dir3目录下的file3.py。

这其实是前面两个操作的组合，其思路本质上是将上级目录加到sys.path里，再按照对下级目录模块的方式导入。

同样需要被引文件夹也就是dir3下有空的__init__.py文件。

-- dir
　　| file1.py
　　| file2.py
　　| dir3
　　　| __init__.py
　　　| file3.py
　　| dir4
　　　| file4.py

同时也要将上级目录加到sys.path里：

import sys
sys.path.append("..")
from dir3 import file3

5.常见错误及import原理：

在使用直接从上级目录引入模块的操作时：

from .. import xxx

经常会报错:

ValueError: attempted relative import beyond top-level package

这是由于相对导入时，文件夹实质上充当的是package，也就是包的角色（比如我们常用的numpy、pandas都是包）。如果python解释器没有认同该文件夹是package，那么这就是一个普通的文件夹，无法实现相对导入。

文件夹作为package需要满足如下两个条件：

1. 文件夹中必须存在有__init__.py文件，可以为空。
2. 不能作为顶层模块来执行该文件夹中的py文件。

实例

导入全局变量

https://www.cnblogs.com/AcAc-t/p/python_global_import_rule.html