Day30 模块和库的导入
目录
一、导入官方库的三种手段
1.1 标准导入:导入整个库
1.2 从库中导入特定项
1.3 非标准导入:导入整个库
二、导入自定义库/模块的方式
模块、包的定义
使用案例
场景1: main.py 和 circle.py 都在同一目录
场景2: main.py 和 circle.py 都在根目录的子目录 model/ 下
场景3: main.py 在根目录,circle.py 在子目录 model/ 下
场景4:main.py在model/下,circle.py在utils/下
问题原因:执行环境与导入路径冲突
解决方案
1. 使用 -m 模式运行(推荐)
2. 修改 sys.path
3. 使用绝对导入并确保项目根目录在 PYTHONPATH 中
最佳实践建议
三、导入库/模块的核心逻辑:找到根目录(python解释器的目录和终端的目录不一致)
一、导入官方库的三种手段
复盘下学习python的逻辑,所谓学习python就是学习python常见的基础语法+学习要处理的任务所需要用到的第三方库
类别 | 典型库 | 解决的问题 | 学习门槛 |
---|---|---|---|
基础工具 | os 、sys 、json | 操作系统交互、序列化数据(如读写 JSON 文件) | 低 |
科学计算 | numpy 、scipy | 数值计算、线性代数、信号处理 | 中 |
数据分析 | pandas 、matplotlib | 数据清洗、转换、可视化(如绘制折线图、柱状图) | 中 |
Web 开发 | Django 、Flask | 快速搭建 Web 应用(如网站后台、API 接口) | 中高 |
机器学习 | scikit-learn 、TensorFlow | 机器学习算法(分类、回归、深度学习) | 高 |
自动化脚本 | pyautogui 、pytest | 自动化测试、桌面操作自动化(如模拟鼠标键盘操作) | 低 |
网络爬虫 | requests 、Scrapy | 从网页提取数据(需注意反爬机制和法律合规) | 中 |
所以用到什么学什么库即可。
1.1 标准导入:导入整个库
这是最基本也是最常见的导入方式,直接使用import
语句。
1.2 从库中导入特定项
当使用from语法从库中导入特定的函数或类时,这些函数或类就可以在代码中直接使用,不需要添加模块名作为前缀。因为在导入时没有包括模块的完整路径,前面也不能加上库名。
类似的写法,如sklearn库很大,直接导入sklearn库会占用电脑大量内存,所以一般只导入需要的库,
- 如: from sklearn.model_selection import train_test_split
1.3 非标准导入:导入整个库
这将导入math
模块中定义的所有公开函数和变量。 和上述from同理,直接调用sin()
、cos()
等,而无需math.
前缀。
虽然 import math和 from math import *看起来都是导入了 math
模块,但它们在导入方式、作用域处理以及对命名空间的影响上有重要的区别。
(1)命名空间的污染
import math
:这种方法会将整个 math
模块导入到命名空间中,但是需要使用 math.
前缀来访问模块内的函数或变量。这种方式保持了命名空间的整洁,因为所有的 math
函数和变量都包含在 math
这个模块对象中。
from math import *
:这种方法将 math
模块中的所有公开的函数和变量导入到当前的命名空间中,可以直接使用这些函数和变量而无需 math.
前缀。这种方式可能会导致命名空间污染,特别是当有多个模块都被这样导入时,很容易发生命名冲突。
(2)明确性和可维护性
import math
:明确指出了函数和变量来源于 math
模块,这对代码的可读性和维护性都是有益的。其他阅读你代码的人可以清楚地看到每个函数的来源,这对大型项目和团队合作尤为重要。
from math import *
:虽然代码看起来更简洁,但这种方法减少了代码的明确性。如果没有足够的上下文,很难判断一个特定的函数是来自 math
模块还是其他模块,尤其是当你导入了多个模块时
上述这些,如果是python内置库,可以直接导入,大部分第三方库都需要先用pip来安装。下面的模块,也就是.py文件,是不需要安装即可调用的。
二、导入自定义库/模块的方式
模块、包的定义
模块(Module)
- 本质:以
.py
结尾的单个文件,包含Python代码(函数、类、变量等)。 - 作用:将代码拆分到不同文件中,避免代码冗余,方便复用和维护。
包(Package)
在python里,包就是库
- 本质:有层次的文件目录结构(即文件夹),用于组织多个模块和子包。
- 核心特征:包的根目录下必须包含一个
__init__.py
文件(可以为空),用于标识该目录是一个包。
使用案例
若编写一个计算圆面积的代码并保存为 circle.py
,这个文件就是一个模块。
使用时通过 import circle
导入模块,调用其中的函数(如 circle.calculate_area(5)
)。
# circle.py
import mathdef calculate_area(radius):return math.pi * radius ** 2
场景1: main.py
和 circle.py
都在同一目录
目录结构:
项目根目录/ ├── main.py └── circle.py
main.py
内容:
# main.py
from circle import calculate_arearadius = 5
area = calculate_area(radius)
print(f"半径为 {radius} 的圆,面积是: {area}")# 或者注释上面的,用下面的方法
# import circle
# radius = 5
# area = circle.calculate_area(radius)
# print(f"半径为 {radius} 的圆,面积是: {area}")
cd xxx(main的相对路径),然后执行python main.py
终端可以通过左上角的查看-终端 打开,默认的路径是项目根目录。
场景2: main.py
和 circle.py
都在根目录的子目录 model/
下
目录结构:
项目根目录/
└── model/
├── __init__.py (推荐添加,将 model 目录标记为包)
├── main.py
└── circle.py
model/main.py
内容同上:
运行命令:python xxx/main.py
场景3: main.py
在根目录,circle.py
在子目录 model/
下
目录结构:
项目根目录/ ├── main.py └── model/├── __init__.py (必需添加,将 model 目录标记为一个可导入的包)└── circle.py
main.py
内容:
# main.py
from model.circle import calculate_arearadius = 5
area = calculate_area(radius)
print(f"半径为 {radius} 的圆,面积是: {area}")# 或者注释上面的,用下面的方法
# import circle
# radius = 5
# area = circle.calculate_area(radius)
# print(f"半径为 {radius} 的圆,面积是: {area}")
__init__.py的添加问题:Python 3.3 及以后版本,做了 “命名空间包” 相关优化,有些场景下目录里没有 __init__.py
,也能以简单命名空间包形式被导入(主要用于处理跨目录分布的包结构)。但常规的、希望清晰组织模块的包,还是建议显式添加 __init__.py
,明确包的边界和初始化逻辑,避免因解释器版本、环境差异出现导入问题。
场景4:main.py在model/下,circle.py在utils/下
项目根目录/ ├── circle2.py └── utils/├── __init__.py (必需添加,将 model 目录标记为一个可导入的包)└── circle.py └── model/└── main.py
main.py:
# main.py
from utils import circle # 这是根目录绝对路径的导入方式radius = 5
area = circle.calculate_area(radius)
print(f"半径为 {radius} 的圆,面积是: {area}")
circle.py和circle2.py内容相同:
# circle.py
import mathdef calculate_area(radius):return math.pi * radius ** 2
运行方式 python -m model.main
如果直接使用python model/main.py,会报错:
是因为 Python 的导入机制要求 相对导入必须在包环境中使用,而直接执行脚本会破坏包的结构。通过 -m
模式、修改 sys.path
或配置 PYTHONPATH
可以解决这个问题。当使用 python -m model.main 时,Python 会将当前目录(即项目根目录)添加到 sys.path 的开头。
问题原因:执行环境与导入路径冲突
1、Python 的模块搜索路径(sys.path
):
当你执行 python model/main.py
时,Python将 当前目录(即脚本所在的父目录) 添加到 sys.path
的首位。例如:
project/
├── model/
│ ├── __init__.py
│ ├── main.py
│ └── circle.py
└── app.py
此时,Python 会将 project/
加入 sys.path
,但不会将 model/
目录本身加入。
如果你在 main.py
中使用 相对导入(例如 from .circle import Circle
),Python 会报错,因为:
a、相对导入(from .module import ...
)要求当前文件必须作为包的一部分被导入(即通过 python -m model.main
)。
b、直接运行 main.py
时,它被视为 顶层脚本,而非包的一部分,.
路径无效。
2、相对导入与绝对导入的区别:
相对导入(from .circle import Circle
)依赖于当前模块在包中的位置,只能在包内部使用。
绝对导入(from model.circle import Circle
)依赖于 sys.path
中的路径,要求 model
必须在 sys.path
中。但直接运行 main.py
时,model
不在 sys.path
中,因此绝对导入也会失败。
解决方案
1. 使用 -m
模式运行(推荐)
通过 python -m model.main
执行,Python 会将 model
所在的父目录(如 project/
)加入 sys.path
,并将 model
视为包:
# 在 project/ 目录下执行
python -m model.main
2. 修改 sys.path
在 main1.py
开头手动添加父目录到 sys.path
:
main1.py内容:
import sys
import os# 获取当前脚本的父目录(即 model/ 的路径)
current_dir = os.path.dirname(os.path.abspath(__file__))
# 获取父目录的父目录(即 project/ 的路径)
parent_dir = os.path.dirname(current_dir)
# 将父目录添加到 sys.path
sys.path.append(parent_dir)# 现在可以使用绝对导入
from utils import circle # 这是根目录绝对路径的导入方式radius = 5
area = circle.calculate_area(radius)
print(f"半径为 {radius} 的圆,面积是: {area}")
3. 使用绝对导入并确保项目根目录在 PYTHONPATH
中
在环境变量中添加项目根目录:
# Linux/macOS
export PYTHONPATH="${PYTHONPATH}:/path/to/project"# Windows
set PYTHONPATH=%PYTHONPATH%;C:\path\to\project
然后在 main.py
中使用绝对导入:
from model.circle import Circle
最佳实践建议
- 统一使用
-m
模式:开发时始终通过python -m package.module
运行脚本,避免直接执行包内模块。 - 明确
__init__.py
的作用:- 在包的
__init__.py
中可以预导入常用模块,简化外部引用(例如from .circle import Circle
)。 - 空的
__init__.py
仅用于标记包,但添加预导入可以让包的 API 更清晰。
- 在包的
- 使用相对导入:在包内部模块间引用时,优先使用相对导入(
from . import module
),避免硬编码包名。
三、导入库/模块的核心逻辑:找到根目录(python解释器的目录和终端的目录不一致)
IDE(如 VSCode 或 PyCharm)通常会将你打开的项目文件夹设为“根目录”(或者说,运行时的工作目录)。Python 在导入模块时,会从这个根目录(以及其他一些标准位置和脚本所在的目录)开始查找。
@浙大疏锦行