Python 命名规范知识点汇总

在 Python 编程中，良好的命名规范不仅可以提高代码的可读性，还能帮助程序员更好地组织和管理代码。本文将对 Python 中的命名规范进行汇总和讲解，希望能为 Python 程序员提供一些指导。

变量命名

1. 命名应当富有意义，并能够清晰表达变量所代表的事物或值。变量名建议使用英文单词或缩写，不要使用中文拼音或不明确的缩写。
2. 变量名可以包含字母、数字和下划线（_），并以字母或下划线开头。例如，可以使用item_count，value_1。
3. 变量名应该全部小写，如果变量名由多个单词组成，可以使用下划线分隔这些单词。例如，可以使用customer_name，sales_total。
4. 避免使用 Python 关键字作为变量名。例如，不要使用 if，else，for 等。

示例：

# 正确的变量命名示例
customer_name = "John Doe"
sales_total = 10000
item_count = 5

# 不正确的变量命名示例
khmc = "John Doe" # 使用不明确的缩写
salesTotal = 10000 # 混用大小写
total_sales = 10000 # 单词的调序不正确

函数命名

1. 函数名应当清晰表达函数的作用和功能。函数名建议使用动词或动词短语，以便更清晰地表达其意义。
2. 函数名应该全部小写，如果函数名由多个单词组成，可以使用下划线分隔这些单词。例如，可以使用calculate_total。
3. 避免使用单个字母作为函数名。例如，不要使用 x，y 等。
4. Python 提供了内置函数（built-in function），这些函数已经有了预定义的名称，不建议使用这些名称作为自定义函数的名称。

示例：

# 正确的函数命名示例
def calculate_total(price, quantity):
    return price * quantity

# 不正确的函数命名示例
def func1(p, q): # 函数名不清晰
    return p * q

def list(list): # 使用内置函数名作为函数名
    return len(list)

类命名

1. 类名应当清晰表达类的作用和功能。类名建议使用名词或名词短语，以便更清晰地表达其意义。
2. 类名应该采用 PascalCase（单词首字母大写，其他字母小写，无下划线分隔符）命名规范。例如，可以使用Customer， SalesOrder。
3. 与变量和函数类似，应避免使用 Python 关键字作为类名。

示例：

# 正确的类命名示例
class Customer:
    def __init__(self, name, email):
        self.name = name
        self.email = email

# 不正确的类命名示例
class customer_list: # 不符合 PascalCase 命名规范
    def __init__(self, customers):
        self.customers = customers

class dict(dict): # 使用内置类名作为类名
    pass

模块命名

1. 模块名应当简短、简洁，并能够清晰表达模块的作用和功能。模块名建议使用英文单词或缩写，不要使用中文拼音或不明确的缩写。
2. 模块名应该全部小写，如果模块名由多个单词组成，可以使用下划线分隔这些单词。例如，可以使用 utils、file_io。
3. 模块名应该具有独一无二的特性，以避免与其他模块发生命名冲突。

示例：

# 正确的模块命名示例
import math_utils
from file_io import read_file

# 不正确的模块命名示例
import My_Utils_module # 不符合小写命名规则
import file # 名称不清晰

常量命名

1. 常量名建议使用全大写字母（UPPERCASE），如果常量名由多个单词组成，可以使用下划线分隔这些单词。例如，可以使用 PI、MAX_RETRY_ATTEMPTS。
2. 常量名应当包含有意义、具有描述性的名称。

示例：

# 正确的常量命名示例
MAX_RETRY_ATTEMPTS = 3
PI = 3.14

# 不正确的常量命名示例
max_retry_attempts = 3 # 不符合常量大写命名规则
pi = 3.14 # 常量名不清晰

结论

规范的命名规范有助于保持代码清晰、易于阅读和维护。遵守上述命名规范可以帮助 Python 程序员编写出更高质量的代码。