Skip to content

settings 模块导入最佳实践

复制本地路径 | 在线编辑

问题描述

场景

captureThread0.py 文件位于 src/tools/capture/ 目录下，需要使用 settings.py（位于 src/tools/ 目录）中的多个变量。比如：

# 使用：直接访问 settings 中的变量
img.reshape(settings.full_cols, settings.full_rows)

面临的困惑

  1. 是否要一个个导入？

    # 这样会不会太麻烦？
from ..settings import full_cols, full_rows, full_offsetx, full_offsety, ...

  2. 如果以后要用新变量怎么办？

  3. 每次都要回来修改导入语句？

  4. 会不会容易遗漏？

  5. 有没有更优雅的方式？

  6. 能否一行导入就搞定？
  7. 如何平衡代码简洁性和清晰性？

问题核心

如何在包结构中使用相对导入，优雅地访问 settings 模块中的多个变量？

方案对比

方案 1：导入整个模块（推荐）⭐

from .. import settings

# 使用：直接访问 settings 中的变量
img.reshape(settings.full_cols, settings.full_rows)
config_path = settings.CONFIGS_DIR / 'LDP_AP.txt'

优点：

  • ✅ 简单：只需要一行导入
  • ✅ 清晰：代码中明确知道变量来自 settings
  • ✅ 不污染命名空间：不会引入大量变量到当前作用域
  • ✅ 易于维护：如果 settings 添加新变量，不需要修改导入
  • ✅ 符合最佳实践：Python 官方推荐的方式

缺点：

  • ⚠️ 需要写 settings. 前缀（但这其实是优点，因为更清晰）

方案 2：导入特定变量

from ..settings import full_cols, full_rows, full_offsetx, full_offsety, full_reversex, full_reversey

# 使用：直接使用变量名（不需要前缀）
img.reshape(full_cols, full_rows)
offset = (full_offsetx, full_offsety)

优点：

  • ✅ 使用时不需前缀，代码更简洁

缺点：

  • ❌ 麻烦：需要列出所有要用的变量
  • ❌ 容易遗漏：如果要用新变量，需要修改导入
  • ❌ 污染命名空间：引入大量变量
  • ❌ 不够清晰：不知道变量来自哪里

方案 3：导入所有变量（不推荐）❌

from ..settings import *

优点：

  • ✅ 最简单

缺点：

  • ❌ 非常不推荐：污染命名空间
  • ❌ 不清晰：不知道变量来自哪里
  • ❌ 容易冲突：如果变量名冲突，难以调试
  • ❌ 不符合最佳实践：Python 官方不推荐

推荐方案：导入整个模块

为什么推荐方案 1？

  1. Python 官方推荐
  2. PEP 8 明确推荐导入模块而不是导入所有变量

  3. 这是 Python 社区的标准做法

  4. 代码更清晰

    # 清晰：知道变量来自 settings
img.reshape(settings.full_cols, settings.full_rows)

# 不清晰：不知道变量来自哪里
img.reshape(full_cols, full_rows)  # full_cols 从哪里来？

  5. 易于维护

  6. 如果 settings 添加新变量，不需要修改导入语句

  7. 如果多个文件都用 settings，保持一致的导入方式

  8. 避免命名冲突

  9. 不会污染当前命名空间
  10. 如果当前文件也有 full_cols 变量，不会冲突

结论

不需要一个个导入变量！ 导入整个模块是最佳实践，既简单又清晰。

Comments