Python 命名规范
浅浅记录下,加深记忆!!!
一、PEP 8 命名建议(官方推荐)
PEP 8 – Style Guide for Python Code
| 类型 |
命名风格 |
示例 |
说明 |
| 模块(文件) |
小写 + 下划线 |
utils.py、data_processor.py |
避免使用大写或关键字 |
| 包(目录) |
小写 + 下划线 |
user_service/、payment_module/ |
不能以数字开头 |
| 类名 |
PascalCase(大驼峰) |
class UserService: |
首字母大写 |
| 函数名 |
snake_case(小写 + 下划线) |
def get_user_info(): |
不使用驼峰 |
| 变量名 |
snake_case |
user_name, total_count |
局部变量或全局变量 |
| 常量名 |
全大写 + 下划线 |
MAX_RETRY = 3, DEFAULT_TIMEOUT = 10 |
通常定义在模块顶层 |
| 私有变量/方法 |
单下划线前缀 |
_internal_data, _helper() |
表示“受保护” |
| 特殊方法 |
双下划线前后缀 |
__init__, __str__ |
用于魔法方法 |
二、pytest 命名规范
| 内容 |
说明 |
| ⚠️ 类名建议 |
必须以 Test 开头(如 TestCases) |
| 🧪 命名规则 |
测试函数/方法名必须以 test_ 开头 |
| 📁 文件名 |
推荐以 test_ 开头或 _test.py 结尾 |
评论区