02Python命名规则

alex
13
2025-11-29

bizhihui_com_202503291743237135452625.jpg

一、包(Package)命名

  • 格式:全小写(lowercase),尽量简短。

  • 禁止使用下划线(除非必要,例如避免与关键字冲突)。

# ✅ 推荐
mypackage
utils
data_loader

# ❌ 不推荐
MyPackage
my_package   # 虽然常见,但 PEP 8 建议避免下划线(除非必要)

二、模块/文件(Module/File)命名

  • 格式:全小写,可使用下划线 _ 分隔单词。

  • 避免使用特殊字符或空格

  • 不要与标准库模块重名(如 json.py 会覆盖标准库 json

# ✅ 推荐
utils.py
file_handler.py
config_loader.py

# ❌ 不推荐
FileHandler.py
my-utils.py
configLoader.py

三、类(Class)命名

  • 格式大驼峰命名法(CapWords / PascalCase)

  • 首字母大写,每个单词首字母大写,无下划线。

# ✅ 推荐
class UserManager:
    pass

class HTTPClient:
    pass

# ❌ 不推荐
class user_manager:
    pass

class User_manager:
    pass

四、方法和函数(Method & Function)命名

# ✅ 推荐
def calculate_total():
    pass

def fetch_user_data():
    pass

# 在类中
class Calculator:
    def add_numbers(self, a, b):
        return a + b
  • 特别注意:私有方法/函数:以单下划线 _ 开头(表示“内部使用”,非强制私有)

def _internal_helper():
    pass

class MyClass:
    def _private_method(self):
        pass

五、变量(Variable)命名

普通变量

  • 格式snake_case(全小写 + 下划线)

常量(Constants)

  • 格式全大写 + 下划线分隔(UPPER_SNAKE_CASE)

私有变量(类属性)

  • 单下划线 _var:表示“内部使用”,不希望外部直接访问。

  • 双下划线 __var:触发名称修饰(name mangling),用于避免子类意外覆盖。

动物装饰