Python中导入模块时自动执行function并生成配置文件的可行性及入门指引咨询

当然可行！这在Python里是很常见的做法，核心就是利用模块导入时会自动执行顶层代码的特性来实现。我们只需要在模块中加入「检查配置文件是否存在→不存在则生成含默认参数的配置文件」的逻辑，就能达成你要的效果。

我会用几种常用的配置文件格式演示，你可以根据需求选择：

1. JSON格式（Python自带，无需额外依赖） #

JSON是最基础的选择，不需要安装第三方库，适合简单的参数结构。

创建一个名为model_module.py的模块：

import json
import os

# 获取模块所在目录，确保配置文件路径稳定不受工作目录影响
MODULE_DIR = os.path.dirname(os.path.abspath(__file__))
CONFIG_FILE = os.path.join(MODULE_DIR, "model_params.json")

# 定义模型的默认参数
DEFAULT_PARAMS = {
    "learning_rate": 0.001,
    "batch_size": 32,
    "hidden_layers": [64, 32],
    "dropout": 0.2,
    "epochs": 50
}

# 自动创建配置文件的内部函数
def _init_config():
    if not os.path.exists(CONFIG_FILE):
        # 将默认参数写入配置文件
        with open(CONFIG_FILE, "w", encoding="utf-8") as f:
            json.dump(DEFAULT_PARAMS, f, indent=4)
        print(f"默认配置文件已生成：{CONFIG_FILE}")
    else:
        print(f"配置文件已存在，跳过创建")

# 模块导入时自动执行初始化逻辑
_init_config()

# 供外部调用的配置读取函数
def load_config():
    if os.path.exists(CONFIG_FILE):
        with open(CONFIG_FILE, "r", encoding="utf-8") as f:
            return json.load(f)
    # 兜底返回默认参数
    return DEFAULT_PARAMS.copy()

使用时，在其他脚本中导入模块即可自动触发配置文件创建：

import model_module

# 加载配置并初始化模型
config = model_module.load_config()
my_model = MyModel(learning_rate=config["learning_rate"], batch_size=config["batch_size"])

2. YAML格式（可读性更强，支持注释） #

YAML比JSON更适合复杂参数结构，还能添加注释提升可维护性，但需要先安装依赖：pip install pyyaml

修改后的model_module.py：

import yaml
import os

MODULE_DIR = os.path.dirname(os.path.abspath(__file__))
CONFIG_FILE = os.path.join(MODULE_DIR, "model_params.yaml")

DEFAULT_PARAMS = {
    "learning_rate": 0.001,
    "batch_size": 32,
    "hidden_layers": [64, 32],
    "dropout": 0.2,
    "epochs": 50,
    # YAML支持注释，方便后续维护
    "optimizer": "adam"  # 选择Adam优化器
}

def _init_config():
    if not os.path.exists(CONFIG_FILE):
        with open(CONFIG_FILE, "w", encoding="utf-8") as f:
            # sort_keys=False 保持参数顺序与定义一致
            yaml.dump(DEFAULT_PARAMS, f, sort_keys=False)
        print(f"默认配置文件已生成：{CONFIG_FILE}")
    else:
        print(f"配置文件已存在，跳过创建")

_init_config()

def load_config():
    if os.path.exists(CONFIG_FILE):
        with open(CONFIG_FILE, "r", encoding="utf-8") as f:
            # safe_load避免潜在的安全风险
            return yaml.safe_load(f)
    return DEFAULT_PARAMS.copy()

3. 用dataclass优化参数管理（更结构化） #

如果参数较多，用字典访问不够直观，可以用Python内置的dataclasses定义结构化参数，让代码更清晰：

from dataclasses import dataclass, asdict
import json
import os

@dataclass
class ModelConfig:
    learning_rate: float = 0.001
    batch_size: int = 32
    hidden_layers: list = None
    dropout: float = 0.2
    epochs: int = 50

    def __post_init__(self):
        # 处理列表类型的默认值，避免可变默认值的陷阱
        if self.hidden_layers is None:
            self.hidden_layers = [64, 32]

MODULE_DIR = os.path.dirname(os.path.abspath(__file__))
CONFIG_FILE = os.path.join(MODULE_DIR, "model_params.json")

def _init_config():
    if not os.path.exists(CONFIG_FILE):
        default_config = ModelConfig()
        with open(CONFIG_FILE, "w", encoding="utf-8") as f:
            json.dump(asdict(default_config), f, indent=4)
        print(f"默认配置文件已生成：{CONFIG_FILE}")
    else:
        print(f"配置文件已存在，跳过创建")

_init_config()

def load_config():
    if os.path.exists(CONFIG_FILE):
        with open(CONFIG_FILE, "r", encoding="utf-8") as f:
            config_dict = json.load(f)
        return ModelConfig(**config_dict)
    return ModelConfig()

使用时可以直接访问属性，比字典更方便：

config = model_module.load_config()
my_model = MyModel(learning_rate=config.learning_rate, batch_size=config.batch_size)

• 禁止覆盖用户配置：一定要先检查文件是否存在，只在不存在时创建——不然用户修改后的配置会被每次导入重置，这是非常糟糕的体验。
• 配置文件路径选择：用__file__获取模块所在目录，确保路径不受当前工作目录影响；如果模块是系统级安装的，可能没有写入权限，这时可以考虑把配置文件放在用户目录（比如os.path.expanduser("~/.my_model_config.json")）。
• 保持导入逻辑轻量化：模块导入时的代码要尽量快速，创建配置文件是轻量操作没问题，但别在这里加入模型训练之类的重逻辑。

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