Python命名规范

以下内容来自DeepSeek

1. 核心原则

“读代码像读诗”——命名应清晰、一致、自解释。

2. 各大命名风格

类型 风格 示例
变量 / 函数 小写 + 下划线 user_name, get_data()
类 / 异常 大驼峰 UserProfile, ValidationError
常量 全大写 + 下划线 MAX_RETRY, DEFAULT_TIMEOUT
私有成员 单下划线前缀 _internal_state
“魔术”方法 双下划线包裹 init, str

3. 实用指南

✅ 推荐做法

· 布尔值：用 is_、has_ 前缀，如 is_active、has_permission。
· 避免单字母：除了循环中的 i、j，或上下文明确的 x、y。
· 使用复数：列表、元组等容器类型用复数，如 users、items。

❌ 避免事项

· 与内置名称重名（如 list、dict）。
· 使用拼音或无意义缩写。
· 风格混用（如 userName 与 user_name 混用）。

4. 代码示例

# 常量
MAX_CONNECTIONS = 100

class DatabaseClient:  # 类：大驼峰
    def __init__(self, host: str):
        self._host = host  # 私有：单下划线

    def connect(self) -> bool:  # 方法：小写+下划线
        timeout = MAX_CONNECTIONS  # 局部变量
        return True

5. 团队协作建议

规范的生命力在于统一。建议在项目根目录放置 .pylintrc 或使用 black、ruff 等工具自动格式化，减少人工纠结。

原则：实用优先，让代码更容易被他人（包括未来的自己）理解。