Python项目动态调用目录下多文件中create_chart()函数的规范实现

项目结构 #

- my-project/
  - my_project/
    - __init__.py
    - modules_charts/
      - chart_a.py
      - chart_b.py
      - ...
    - main.py
  - poetry.lock
  - pyproject.toml
  - README.md

需求概述 #

让modules_charts文件夹可动态存放任意命名的Python文件（每个文件需包含create_chart()函数），在main.py中调用所有这些函数，且新增文件时无需修改main.py。

原代码的问题 #

你当前的实现存在两个核心问题：

1. 路径依赖运行目录：用os.listdir("modules_charts")读取目录时，路径是相对当前工作目录的。如果在my-project目录下执行python my_project/main.py，程序会在my-project下找modules_charts，而实际该目录在my_project子文件夹中，导致找不到文件。
2. 实现不够规范：没有利用Python的包导入机制，存在更简洁、符合规范的实现方式。

解决方案 #

方案一：直接在main.py中遍历包模块（无需修改__init__.py） #

通过pkgutil遍历包内的所有模块，结合importlib导入，完全不依赖运行目录：

# main.py
import importlib
import pkgutil
from my_project.modules_charts import __path__ as charts_package_path

# 遍历modules_charts包下的所有非包模块
for finder, module_name, is_package in pkgutil.iter_modules(charts_package_path):
    if is_package:
        continue  # 跳过子文件夹
    # 导入模块
    module = importlib.import_module(f"my_project.modules_charts.{module_name}")
    # 调用create_chart函数（做存在性检查避免报错）
    if hasattr(module, "create_chart"):
        module.create_chart()

方案二：利用__init__.py统一导出（更简洁规范） #

在modules_charts/__init__.py中自动收集所有create_chart函数，让main.py可以直接导入使用：

1. 修改modules_charts/__init__.py：

import importlib
import pkgutil

# 用于存储所有create_chart函数的列表
chart_functions = []

# 遍历当前包下的所有模块
for finder, module_name, is_package in pkgutil.iter_modules(__path__):
    if is_package:
        continue
    # 导入子模块
    module = importlib.import_module(f".{module_name}", package=__name__)
    # 如果模块有create_chart函数，就加入列表
    if hasattr(module, "create_chart"):
        chart_functions.append(module.create_chart)

2. 简化main.py的代码：

# main.py
from my_project.modules_charts import chart_functions

# 调用所有收集到的create_chart函数
for create_chart in chart_functions:
    create_chart()

运行方式 #

不管是用以下哪种方式运行，都能正常工作：

• 在my-project目录下执行：python -m my_project.main
• 在my-project目录下执行：python my_project/main.py
• 任意目录下执行绝对路径的main.py

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