Python入门之各种变量定义格式

目录

  • 前言
  • 1. ‌成员变量(类变量/实例变量)‌
  • 2. ‌局部变量‌
  • 3. 临时变量示例
  • 4. ‌全局变量‌
  • 5. ‌常量(全局变量的一种特殊形式)‌
  • 6. ‌函数/方法参数‌
  • 总结


前言

本文简单介绍python语言中常见变量类型,介绍各种变量类型命名规则。可参考示例代码


在 Python 中,变量的命名格式不仅需要符合语法规则,还需遵循 ‌PEP 8‌ 编码规范(Python 官方推荐的代码风格指南)。以下是不同作用域变量的命名格式和注意事项:

1. ‌成员变量(类变量/实例变量)‌

命名规则:

  • 公共成员变量‌: 使用小写字母和下划线组合(lower_case_with_underscores)。
  • 保护成员变量‌: 以单下划线开头(_protected_var),约定俗成表示“仅限内部使用”,但 Python 并不强制限制访问。
  • 私有成员变量‌: 以双下划线开头(__private_var),会触发 Python 的名称修饰(Name Mangling),实际变量名会被改写为 _ClassName__var,以避免子类覆盖。
  • 类变量‌: 通常与实例变量命名规则一致,但可通过类名直接访问(如 ClassName.class_var)。
    示例:
class MyClass:
    class_var = "公共类变量"  # 公共类变量
    _protected_class_var = "受保护的类变量"  # 保护类变量
    __private_class_var = "私有类变量"  # 私有类变量(名称会被改写)

    def __init__(self):
        self.instance_var = "公共实例变量"  # 公共实例变量
        self._protected_instance_var = "受保护的实例变量"
        self.__private_instance_var = "私有实例变量"

2. ‌局部变量‌

命名规则:
使用小写字母和下划线组合(lower_case_with_underscores),简洁且明确。

示例:

def calculate_sum(items):
    total_sum = 0  # 局部变量(清晰表达用途)
    for item in items:
        total_sum += item.price
    return total_sum

3. 临时变量示例

for _ in range(3):
    print("Hello")  # _ 表示不关心循环变量值

4. ‌全局变量‌

命名规则:
全局变量应尽量少用(可能导致代码耦合),若必须使用,需明确标示。
命名建议全大写字母和下划线组合(UPPER_CASE_WITH_UNDERSCORES),以区分局部变量。
在函数内修改全局变量时,需用 global 关键字声明(否则会被视为局部变量)。
示例:

GLOBAL_CONSTANT = 100  # 全局常量(推荐全大写)
global_variable = "全局变量"  # 普通全局变量(尽量少用)

def modify_global():
    global global_variable  # 显式声明
    global_variable = "修改后的全局变量"

5. ‌常量(全局变量的一种特殊形式)‌

命名规则:
常量通常定义在模块顶层,命名全大写加下划线(MAX_SIZE, DEFAULT_TIMEOUT)。
虽然 Python 没有真正的常量,但通过命名约定表明“不应修改”。
示例:

PI = 3.1415926535  # 常量(约定不可修改)
MAX_CONNECTIONS = 10

6. ‌函数/方法参数‌

命名规则:
与局部变量一致(lower_case_with_underscores)。
类方法的第一个参数约定命名为 self,类方法的第一个参数为 cls。
避免使用保留关键字(如 list, str)作为参数名。
示例:

class MyClass:
    def __init__(self, initial_value):
        self.value = initial_value  # 参数命名清晰

    @classmethod
    def from_default(cls):
        return cls(0)  # cls 表示类自身

命名惯例的重要性:

  • 可读性‌:清晰的命名能直观体现变量用途(如 user_name vs. a)。
  • 避免冲突‌:通过前缀/后缀区分作用域(如 __private_var)。
  • 符合 ‌PEP 8‌ :统一风格便于团队协作和代码维护。
  • IDE 友好性‌:规范的命名能让代码分析工具(如 PyCharm)更好地识别变量类型。

总结表格如下:

变量类型 命名格式 示例
公共成员变量 lower_case_with_underscores self.user_name
保护成员变量 _single_leading_underscore self._internal_data
私有成员变量 __double_leading_underscores self.__secret_key
全局变量 UPPER_CASE_WITH_UNDERSCORES API_ENDPOINT
局部变量 lower_case_with_underscores total_count
临时变量 _single_leading_underscore _temp
函数参数 lower_case_with_underscores initial_value

总结

遵循这些命名规范能让你的代码更易读、易维护,同时减少潜在的错误。

你可能感兴趣的:(Python积累,python)