Python之模块

我的图片 · 在线免费的图片处理工具

前言

简单记录一下Python中的模块相关知识,记录于此,方便自己查阅和学习。

正文

为什么需要模块?

先看一个没有模块的世界:

project/
└── all_in_one.py    # 3000 行代码,函数、类、配置全混在一起

问题:

  • 找一个函数要翻半天
  • 改一处怕影响别的地方
  • 想复用一段代码,只能复制粘贴
  • 多人协作时疯狂冲突

有了模块之后:

project/
├── main.py          # 入口文件
├── config.py        # 配置相关
├── utils.py         # 工具函数
├── models.py        # 数据模型
└── auth.py          # 认证逻辑

模块就是一个 .py 文件,里面装着函数、类、变量。它让你可以把代码拆成多个文件,各管各的,互不干扰。

什么是模块

模块就是一个 .py 文件 ,也是一个独立的功能单元。

#-----------------------utils.py-----------------------
# utils.py(这就是一个模块)

def add(a, b):
    return a + b
def multiply(a, b):
    return a * b
PI = 3.14159

#-----------------------main.py-----------------------
# main.py(另一个文件,使用 utils 模块)

import utils

print(utils.add(3, 5))        # 8
print(utils.multiply(2, 4))   # 8
print(utils.PI)               # 3.14159

utils.py 就是一个模块,文件名 utils 就是模块名。

导入模块的方式

Python 里"导入"这件事,本质上就是:把另一个 .py 文件里的东西拿过来用。 但怎么拿、拿多少、放哪儿,有五种写法,每种的"脾气"都不一样。

import 模块名

就是整箱搬进来,用的时候开箱取。

import math

print(math.sqrt(16))    # 4.0
print(math.pi)          # 3.141592653589793

发生了什么:

import math
    │
    ├── Python 找到 math.py(标准库里的)
    ├── 把整个模块加载到内存
    ├── 在当前文件创建一个名字叫 math 的变量
    └── math 这个变量指向那个模块对象
项目说明
导入了什么模块里的所有东西(函数、类、变量)
怎么用必须加 模块名. 前缀
会不会和自己的变量冲突几乎不会,因为有前缀隔离
适合场景日常开发首选,尤其是模块名短、用得频繁的时候

再举一个更直观的例子:

import random

# random 模块里有很多东西,全在 random 这个"盒子"里
print(random.randint(1, 10))    # 随机整数
print(random.choice(["红", "黄", "蓝"]))  # 随机选一个

因为用模块名,不需要担心名字(变量、函数名或类)冲突。

from 模块名 import 名字

只从箱子里拿出你要的那几件,直接放桌上用。

from math import sqrt, pi

print(sqrt(16))    # 4.0(不用写 math.)
print(pi)          # 3.14159

发生了什么:

from math import sqrt, pi
    │
    ├── Python 加载 math 模块
    ├── 只把 sqrt 和 pi 这两个名字"复制"到当前文件
    └── 直接用,不用加前缀

import 进来的名字是什么,取决于原来那个东西是什么——变量就是变量,函数就是函数,类就是类。import 只是把引用拿过来,不改变任何东西的类型。

项目说明
导入了什么只导入你指定的名字,其他的不导入
怎么用直接用名字
会不会和自己的变量冲突有可能
适合场景只需要模块里的一两个东西,而且名字确定不会冲突

冲突示例:

# 你自己写了一个 sqrt
def sqrt(x):
    return x ** 0.5

from math import sqrt    # ← 把你自己的 sqrt 覆盖了!

print(sqrt(16))    # 到底用的是哪个?

如果不确定会不会冲突,用方式一(import math)更安全。

from 模块名 import *

把箱子里的东西全倒桌上,随手拿。方便但危险,不推荐在正式项目里用。

from math import *

print(sqrt(16))      # 能用
print(sin(3.14))     # 能用
print(cos(0))        # 能用
print(pi)            # 能用
print(e)             # 能用

发生了什么:

from math import *
    │
    ├── Python 加载 math 模块
    ├── 把模块里所有"公开名字"倒进当前文件
    │   (以 _ 开头的默认不倒,除非 __all__ 里指定了)
    └── 全部直接用,不用加前缀

为什么官方不推荐?

# 你以为自己在用自己写的函数
def sum(nums):
    total = 0
    for n in nums:
        total += n
    return total

from builtins import *    # 假设把内置函数全倒进来了
# builtins 里也有一个 sum!

print(sum([1, 2, 3]))    # 到底用的是哪个 sum?调试时一脸懵

什么时候可以用?

场景说明
交互式调试(Python shell / Jupyter)✅ 临时用用,方便
正式项目代码❌ 别用

import 模块名 as 别名

整箱搬进来,但给箱子贴个短标签,方便随时开箱。

import pandas as pd
import numpy as np
import matplotlib.pyplot as plt

# 不用每次写 pandas.read_csv(),写 pd.read_csv() 就行
df = pd.read_csv("data.csv")

发生了什么:

import pandas as pd
    │
    ├── 加载 pandas 模块
    ├── 创建一个叫 pd 的变量指向它
    └── 效果等同于 import pandas,只是名字短了

特点:

项目说明
导入了什么模块的全部内容
怎么用别名.名字
会不会冲突不会
适合场景模块名太长、写起来太啰嗦的时候
import os as system
import sys as runtime

print(system.name)        # posix / nt
print(runtime.version)    # Python 版本信息

或

import datetime as dt

# 不用每次写 datetime.datetime.now()
now = dt.datetime.now()
today = dt.date.today()

print(now)    # 2025-01-15 14:30:00

常见别名约定:

import numpy as np          # 几乎所有人都是 np
import pandas as pd         # 几乎所有人都是 pd
import matplotlib.pyplot as plt   # 几乎所有人都是 plt
import tensorflow as tf     # 几乎所有人都是 tf

这些别名已经是"行业标准"了,看到 np.array() 大家都知道是 NumPy。

from 模块名 import 名字 as 别名

从箱子里拿一件出来,顺便给它换个名字放桌上。

from math import pi as PI
from my_module import add as my_add

print(PI)          # 3.14159
my_add(1, 2)       # 3

发生了什么:

from math import pi as PI
    │
    ├── 加载 math 模块
    ├── 只把 pi 拿出来
    ├── 在当前文件创建一个叫 PI 的变量指向它
    └── 原来的名字 pi 在当前文件里不存在
小结
写法口诀一句话
import 模块名整箱搬,开箱取全拿进来,用 模块名. 访问
from 模块名 import 名字只拿我要的那件只导入指定的,直接用
from 模块名 import *整箱倒桌上全倒进来直接用,方便但危险
import 模块名 as 别名整箱搬,贴短标签全拿进来,用 别名. 访问
from 模块名 import 名字 as 别名拿一件,换个标签只导入指定的,换个名字直接用

反正,推荐优先import 模块名,名字太长或冲突了就换个名字即可。

场景示例
名字太长,想缩短from datetime import timedelta as td
避免和当前文件同名from my_module import add as my_add
名字不好记,想改个好懂的from math import factorial as 阶乘
# 场景:避免冲突
def add(a, b):
    return a + b + 1    # 自己的 add

from my_module import add as module_add    # 换个名字,不冲突

print(add(1, 2))            # 用自己的(结果是 4)
print(module_add(1, 2))     # 用模块里的(结果是 3)

模块搜索路径

当你写 import xxx 时,Python 按什么顺序找这个模块?

1. 当前目录(运行脚本所在的目录)
2. PYTHONPATH 环境变量里的目录
3. Python 标准库目录(内置模块在这里)
4. 第三方库目录(pip 安装的包在这里)

验证一下:

import sys
print(sys.path)    # 打印所有搜索路径

如果 Python 报 ModuleNotFoundError,说明它在以上所有路径里都没找到你的模块。

常见错误

错误原因解决办法
ModuleNotFoundErrorPython 找不到模块检查文件是否在搜索路径中
ImportError: cannot import name模块找到了,但里面没有这个名字检查拼写、检查函数是否在模块里
循环导入A 导入 B,B 又导入 A重构代码,把公共部分抽到第三个文件
导入了但没生效文件名和模块名冲突比如自己建了个 random.py,把标准库的 random 挡住了

模块的优缺点

 优点缺点
代码组织按功能拆文件,结构清晰文件多了需要理解包结构
复用性写一次,到处 import导入路径写错就找不到
命名空间不同模块可以有同名函数调用时要加模块前缀,稍显啰嗦
封装性下划线约定区分公开/内部Python 没有真正的私有,靠自觉
测试方便每个模块可以独立测试—

参考文章

  • AI
  • Python 文档

暂无评论

评论审核已启用。您的评论可能需要一段时间后才能被显示。

none
暂无评论...