类变量和实例变量的命名规范有哪些具体的例子？

你想获取类变量和实例变量命名规范的具体可落地示例，核心遵循 Python PEP 8 规范，两类变量因用途和归属不同，命名风格有明确区分，下面通过「场景分类 + 正面示例 + 反面示例 + 完整代码」的形式详细呈现：

一、通用命名基础（所有变量必遵守，先明确前提）

风格：小写字母 + 下划线分隔（蛇形命名 snake_case），禁止驼峰命名（如 userName）；
语义：见名知意，避免无意义缩写（如 uid 可接受，x1 不推荐）；
禁用：关键字（class/def）、魔法属性格式（__xxx__）、数字开头、特殊字符（-/@）。

二、类变量命名规范 + 具体示例

类变量是类的共享属性，命名需突出「全局、共享、常量、统计」特性，分 3 类场景：

表格

类变量类型	命名规则	正面示例（推荐）	反面示例（避坑）
普通共享类变量	蛇形命名，体现 "共享 / 统计" 语义	`total_users`（总用户数）`default_timeout`（默认超时时间）`class_name`（班级名称）`pass_rate`（考试通过率）`system_version`（系统版本）	`totalUsers`（驼峰命名，不符合 PEP8）`tu`（无意义缩写，可读性差）`123count`（数字开头，语法错误）`class`（关键字，禁用）`TotalCount`（大驼峰，混淆类名风格）
常量类变量	全大写 + 下划线分隔，体现 "不可修改"	`MAX_RETRY = 3`（最大重试次数）`DEFAULT_PORT = 8080`（默认端口）`SPECIES = "人类"`（物种常量）`MAX_SCORE = 100`（满分分值）`ALLOWED_METHODS = ["GET", "POST"]`（允许的请求方法）	`maxRetry = 3`（驼峰 + 小写，无常量标识）`max_score = 3`（全小写，无法区分普通变量）`MaxScore = 3`（混合大小写，不规范）`max-score = 3`（含连字符，语法错误）
私有类变量	单下划线开头 + 蛇形命名（约定私有，外部不建议访问）	`_internal_cache`（内部缓存）`_temp_data`（临时存储数据）`_grade_mapping`（年级映射字典）`_debug_mode`（调试模式标识）	`__internal_cache`（双下划线，触发名称改写，非必要禁用）`_InternalCache`（首字母大写，不符合蛇形）`_internalCache`（驼峰，不规范）`internal_cache`（无下划线，无法标识私有）

完整代码示例（类变量命名）

python

运行

复制代码

class OrderSystem:
    # 1. 常量类变量（全大写）
    MAX_ORDER_ITEMS = 20  # 订单最大商品数量
    DEFAULT_EXPIRE_HOURS = 24  # 订单默认过期小时数
    PAYMENT_TYPES = ["alipay", "wechat_pay"]  # 支持的支付方式
    MIN_ORDER_AMOUNT = 0.01  # 最小订单金额

    # 2. 普通共享类变量（蛇形命名）
    total_orders = 0  # 系统总订单数
    pending_orders = 0  # 待支付订单数
    completed_orders = 0  # 已完成订单数
    platform_name = "电商小铺"  # 平台名称

    # 3. 私有类变量（单下划线开头）
    _order_status_mapping = {0: "待支付", 1: "已支付", 2: "已取消"}  # 订单状态映射表
    _temp_order_cache = {}  # 临时订单缓存
    _is_maintenance = False  # 系统是否在维护中

    def create_order(self):
        # 修改普通共享类变量
        OrderSystem.total_orders += 1
        OrderSystem.pending_orders += 1

三、实例变量命名规范 + 具体示例

实例变量是单个实例的独有属性，命名需突出「个体特征、实例状态」，分 3 类场景：

表格

实例变量类型	命名规则	正面示例（推荐）	反面示例（避坑）
普通实例变量	蛇形命名，体现 "实例独有" 语义	`user_id = 10001`（用户唯一 ID）`order_id = "ORD20251226"`（订单编号）`phone_number = "13800138000"`（手机号）`shipping_address = "北京市朝阳区"`（收货地址）`register_time = "2025-01-01"`（注册时间）`is_active = True`（是否激活）	`userID = 10001`（驼峰命名，不符合 PEP8）`uid = 10001`（无意义缩写，可读性差）`PhoneNumber = "138..."`（大驼峰，混淆类名）`1phone`（数字开头，语法错误）`user-id`（含连字符，语法错误）
私有实例变量	单下划线开头 + 蛇形命名（约定私有，外部不建议访问）	`_password = "e10adc3949ba59abbe56e057f20f883e"`（密码哈希）`_login_token = "token_123456"`（登录令牌）`_internal_state = "init"`（实例内部状态）`_email_verified = False`（邮箱是否验证）	`__password`（双下划线，慎用，触发名称改写）`_Password`（首字母大写，不规范）`_loginToken`（驼峰，不符合蛇形）`password`（无下划线，无法标识私有）
强私有实例变量	双下划线开头 + 蛇形命名（慎用，防止子类覆盖）	`__secret_key = "abc_xyz_123"`（加密密钥）`__transaction_id = "trans_20251226"`（交易流水号）`__core_config = {}`（核心配置，禁止子类修改）	`___secret_key`（多下划线，冗余混乱）`__SecretKey`（混合大小写，不规范）`__secret-key`（含连字符，语法错误）`__secretkey`（无下划线，可读性差）

完整代码示例（实例变量命名）

python

运行

复制代码

class User:
    # 类变量（常量）
    MIN_REGISTER_AGE = 18  # 最小注册年龄

    def __init__(self, user_id, username, phone):
        # 1. 普通实例变量（蛇形命名，实例独有）
        self.user_id = user_id  # 用户唯一标识
        self.username = username  # 用户名
        self.phone_number = phone  # 联系电话
        self.age = None  # 年龄
        self.register_time = None  # 注册时间
        self.is_active = True  # 账号是否激活
        self.user_avatar = None  # 用户头像地址
        self.receive_addresses = []  # 收货地址列表

        # 2. 私有实例变量（单下划线开头，类内操作）
        self._email = None  # 邮箱（外部不建议直接访问）
        self._login_count = 0  # 登录次数（内部统计）
        self._email_verified = False  # 邮箱验证状态（内部标识）
        self._last_login_time = None  # 最后登录时间

        # 3. 强私有实例变量（双下划线开头，防止子类覆盖）
        self.__password_hash = None  # 密码哈希值（核心隐私数据）
        self.__secret_token = None  # 用户专属秘钥（禁止子类修改）

    def set_email(self, email):
        # 类内操作私有实例变量
        self._email = email

    def update_password(self, new_password_hash):
        # 类内操作强私有实例变量
        self.__password_hash = new_password_hash

    def add_login_count(self):
        self._login_count += 1

四、避坑补充：易出错的命名场景示例

禁止类变量与实例变量同名：会导致实例访问时优先读取实例变量，逻辑混乱

python

运行

复制代码

# 错误示例
class BadExample:
    name = "默认名称"  # 类变量
    def __init__(self, name):
        self.name = name  # 实例变量与类变量同名，易混淆

# 正确示例
class GoodExample:
    default_name = "默认名称"  # 类变量（改名避免冲突）
    def __init__(self, name):
        self.name = name  # 实例变量

可变类型类变量命名：仍遵循类变量规则，语义体现 "集合 / 映射" 特性

python

运行

复制代码

class Cart:
    DEFAULT_ITEMS = ["环保购物袋"]  # 常量类变量（全大写）
    _hot_recommend_items = ["纸巾", "矿泉水"]  # 私有类变量（单下划线）
    total_cart_count = 0  # 普通类变量（蛇形命名）

总结

表格

变量类型	核心命名规则	经典示例汇总
类变量	普通：蛇形；常量：全大写；私有：单下划线	`total_users`、`MAX_RETRY`、`_internal_cache`
实例变量	普通：蛇形；私有：单下划线；强私有：双下划线	`phone_number`、`_password`、`__secret_key`

这些示例均符合 PEP 8 规范，既能清晰区分变量归属（类 / 实例），又能通过名称直观理解用途，可直接在实际项目中复用。