Python 变量命名规则

1. 定义

在Python语言中，变量、函数和类等都需要遵循一定的命名规则。以下是主要的命名约定：

变量命名：使用小写字母和下划线分割词，例如 my_variable。
函数或方法命名：同样使用小写字母和下划线分割词，例如 my_function()。
类命名：采用驼峰式命名法，例如 MyClass。
常量命名：使用全大写字母和下划线分割词，例如 MY_CONSTANTS。
私有变量和方法：以单下划线开头，例如 _my_private_variable。
双下划线前缀：用于私有权限，防止子类覆盖，例如 __my_private_method。

注意事项：

不能使用保留字（例如 if, for, while 等）。
第一个字符不能是数字。
变量名区分大小写，例如 Variable、variable 和 VARIABLE 是不同的变量名。
Python的文件名一般使用小写字母和下划线分割词，例如 my_python.py。

2. 代码案例

# 合法常量命名示例
MAX_ATTEMPTS = 5  # 常量使用全大写字母和下划线命名

class UserProfile:
    """用户个人资料类"""
    
    def __init__(self, username, email):
        """初始化用户个人资料"""
        self.username = username  # 公共实例变量，合法命名使用小写字母和下划线
        self.email = email  # 公共实例变量
        self._password = "default_password"  # 私有变量（非严格私有），以下划线开头
        self.__internal_id = 12345  # 严格私有变量，使用双下划线前缀

    def update_email(self, new_email):
        """更新用户的电子邮件地址"""
        self.email = new_email  # 合法函数命名示例

    def __private_method(self):
        """一个私有方法示例"""
        print("这是一个严格私有方法")  # 使用双下划线前缀来防止子类访问

    def public_method(self):
        """一个公共方法示例"""
        self.__private_method()  # 调用严格私有方法
        print(f"用户名: {self.username}, 电子邮件: {self.email}")  # 打印用户信息

def create_user_profile(username, email):
    """创建用户个人资料的工厂函数"""
    if not username or not email:
        raise ValueError("用户名和电子邮件地址不能为空")  # 异常处理，确保输入有效性
    
    return UserProfile(username, email)  # 创建并返回UserProfile实例

# 非法命名示例
def 2nd_method():  # 错误：函数名不能以数字开头
    pass

class myclass:  # 错误：类名应使用驼峰式命名法
    pass

def updateemail(new_email):  # 错误：函数命名应使用小写字母和下划线分隔词
    pass

# 主程序逻辑
if __name__ == "__main__":
    user_profile = create_user_profile("john_doe", "john@example.com")  # 创建UserProfile实例
    user_profile.public_method()  # 调用公共方法

    # 演示非法命名错误（请注意，这些行会导致运行时错误）
    # 2nd_method()  # 这行代码将引发语法错误
    # invalid_class_instance = myclass()  # 这行代码将引发错误，类名应使用驼峰式命名法
    # updateemail("new_email@example.com")  # 这行代码将不会触发命名错误，但函数命名不符合规范