Python中实现WORKING_PATH可CLI自定义且兼容原有config访问语法的方案

实现思路 #

不用大改现有代码，不需要修改所有配置访问语句，不需要给属性加函数括号，也不用到处传递config对象，就能实现CLI自定义WORKING_PATH、动态更新所有派生路径的效果。
核心是利用Python3.7+支持的模块级__getattr__能力，把原本硬编码固化的派生路径，改成访问属性时才动态计算值的逻辑，计算时永远读取当前模块下最新的WORKING_PATH，不会提前锁死默认路径的结果。

具体改造步骤 #

1. 重写config.py的基础结构：

   from pathlib import Path
   
   # 原有静态常量完全不需要改动
   size = 160
   order = 4
   
   # WORKING_PATH 先设置为默认值，后续CLI传参时直接覆盖即可
   WORKING_PATH = Path(__file__).resolve().parent
   
   # 把所有依赖WORKING_PATH的派生路径 统一登记到映射表里
   _PATH_MAPPING = {
       "experiment_dir": "data/experiment",
       # 其他类似的派生路径，都按 访问名: 相对路径 的格式加进来
   }
   
   # 模块级属性拦截，只在第一次访问对应路径时触发计算
   def __getattr__(attr_name):
       if attr_name in _PATH_MAPPING:
           current_value = WORKING_PATH / _PATH_MAPPING[attr_name]
           # 计算完成后把结果存到模块字典里，后续访问直接读缓存，没有性能损耗
           globals()[attr_name] = current_value
           return current_value
       raise AttributeError(f"config模块未定义属性 {attr_name}")
   

2. 主脚本里的CLI逻辑只需要加两行代码：

   import argparse
   from pathlib import Path
   import config
   
   # 原有CLI参数解析逻辑
   parser = argparse.ArgumentParser()
   parser.add_argument("--working-path", type=Path, default=None)
   args = parser.parse_args()
   
   # 解析完参数后直接覆盖config模块里的WORKING_PATH，不需要global声明
   if args.working_path:
       config.WORKING_PATH = args.working_path.resolve()
   

方案优势 #

• 完全兼容原有访问语法：所有之前写的config.experiment_dir、config.size、config.order语句不需要任何修改，不需要加括号，访问形式完全统一
• 路径永远跟着最新的WORKING_PATH走：CLI传入自定义路径覆盖WORKING_PATH后，后续所有访问派生路径的地方，都会基于新的路径值计算，不会残留默认路径下的旧结果
• 全局可访问性和原模块配置完全一致：不需要把config当参数到处传，所有导入config的地方都能读到最新的配置值
• 性能没有额外损耗：第一次访问到派生路径完成计算后，值会被缓存到模块全局字典里，后续访问的速度和原来硬编码常量没有区别

其他可选方案的对比 #

• 不推荐把所有派生路径改成无参函数：需要批量修改现有所有访问语句加括号，还会出现部分配置是变量、部分是函数的语法不统一问题，改动量大且体验差
• 不推荐封装成静态配置类：实现逻辑和模块级方案效果完全一致，但需要额外写类属性、装饰器的代码，改动量远大于上面的模块级方案，没有额外收益
• 不推荐在主函数里用global声明修改WORKING_PATH：global只能修改当前文件内的变量作用域，跨文件导入的config模块根本感知不到主函数里的变量修改，改完其他位置访问到的还是原来的默认路径值

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