Python中如何关联多个代码文件 解决长代码调试维护难题

Python中通过模块导入机制关联多个代码文件，你可以按功能、业务维度拆分不同.py文件或目录，需要时导入对应模块的功能即可，具体操作如下：

1. 基础拆分规则 #

拆分时遵循单一职责原则即可，避免不同逻辑混写：

• 按通用功能拆分：工具类函数放utils.py、数据处理逻辑放data_process.py、数据库操作单独放db.py、交互逻辑放ui.py
• 按业务模块拆分：如果是业务类项目，可以把用户相关逻辑放user/目录、订单相关放order/目录
• 单文件代码行数建议控制在1000行以内，单个函数代码行数建议控制在50行以内，降低维护成本

2. 同目录下的多文件调用方法 #

假设你的项目目录结构如下：

my_project/
├── main.py  # 主启动文件
├── utils.py # 工具函数文件
└── data_process.py # 数据处理文件

其中utils.py的内容为：

def calculate_average(num_list):
    return sum(num_list) / len(num_list) if num_list else 0

你可以在main.py中通过三种方式调用该函数：

导入整个模块 #

import utils

avg = utils.calculate_average([1,2,3,4,5])
print(avg)

导入模块的指定功能 #

from utils import calculate_average

avg = calculate_average([1,2,3,4,5])
print(avg)

导入模块并设置别名（避免命名冲突） #

import utils as u

avg = u.calculate_average([1,2,3,4,5])
print(avg)

3. 多层目录的多文件调用方法 #

如果项目规模更大，需要拆分多层目录，结构示例如下：

my_project/
├── main.py
├── utils/
│   ├── __init__.py # 标记当前目录为Python包，空文件即可，新手建议所有子目录都添加该文件避免导入报错
│   ├── math_tools.py
│   └── string_tools.py
└── business/
    ├── __init__.py
    ├── user.py
    └── order.py

要调用utils/math_tools.py里的函数，在main.py中写法如下：

from utils.math_tools import calculate_average

avg = calculate_average([1,2,3,4,5])

如果是同目录下的文件互相调用，比如business/user.py要调用business/order.py里的函数，可以选择两种导入方式：

# 绝对导入（推荐，不会出现路径歧义）
from business.order import get_user_order_list
# 相对导入
from .order import get_user_order_list

如果想简化导入路径，可以在对应包的__init__.py里提前导入需要对外暴露的功能：

# utils/__init__.py 内容
from .math_tools import calculate_average
from .string_tools import check_phone_format

之后就可以直接从utils包导入对应功能：

from utils import calculate_average, check_phone_format

4. 常见踩坑提醒 #

• 不要出现循环导入：如果A文件导入B，B文件又导入A会直接报错，遇到这种情况可以把两方依赖的公共逻辑抽离到第三个文件解决
• 自定义文件/目录不要和Python内置模块重名，比如不要命名为json.py、math.py，否则会覆盖官方内置模块导致报错
• 运行主文件时直接在项目根目录执行python main.py即可，不要进入子目录运行主文件，避免出现模块找不到的报错

内容的提问来源于stack exchange，提问作者JayLight04